Locator (Java 2 Platform SE 5.0)

SAX 파서는 이 인터페이스를 구현해, 컨텐츠 핸들러의 setDocumentLocator 메서드를 사용해 인스턴스를 건네주는 것으로 SAX 어플리케이션에 위치 정보를 제공합니다. SAX 어플리케이션은 이 객체를 사용해 XML 소스 문서내의 그 외의 SAX 이벤트의 위치를 밝혀낼 수가 있습니다.

객체에 의해 리턴된 결과는 각 콜백 메서드의 스코프내에서만 유효합니다. 이 스코프외, 또는 해석이 완료한 후에 locator를 사용하려고 하면, 어플리케이션에 예상외의 영향이 미칩니다.

SAX 파서에 locator를 제공시키는 것은 필수 조건이 아닙니다만, 그래 하는 것을 강하게 추천합니다. 이 경우 SAX 파서는 그 외의 문서 이벤트를 보고하기 전에 locator를 제공할 필요가 있습니다. 어플리케이션이 startDocument 이벤트를 받기 전에 locator를 설정해 두지 않으면 어플리케이션은 locator를 이용할 수 없다고 판단합니다.

도입된 버전 :: 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인 경우, 파서는 이것을 어플리케이션에 건네주기 전에 완전하게 해결할 필요가 있습니다. 예를 들어 파일명은 항상 file:... URL 로서 제공될 필요가 있어, 그 외의 종류의 상대 URL도 그 기저에 대해서 해결됩니다.

반환값:: 시스템 식별자를 포함한 캐릭터 라인. 사용할 수 없는 경우는 null
관련 항목:: getPublicId()

getLineNumber

int getLineNumber()

현재의 문서 이벤트가 종료하는 행 번호를 리턴합니다. 행은 줄 끝으로 단락지어져 줄 끝은 XML 사양에 정의됩니다.

경고: 메서드로부터의 반환값은 진단용의 근사값으로 의 보고 사용됩니다. 원의 XML 문서의 문자 컨텐츠를 편집하기 위한 상세 정보를 제공하는 것은 목적으로 하고 있지 않습니다. 이러한 「행」번호는 열로서 표시되는 것과 일치하는 일도 있으면, 내부 엔티티의 확장을 위해서 소스 텍스트와 일치하지 않는 것도 있습니다.

반환값은 문서 엔티티의 행 번호의 근사치인가 이벤트를 트리거 하는 마크 업을 포함한 외부의 구문 분석 대상 엔티티의 행 번호의 근사치입니다.

SAX 드라이버는 문서 이벤트에 관련된 텍스트의 직후에 있는 최초의 문자를 포함한 행의 위치를 돌려주려고 합니다. 1 행 째는 선두행입니다.

반환값:: 행 번호. 사용할 수 없는 경우는 -1
관련 항목:: getColumnNumber()

getColumnNumber

int getColumnNumber()

현재의 문서 이벤트가 종료하는 열번호를 리턴합니다. 이것은 마지막 행이 종료한 뒤의 Java char값의 1 으로부터 시작되는 번호입니다.

경고: 메서드로부터의 반환값은 진단용의 근사값으로 의 보고를 대상으로 여겨집니다. 원의 XML 문서의 문자 컨텐츠를 편집하기 위한 상세 정보를 제공하는 것은 목적으로 하고 있지 않습니다. 예를 들어 행에 결합 문자 순서,와이드 문자 배열, 사로 게이트 페어, 또는 쌍방향 텍스트가 포함되는 경우, 이 값은 텍스트 편집기의 화면의 열에 대응하지 않는 것이 있습니다.

반환값은 문서 엔티티의 열번호의 근사치인가 이벤트를 트리거 하는 마크 업을 포함한 외부의 구문 분석 대상 엔티티의 열번호의 근사치입니다.

SAX 드라이버는 문서 이벤트에 관련된 텍스트의 직후에 있는 최초의 문자를 포함한 행의 위치를 돌려주려고 합니다. 덧붙여 각 행의 최초의 열이 1번째가 됩니다.