Интерфейс EntityResolver

public interface EntityResolver

Базовый интерфейс для разрешения сущностей.

Этот модуль, как исходный код, так и документация, находится в общественном достоянии и не имеет ГАРАНТИЙ. См. http://www.saxproject.org для дополнительной информации.

Если приложению SAX необходимо реализовать настраиваемую обработку внешних сущностей, оно должно реализовать этот интерфейс и зарегистрировать экземпляр с драйвером SAX, используя метод setEntityResolver.

Затем XML-читатель позволит приложению перехватить любые внешние сущности (включая внешний подмножество DTD и внешние параметрические сущности, если они есть) перед их включением.

Многие приложения SAX не будут нуждаться в реализации этого интерфейса, но он будет особенно полезен для приложений, которые создают XML-документы из баз данных или других специализированных источников ввода, или для приложений, использующих типы URI, отличные от URL.

Следующий разрешитель предоставит приложению специальный поток символов для сущности с идентификатором системы "http://www.myhost.com/today":

import org.xml.sax.EntityResolver;
 import org.xml.sax.InputSource;

 public class MyResolver implements EntityResolver {
   public InputSource resolveEntity (String publicId, String systemId)
   {
     if (systemId.equals("http://www.myhost.com/today")) {
              // return a special input source
       MyReader reader = new MyReader();
       return new InputSource(reader);
     } else {
              // use the default behaviour
       return null;
     }
   }
 }

Приложение также может использовать этот интерфейс для перенаправления идентификаторов системы на локальные URI или для поиска заменителей в каталоге (возможно, с использованием публичного идентификатора).

Методы

resolveEntity

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

Разрешить приложению разрешить внешние сущности.

Парсер вызовет этот метод перед открытием любой внешней сущности, кроме основной сущности документа. Такие сущности включают внешнее подмножество DTD и внешние параметрические сущности, на которые ссылается DTD (в обоих случаях, только если парсер читает внешние параметрические сущности), и внешние общие сущности, на которые ссылается элемент документа (если парсер читает внешние общие сущности). Приложение может запросить, чтобы парсер нашёл сущность сам, использовал альтернативный URI или использовал данные, предоставленные приложением (в виде потока символов или байтов).

Авторы приложений могут использовать этот метод для перенаправления внешних идентификаторов системы на защищённые и/или локальные URI, для поиска публичных идентификаторов в каталоге или для чтения сущности из базы данных или другого источника ввода (включая, например, диалоговое окно). Ни XML, ни SAX не определяют предпочтительную политику использования публичных или системных идентификаторов для разрешения ресурсов. Однако SAX определяет, как интерпретировать любой объект InputSource, возвращаемый этим методом, и что, если он не возвращён, то системный идентификатор будет обращаться как URL.

Если идентификатор системы является URL, парсер SAX должен полностью разрешить его перед передачей приложению.

Параметры:

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

systemId - Идентификатор системы внешней сущности, на которую делается ссылка.

Возвращает:

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

Исключение:

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

IOException - Java-специфическое исключение IO, возможно, результат создания нового потока InputStream или Reader для InputSource.

См. также:

InputSource