SourceLocator (Java 2 Platform Ent. Ed. v1.4) - Java Platform, Enterprise Edition v1.4 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Ent. Ed. v1.4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.xml.transform
Interface SourceLocator

All Known Subinterfaces:: DOMLocator

public interface SourceLocator

This interface is primarily for the purposes of reporting where an error occurred in the XML source or transformation instructions.

Method Summary

int getColumnNumber()
          Return the character position where the current document event ends.

int getLineNumber()
          Return the line number where the current document event ends.

String getPublicId()
          Return the public identifier for the current document event.

String getSystemId()
          Return the system identifier for the current document event.

Method Detail

getPublicId

public String getPublicId()

Return the public identifier for the current document event.

The return value is the public identifier of the document entity or of the external parsed entity in which the markup that triggered the event appears.

Returns:: A string containing the public identifier, or null if none is available.
See Also:: getSystemId()

getSystemId

public String getSystemId()

Return the system identifier for the current document event.

The return value is the system identifier of the document entity or of the external parsed entity in which the markup that triggered the event appears.

If the system identifier is a URL, the parser must resolve it fully before passing it to the application.

Returns:: A string containing the system identifier, or null if none is available.
See Also:: getPublicId()

getLineNumber

public int getLineNumber()

Return the line number where the current document event ends.

Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.

The return value is an approximation of the line number in the document entity or external parsed entity where the markup that triggered the event appears.

Returns:: The line number, or -1 if none is available.
See Also:: getColumnNumber()

getColumnNumber

public int getColumnNumber()

Return the character position where the current document event ends.

The return value is an approximation of the column number in the document entity or external parsed entity where the markup that triggered the event appears.

Returns:: The column number, or -1 if none is available.
See Also:: getLineNumber()