org.xml.sax

Интерфейсный Локатор

Все Известные Подынтерфейсы:

Locator2

Все Известные Классы с реализацией:

Locator2Impl, LocatorImpl

public interface Locator

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

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

Если синтаксический анализатор SAX предоставляет информацию о расположении приложению SAX, это делает так, реализовывая этот интерфейс и затем передавая экземпляр к приложению, используя обработчик содержимого setDocumentLocator метод. Приложение может использовать объект получить расположение любого другого события SAX в исходном документе XML.

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

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

С тех пор:

SAX 1.0

См. Также:

ContentHandler.setDocumentLocator(org.xml.sax.Locator)

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
int	getColumnNumber() Возвратите номер столбца, где событие действующего документа заканчивается.
int	getLineNumber() Возвратите номер строки, где событие действующего документа заканчивается.
Строка	getPublicId() Возвратите общедоступный идентификатор для события действующего документа.
Строка	getSystemId() Возвратите системный идентификатор для события действующего документа.

Деталь метода

getPublicId

String getPublicId()

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

Возвращаемое значение является общедоступным идентификатором объекта документа или внешнего проанализированного объекта, в котором появляется разметка, инициировавшая событие.

Возвраты:

Строка, содержащая общедоступный идентификатор, или нуль, если ни один не доступен.

См. Также:

getSystemId()

getSystemId

String getSystemId()

Возвратите системный идентификатор для события действующего документа.

Возвращаемое значение является системным идентификатором объекта документа или внешнего проанализированного объекта, в котором появляется разметка, инициировавшая событие.

Если системным идентификатором является URL, синтаксический анализатор должен разрешить это полностью прежде, чем передать его к приложению. Например, имя файла должно всегда обеспечиваться как file:... URL, и другие виды относительного URI также разрешаются против их основ.

Возвраты:

Строка, содержащая системный идентификатор, или нуль, если ни один не доступен.

См. Также:

getPublicId()

getLineNumber

int getLineNumber()

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

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

Возвращаемое значение является приближением номера строки в объекте документа или внешнем проанализированном объекте, где разметка, инициировавшая событие, появляется.

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

Возвраты:

Номер строки, или-1, если ни один не доступен.

См. Также:

getColumnNumber()

getColumnNumber

int getColumnNumber()

Возвратите номер столбца, где событие действующего документа заканчивается. Это - число на основе одно Java char значения начиная с последнего конца строки.

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

Возвращаемое значение является приближением номера столбца в объекте документа или внешнем проанализированном объекте, где разметка, инициировавшая событие, появляется.

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

Возвраты:

Номер столбца, или-1, если ни один не доступен.

См. Также:

getLineNumber()