All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.xml.sax.helpers.LocatorImpl

java.lang.Object
   |
   +----org.xml.sax.helpers.LocatorImpl

public class LocatorImpl

extends Object

implements Locator

This class is available mainly for application writers, who can use it to make a persistent snapshot of a locator at any point during a document parse:

 Locator locator;
 Locator startloc;
 public void setLocator (Locator locator)
 {
         // note the locator
   this.locator = locator;
 }
 public void startDocument ()
 {
         // save the location of the start of the document
         // for future use.
   Locator startloc = new LocatorImpl(locator);
 }

Normally, parser writers will not use this class, since it is more efficient to provide location information only when requested, rather than constantly updating a Locator object.

See Also:

Locator

LocatorImpl()

Zero-argument constructor.

LocatorImpl(Locator)

Copy constructor.

getColumnNumber()

Return the saved column number (1-based).

getLineNumber()

Return the saved line number (1-based).

getPublicId()

Return the saved public identifier.

getSystemId()

Return the saved system identifier.

setColumnNumber(int)

Set the column number for this locator (1-based).

setLineNumber(int)

Set the line number for this locator (1-based).

setPublicId(String)

Set the public identifier for this locator.

setSystemId(String)

Set the system identifier for this locator.

 public LocatorImpl()

Zero-argument constructor.

This will not normally be useful, since the main purpose of this class is to make a snapshot of an existing Locator.

 public LocatorImpl(Locator locator)

Copy constructor.

Create a persistent copy of the current state of a locator. When the original locator changes, this copy will still keep the original values (and it can be used outside the scope of DocumentHandler methods).

Parameters:

locator - The locator to copy.

 public String getPublicId()

Return the saved public identifier.

Returns:

The public identifier as a string, or null if none is available.

See Also:

getPublicId, setPublicId

 public String getSystemId()

Return the saved system identifier.

Returns:

The system identifier as a string, or null if none is available.

See Also:

getSystemId, setSystemId

 public int getLineNumber()

Return the saved line number (1-based).

Returns:

The line number as an integer, or -1 if none is available.

See Also:

getLineNumber, setLineNumber

 public int getColumnNumber()

Return the saved column number (1-based).

Returns:

The column number as an integer, or -1 if none is available.

See Also:

getColumnNumber, setColumnNumber

 public void setPublicId(String publicId)

Set the public identifier for this locator.

Parameters:

publicId - The new public identifier, or null if none is available.

See Also:

getPublicId

 public void setSystemId(String systemId)

Set the system identifier for this locator.

Parameters:

systemId - The new system identifier, or null if none is available.

See Also:

getSystemId

 public void setLineNumber(int lineNumber)

Set the line number for this locator (1-based).

Parameters:

lineNumber - The line number, or -1 if none is available.

See Also:

getLineNumber

 public void setColumnNumber(int columnNumber)

Set the column number for this locator (1-based).

Parameters:

columnNumber - The column number, or -1 if none is available.

See Also:

getColumnNumber

All Packages  Class Hierarchy  This Package  Previous  Next  Index