Интерфейс Locator

Все известные подинтерфейсы:: Locator2

Все известные реализующие классы:: Locator2Impl, LocatorImpl

public interface Locator

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

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

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

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

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

С:: 1.4, SAX 1.0
См. также:: ContentHandler.setDocumentLocator(org.xml.sax.Locator)

Методы

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

Методы

getPublicId

String getPublicId()

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

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

Возвращает:: Строка, содержащая общедоступный идентификатор, или null, если он недоступен.
См. также:: getSystemId()

getSystemId

String getSystemId()

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

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

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

Возвращает:: Строка, содержащая системный идентификатор, или null, если он недоступен.
См. также:: getPublicId()

getLineNumber

int getLineNumber()

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

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

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

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

Возвращает:: Номер строки или -1, если он недоступен.
См. также:: getColumnNumber()

getColumnNumber

int getColumnNumber()

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

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

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

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

Возвращает:: Номер столбца или -1, если он недоступен.
См. также:: getLineNumber()