FileDocCategorySizeDatePackage
LocatorImpl.javaAPI DocJava SE 6 API5397Tue Jun 10 00:27:36 BST 2008org.xml.sax.helpers

LocatorImpl

public class LocatorImpl extends Object implements Locator
Provide an optional convenience implementation of Locator.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

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.

since
SAX 1.0
author
David Megginson
version
2.0.1 (sax2r2)
see
org.xml.sax.Locator Locator

Fields Summary
private String
publicId
private String
systemId
private int
lineNumber
private int
columnNumber
Constructors 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.

    
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).

param
locator The locator to copy.

	setPublicId(locator.getPublicId());
	setSystemId(locator.getSystemId());
	setLineNumber(locator.getLineNumber());
	setColumnNumber(locator.getColumnNumber());
    
Methods Summary
public intgetColumnNumber()
Return the saved column number (1-based).

return
The column number as an integer, or -1 if none is available.
see
org.xml.sax.Locator#getColumnNumber
see
#setColumnNumber

	return columnNumber;
    
public intgetLineNumber()
Return the saved line number (1-based).

return
The line number as an integer, or -1 if none is available.
see
org.xml.sax.Locator#getLineNumber
see
#setLineNumber

	return lineNumber;
    
public java.lang.StringgetPublicId()
Return the saved public identifier.

return
The public identifier as a string, or null if none is available.
see
org.xml.sax.Locator#getPublicId
see
#setPublicId

	return publicId;
    
public java.lang.StringgetSystemId()
Return the saved system identifier.

return
The system identifier as a string, or null if none is available.
see
org.xml.sax.Locator#getSystemId
see
#setSystemId

	return systemId;
    
public voidsetColumnNumber(int columnNumber)
Set the column number for this locator (1-based).

param
columnNumber The column number, or -1 if none is available.
see
#getColumnNumber

	this.columnNumber = columnNumber;
    
public voidsetLineNumber(int lineNumber)
Set the line number for this locator (1-based).

param
lineNumber The line number, or -1 if none is available.
see
#getLineNumber

	this.lineNumber = lineNumber;
    
public voidsetPublicId(java.lang.String publicId)
Set the public identifier for this locator.

param
publicId The new public identifier, or null if none is available.
see
#getPublicId

	this.publicId = publicId;
    
public voidsetSystemId(java.lang.String systemId)
Set the system identifier for this locator.

param
systemId The new system identifier, or null if none is available.
see
#getSystemId

	this.systemId = systemId;