Google

Xerces 3.1.1 API: Class LocatorImpl
Overview  Package   Class  Tree  Deprecated  Index  Help 
Xerces 3.1.1
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD


Class LocatorImpl

java.lang.Object
  |

Provide an optional convenience implementation of Locator.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

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
Version:
2.0


          Zero-argument constructor.
          Copy constructor.
Constructor Summary
 
          Return the saved column number (1-based).
          Return the saved line number (1-based).
          Return the saved public identifier.
          Return the saved system identifier.
          Set the column number for this locator (1-based).
          Set the line number for this locator (1-based).
          Set the public identifier for this locator.
          Set the system identifier for this locator.
Method Summary
 int
 int
 java.lang.String
 java.lang.String
 void
 void
 void
 void
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LocatorImpl

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.

LocatorImpl 


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 Detail







getPublicId


public java.lang.String getPublicId()




Return the saved public identifier.






Returns:
The public identifier as a string, or null if none









getSystemId


public java.lang.String getSystemId()




Return the saved system identifier.






Returns:
The system identifier as a string, or null if none









getLineNumber


public int getLineNumber()




Return the saved line number (1-based).














getColumnNumber


public int getColumnNumber()




Return the saved column number (1-based).














setPublicId


public void setPublicId(java.lang.String publicId)




Set the public identifier for this locator.








Parameters:
publicId - The new public identifier, or null 









setSystemId


public void setSystemId(java.lang.String systemId)




Set the system identifier for this locator.








Parameters:
systemId - The new system identifier, or null 









setLineNumber


public void setLineNumber(int lineNumber)




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
















setColumnNumber


public void setColumnNumber(int columnNumber)




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

























  

      Overview 
      Package 
    Class 
      Tree 
      Deprecated 
      Index 
      Help 
  





Xerces 3.1.1








  FRAMES   
 NO FRAMES





  SUMMARY:  INNER | FIELD | CONSTR | METHOD

DETAIL:  FIELD | CONSTR | METHOD