Интерфейс DocumentHandler

void setDocumentLocator(Locator locator)

Получение объекта для определения источника событий SAX-документа.

SAX-парсерам настоятельно рекомендуется (хотя и не является обязательным) предоставлять локатор: если это сделано, он должен быть передан приложению с помощью этого метода перед вызовом любого другого метода интерфейса DocumentHandler.

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

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

void startDocument() throws SAXException

Получение уведомления о начале документа.

SAX-парсер вызовет этот метод только один раз, перед любыми другими методами в этом интерфейсе или в DTDHandler (кроме setDocumentLocator).

void endDocument() throws SAXException

Получение уведомления об окончании документа.

SAX-парсер вызовет этот метод только один раз, и это будет последний метод, вызванный во время разбора. Парсер не вызовет этот метод до тех пор, пока не прекратит разбор (из-за невосстановимой ошибки) или не достигнет конца входных данных.

void startElement(String name, AttributeList atts) throws SAXException

Получение уведомления о начале элемента.

Парсер вызовет этот метод в начале каждого элемента в XML-документе; будет соответствующее событие endElement() для каждого события startElement() (даже когда элемент пуст). Все содержимое элемента будет сообщено в порядке, прежде чем произойдёт соответствующее событие endElement().

Если имя элемента имеет префикс имени пространства имён, префикс всё ещё будет добавлен. Обратите внимание, что предоставленный список атрибутов будет содержать только атрибуты со явными значениями (указанными или по умолчанию): атрибуты #IMPLIED будут опущены.

void endElement(String name) throws SAXException

Получение уведомления об окончании элемента.

SAX-парсер вызовет этот метод в конце каждого элемента в XML-документе; будет соответствующее событие startElement() для каждого события endElement() (даже когда элемент пуст).

Если имя элемента имеет префикс имени пространства имён, префикс всё ещё будет прикреплён к имени.

void characters(char[] ch, int start, int length) throws SAXException

Получение уведомления о данных символов.

Парсер вызовет этот метод для отчёта о каждом фрагменте данных символов. SAX-парсеры могут возвращать все смежные данные символов в одном фрагменте или могут разделить их на несколько фрагментов; однако все символы в любом отдельном событии должны происходить из одного внешнего объекта, чтобы локатор предоставлял полезную информацию.

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

Обратите внимание, что некоторые парсеры будут сообщать о пробелах с помощью метода ignorableWhitespace(), а не с этим методом (валидирующие парсеры должны это делать).

void ignorableWhitespace(char[] ch, int start, int length) throws SAXException

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

Валидирующие парсеры должны использовать этот метод для отчёта о каждом фрагменте пробелов, которые можно игнорировать (см. рекомендацию W3C XML 1.0, раздел 2.10): невалидирующие парсеры также могут использовать этот метод, если они способны анализировать и использовать модели содержимого.

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

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

void processingInstruction(String target, String data) throws SAXException

Получение уведомления об обработке инструкции.

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

SAX-парсер никогда не должен сообщать об XML-декларации (XML 1.0, раздел 2.8) или декларации текста (XML 1.0, раздел 4.3.1) с помощью этого метода.