Интерфейс XMLReader

boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException

Получение значения флага функции.

Имя функции — любой полностью квалифицированный URI. Возможно, что XMLReader распознаёт имя функции, но временно не может вернуть его значение. Некоторые значения функций могут быть доступны только в определённых контекстах, например, до, во время или после разбора. Также некоторые значения функций могут быть недоступны программно. (В случае адаптера для SAX1 Parser, нет независимого от реализации способа отобразить, выполняет ли базовый анализатор валидацию, расширяет ли внешние сущности и т.д.)

Все XMLReaders обязаны распознавать имена функций http://xml.org/sax/features/namespaces и http://xml.org/sax/features/namespace-prefixes.

Типичное использование выглядит так:

 XMLReader r = new MySAXDriver();

                         // try to activate validation
 try {
   r.setFeature("http://xml.org/sax/features/validation", true);
 } catch (SAXException e) {
   System.err.println("Cannot activate validation.");
 }

                         // register event handlers
 r.setContentHandler(new MyContentHandler());
 r.setErrorHandler(new MyErrorHandler());

                         // parse the first document
 try {
   r.parse("http://www.foo.com/mydoc.xml");
 } catch (IOException e) {
   System.err.println("I/O exception reading XML document");
 } catch (SAXException e) {
   System.err.println("XML exception reading document.");
 }
 

Реализаторы свободны (и им рекомендуется) придумывать свои собственные функции, используя имена, построенные на своих собственных URI.

void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException

Установка значения флага функции.

Имя функции — любой полностью квалифицированный URI. Возможно, что XMLReader может отобразить значение функции, но не может изменить текущее значение. Некоторые значения функций могут быть неизменяемыми или изменяемыми только в определённых контекстах, например, до, во время или после разбора.

Все XMLReaders обязаны поддерживать установку http://xml.org/sax/features/namespaces в true и http://xml.org/sax/features/namespace-prefixes в false.

Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException

Получение значения свойства.

Имя свойства — любой полностью квалифицированный URI. Возможно, что XMLReader распознаёт имя свойства, но временно не может вернуть его значение. Некоторые значения свойств могут быть доступны только в определённых контекстах, например, до, во время или после разбора.

XMLReaders не обязаны распознавать какие-либо конкретные имена свойств, хотя начальный набор основных свойств документирован для SAX2.

Реализаторы свободны (и им рекомендуется) придумывать свои собственные свойства, используя имена, построенные на своих собственных URI.

void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException

Установка значения свойства.

Имя свойства — любой полностью квалифицированный URI. Возможно, что XMLReader распознаёт имя свойства, но не может изменить текущее значение. Некоторые значения свойств могут быть неизменяемыми или изменяемыми только в определённых контекстах, например, до, во время или после разбора.

XMLReaders не обязаны распознавать установку каких-либо конкретных имён свойств, хотя набор основных свойств определён SAX2.

Этот метод также является стандартным механизмом для установки расширенных обработчиков.

void setEntityResolver(EntityResolver resolver)

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

Если приложение не регистрирует обработчик сущностей, XMLReader выполнит собственное значение по умолчанию.

Приложения могут зарегистрировать новый или другой обработчик посреди разбора, и SAX-анализатор должен немедленно начать использовать новый обработчик.

EntityResolver getEntityResolver()

Возвращает текущий обработчик сущностей.

void setDTDHandler(DTDHandler handler)

Разрешение приложению зарегистрировать обработчик событий DTD.

Если приложение не регистрирует обработчик DTD, все события DTD, сообщаемые SAX-анализатором, будут игнорироваться.

Приложения могут зарегистрировать новый или другой обработчик посреди разбора, и SAX-анализатор должен немедленно начать использовать новый обработчик.

DTDHandler getDTDHandler()

Возвращает текущий обработчик DTD.

void setContentHandler(ContentHandler handler)

Разрешение приложению зарегистрировать обработчик событий содержимого.

Если приложение не регистрирует обработчик содержимого, все события содержимого, сообщаемые SAX-анализатором, будут игнорироваться.

Приложения могут зарегистрировать новый или другой обработчик посреди разбора, и SAX-анализатор должен немедленно начать использовать новый обработчик.

ContentHandler getContentHandler()

Возвращает текущий обработчик содержимого.

void setErrorHandler(ErrorHandler handler)

Разрешение приложению зарегистрировать обработчик событий ошибок.

Если приложение не регистрирует обработчик ошибок, все события ошибок, сообщаемые SAX-анализатором, будут игнорироваться; однако, обычная обработка может не продолжаться. Настоятельно рекомендуется, чтобы все приложения SAX реализовывали обработчик ошибок, чтобы избежать неожиданных ошибок.

Приложения могут зарегистрировать новый или другой обработчик посреди разбора, и SAX-анализатор должен немедленно начать использовать новый обработчик.

ErrorHandler getErrorHandler()

Возвращает текущий обработчик ошибок.

void parse(InputSource input) throws IOException, SAXException

Обработать XML-документ.

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

Приложения не должны вызывать этот метод, пока происходит обработка (они должны создать новый XMLReader вместо этого для каждого вложенного XML-документа). После завершения обработки приложение может повторно использовать тот же объект XMLReader, возможно, с другим источником входных данных. Конфигурация объекта XMLReader (например, привязки обработчиков и значения, установленные для флагов функций и свойств), не изменяется завершением обработки, если только определение этой части конфигурации явно не указывает другое поведение. (Например, флаги функций или свойства, раскрывающие характеристики обрабатываемого документа).

Во время обработки XMLReader предоставляет информацию о XML-документе через зарегистрированные обработчики событий.

Этот метод является синхронным: он не вернётся, пока обработка не закончится. Если клиентское приложение хочет прервать обработку досрочно, оно должно сгенерировать исключение.

void parse(String systemId) throws IOException, SAXException

Обработать XML-документ по идентификатору системы (URI).

Этот метод — сокращение для общего случая чтения документа по идентификатору системы. Он точно эквивалентен следующему:

 parse(new InputSource(systemId));
 

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