Home » xml-commons-external-1.4.01-src » org.xml » sax » helpers » [javadoc | source]
org.xml.sax.helpers
public class: LocatorImpl [javadoc | source]
java.lang.Object
   org.xml.sax.helpers.LocatorImpl

All Implemented Interfaces:
    Locator

Direct Known Subclasses:
    Locator2Impl

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.

Constructor:
 public LocatorImpl() 
 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.
Method from org.xml.sax.helpers.LocatorImpl Summary:
getColumnNumber,   getLineNumber,   getPublicId,   getSystemId,   setColumnNumber,   setLineNumber,   setPublicId,   setSystemId
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.xml.sax.helpers.LocatorImpl Detail:
 public int getColumnNumber() 
    Return the saved column number (1-based).
 public int getLineNumber() 
    Return the saved line number (1-based).
 public String getPublicId() 
    Return the saved public identifier.
 public String getSystemId() 
    Return the saved system identifier.
 public  void setColumnNumber(int columnNumber) 
    Set the column number for this locator (1-based).
 public  void setLineNumber(int lineNumber) 
    Set the line number for this locator (1-based).
 public  void setPublicId(String publicId) 
    Set the public identifier for this locator.
 public  void setSystemId(String systemId) 
    Set the system identifier for this locator.