APIdia Launch Partner
Top Description Fields Constructors Methods
org.xml.sax.helpers

public Class LocatorImpl

extends Object
implements Locator
Class Inheritance
All Implemented Interfaces
org.xml.sax.Locator
Known Direct Subclasses
com.sun.org.apache.xml.internal.utils.SAXSourceLocator, org.xml.sax.ext.Locator2Impl
Imports
org.xml.sax.Locator

Provide an optional convenience implementation of 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.

Author
David Megginson
Since
1.4, SAX 1.0
See Also
Locator

Field Summary

Modifier and TypeField and Description
private int
private int
private String
private String

Constructor Summary

AccessConstructor and Description
public
LocatorImpl()

Zero-argument constructor.

public
LocatorImpl(Locator
The locator to copy.
locator
)

Copy constructor.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

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

Implements org.xml.sax.Locator.getColumnNumber.

Return the saved column number (1-based).

public int

Returns:

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

Implements org.xml.sax.Locator.getLineNumber.

Return the saved line number (1-based).

public String

Returns:

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

Implements org.xml.sax.Locator.getPublicId.

Return the saved public identifier.

public String

Returns:

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

Implements org.xml.sax.Locator.getSystemId.

Return the saved system identifier.

public void
setColumnNumber(int
The column number, or -1 if none is available.
columnNumber
)

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

public void
setLineNumber(int
The line number, or -1 if none is available.
lineNumber
)

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

public void
setPublicId(String
The new public identifier, or null if none is available.
publicId
)

Set the public identifier for this locator.

public void
setSystemId(String
The new system identifier, or null if none is available.
systemId
)

Set the system identifier for this locator.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

columnNumberback to summary
private int columnNumber
lineNumberback to summary
private int lineNumber
publicIdback to summary
private String publicId
systemIdback to summary
private String systemId

Constructor Detail

LocatorImplback to summary
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.

LocatorImplback to summary
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:Locator

The locator to copy.

Method Detail

getColumnNumberback to summary
public int getColumnNumber()

Implements org.xml.sax.Locator.getColumnNumber.

Return the saved column number (1-based).

Returns:int

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

See Also
org.xml.sax.Locator#getColumnNumber, setColumnNumber
getLineNumberback to summary
public int getLineNumber()

Implements org.xml.sax.Locator.getLineNumber.

Return the saved line number (1-based).

Returns:int

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

See Also
org.xml.sax.Locator#getLineNumber, setLineNumber
getPublicIdback to summary
public String getPublicId()

Implements org.xml.sax.Locator.getPublicId.

Return the saved public identifier.

Returns:String

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

See Also
org.xml.sax.Locator#getPublicId, setPublicId
getSystemIdback to summary
public String getSystemId()

Implements org.xml.sax.Locator.getSystemId.

Return the saved system identifier.

Returns:String

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

See Also
org.xml.sax.Locator#getSystemId, setSystemId
setColumnNumberback to summary
public void setColumnNumber(int columnNumber)

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

Parameters
columnNumber:int

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

See Also
getColumnNumber
setLineNumberback to summary
public void setLineNumber(int lineNumber)

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

Parameters
lineNumber:int

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

See Also
getLineNumber
setPublicIdback to summary
public void setPublicId(String publicId)

Set the public identifier for this locator.

Parameters
publicId:String

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

See Also
getPublicId
setSystemIdback to summary
public void setSystemId(String systemId)

Set the system identifier for this locator.

Parameters
systemId:String

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

See Also
getSystemId