Интерфейс EntityResolver2

Расширенный интерфейс для сопоставления внешних ссылок сущностей с источниками ввода или для предоставления отсутствующего внешнего подмножества. Метод XMLReader.setEntityResolver() используется для предоставления реализаций этого интерфейса парсерам. Когда парсер использует методы в этом интерфейсе, метод EntityResolver2.resolveEntity() (в этом интерфейсе) используется вместо более старого (SAX 1.0) метода EntityResolver.resolveEntity().

Этот модуль, как исходный код, так и документация, находится в общественном достоянии и не имеет ГАРАНТИЙ.

Если приложению SAX требуется настройка обработки внешних сущностей, определенная в этом интерфейсе, оно должно убедиться, что оно использует XMLReader с флагом http://xml.org/sax/features/use-entity-resolver2, установленным в значение true (что является его значением по умолчанию, когда функция распознаётся). Если этот флаг не распознан, или его значение ложно, или разрешитель не реализует этот интерфейс, тогда используется только метод EntityResolver.

Это поддерживает три категории приложений, которые изменяют разрешение сущностей. Приложения Старого стиля не будут знать об этом интерфейсе; они будут предоставлять EntityResolver. Приложения Переходного режима предоставляют EntityResolver2 и автоматически получают преимущества от его методов в любых системах (парсерах или других инструментах), поддерживающих его, благодаря полиморфизму. Приложения как Старого стиля, так и Переходного режима будут работать с любым SAX2-парсером. Приложения Нового стиля не смогут работать, кроме как с SAX2-парсерами, которые поддерживают эту конкретную функцию. Они будут настаивать на том, чтобы значение флага функции было "true", и реализация EntityResolver2, которую они предоставят, может выбросить исключение, если вызывается исходный метод разрешения сущностей в стиле SAX 1.0.

Методы

getExternalSubset

InputSource getExternalSubset(String name,
                              String baseURI)
                       throws SAXException,
                              IOException

... comments and PIs from the prolog (as usual)
 startDTD ("rootName", source.getPublicId (), source.getSystemId ());
 startEntity ("[dtd]");
 ... declarations, comments, and PIs from the external subset
 endEntity ("[dtd]");
 endDTD ();
 ... then the rest of the document (as usual)
 startElement (..., "rootName", ...);

Параметры:

name - Идентифицирует корневой элемент документа. Это имя взято из объявления DOCTYPE (если оно доступно) или из фактического корневого элемента.

baseURI - Базовый URI документа, служащий дополнительным подсказкой для выбора внешнего подмножества. Это всегда абсолютный URI, если он не равен null, потому что XMLReader получил InputSource без него.

Возвращает:

Объект InputSource, описывающий новое внешнее подмножество, которое будет использоваться парсером, или null для указания того, что внешнее подмножество не предоставляется.

Исключения:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

IOException - Вероятно, указывает на неудачу при создании нового потока ввода или читателя или некорректный URL.

resolveEntity

InputSource resolveEntity(String name,
                          String publicId,
                          String baseURI,
                          String systemId)
                   throws SAXException,
                          IOException

Параметры:

name - Идентифицирует внешнюю сущность, подлежащую разрешению. Либо "[dtd]" для внешнего подмножества, либо имя, начинающееся с "%" для указания параметрической сущности, или же имя общей сущности. Это никогда не равно null, когда вызывается SAX2-парсером.

publicId - Публичный идентификатор внешней сущности, на которую делается ссылка (нормализованный в соответствии с требованиями спецификации XML), или null, если таковой не был предоставлен.

baseURI - URI относительно которого интерпретируются относительные systemID. Это всегда абсолютный URI, если он не равен null (вероятно, потому что XMLReader получил InputSource без него). Этот URI определён спецификацией XML как URI, связанный с "<", начинающим соответствующее объявление.

systemId - Системный идентификатор внешней сущности, на которую делается ссылка; относительный или абсолютный URI. Это никогда не равно null, когда вызывается SAX2-парсером; только объявленные сущности и любое внешнее подмножество разрешаются такими парсерами.

Возвращает:

Объект InputSource, описывающий новый источник ввода, который будет использоваться парсером. Возврат null направляет парсер к разрешению системного идентификатора относительно базового URI и открытию соединения с результирующим URI.

Исключения:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

IOException - Вероятно, указывает на неудачу при создании нового потока ввода или читателя или некорректный URL.