| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
|
| <!--NewPage-->
|
| <HTML>
|
| <HEAD>
|
| <!-- Generated by javadoc on Thu Nov 22 17:13:00 EST 2007 -->
|
| <TITLE>
|
| Xalan-Java 2.7.1: Interface Locator
|
| </TITLE>
|
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
|
| </HEAD>
|
| <BODY BGCOLOR="white">
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <TR ALIGN="center" VALIGN="top">
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Locator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
| </TR>
|
| </TABLE>
|
| </TD>
|
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
| </EM>
|
| </TD>
|
| </TR>
|
|
|
| <TR>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../org/xml/sax/ErrorHandler.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../org/xml/sax/Parser.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="Locator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| <!-- ======== START OF CLASS DATA ======== -->
|
| <H2>
|
| <FONT SIZE="-1">
|
| org.xml.sax</FONT>
|
| <BR>
|
| Interface Locator</H2>
|
| <DL>
|
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../org/xml/sax/ext/Locator2.html">Locator2</A></DD>
|
| </DL>
|
| <DL>
|
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/apache/xalan/xsltc/trax/DOM2SAX.html">DOM2SAX</A>, <A HREF="../../../org/apache/xalan/xsltc/trax/DOM2TO.html">DOM2TO</A>, <A HREF="../../../org/xml/sax/helpers/LocatorImpl.html">LocatorImpl</A>, <A HREF="../../../org/apache/xml/utils/SerializableLocatorImpl.html">SerializableLocatorImpl</A></DD>
|
| </DL>
|
| <HR>
|
| <DL>
|
| <DT>public interface <B>Locator</B></DL>
|
|
|
| <P>
|
| Interface for associating a SAX event with a document location. |
| |
| <blockquote> |
| <em>This module, both source code and documentation, is in the |
| Public Domain, and comes with <strong>NO WARRANTY</strong>.</em> |
| See <a href='http://www.saxproject.org'>http://www.saxproject.org</a> |
| for further information. |
| </blockquote> |
| |
| <p>If a SAX parser provides location information to the SAX |
| application, it does so by implementing this interface and then |
| passing an instance to the application using the content |
| handler's <A HREF="../../../org/xml/sax/ContentHandler.html#setDocumentLocator(org.xml.sax.Locator)">setDocumentLocator</A> method. The application can use the |
| object to obtain the location of any other SAX event |
| in the XML source document.</p> |
| |
| <p>Note that the results returned by the object will be valid only |
| during the scope of each callback method: the application |
| will receive unpredictable results if it attempts to use the |
| locator at any other time, or after parsing completes.</p> |
| |
| <p>SAX parsers are not required to supply a locator, but they are |
| very strongly encouraged to do so. If the parser supplies a |
| locator, it must do so before reporting any other document events. |
| If no locator has been set by the time the application receives |
| the <A HREF="../../../org/xml/sax/ContentHandler.html#startDocument()">startDocument</A> |
| event, the application should assume that a locator is not |
| available.</p>
|
| <P>
|
| <DL>
|
| <DT><B>Since: </B><DD>SAX 1.0</DD>
|
| <DT><B>See Also: </B><DD><A HREF="../../../org/xml/sax/ContentHandler.html#setDocumentLocator(org.xml.sax.Locator)"><CODE>ContentHandler.setDocumentLocator(org.xml.sax.Locator)</CODE></A></DL>
|
| <HR>
|
|
|
| <P>
|
| <!-- ======== INNER CLASS SUMMARY ======== -->
|
|
|
|
|
| <!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
| <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
|
| <!-- ========== METHOD SUMMARY =========== -->
|
|
|
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Method Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/xml/sax/Locator.html#getColumnNumber()">getColumnNumber</A></B>()</CODE>
|
|
|
| <BR>
|
| Return the column number where the current document event ends.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/xml/sax/Locator.html#getLineNumber()">getLineNumber</A></B>()</CODE>
|
|
|
| <BR>
|
| Return the line number where the current document event ends.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> java.lang.String</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/xml/sax/Locator.html#getPublicId()">getPublicId</A></B>()</CODE>
|
|
|
| <BR>
|
| Return the public identifier for the current document event.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> java.lang.String</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/xml/sax/Locator.html#getSystemId()">getSystemId</A></B>()</CODE>
|
|
|
| <BR>
|
| Return the system identifier for the current document event.</TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <P>
|
|
|
| <!-- ============ FIELD DETAIL =========== -->
|
|
|
|
|
| <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
|
| <!-- ============ METHOD DETAIL ========== -->
|
|
|
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Method Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="getPublicId()"><!-- --></A><H3>
|
| getPublicId</H3>
|
| <PRE>
|
| public java.lang.String <B>getPublicId</B>()</PRE>
|
| <DL>
|
| <DD>Return the public identifier for the current document event. |
| |
| <p>The return value is the public identifier of the document |
| entity or of the external parsed entity in which the markup |
| triggering the event appears.</p><DD><DL>
|
| <DT><B>Returns:</B><DD>A string containing the public identifier, or |
| null if none is available.<DT><B>See Also: </B><DD><A HREF="../../../org/xml/sax/Locator.html#getSystemId()"><CODE>getSystemId()</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getSystemId()"><!-- --></A><H3>
|
| getSystemId</H3>
|
| <PRE>
|
| public java.lang.String <B>getSystemId</B>()</PRE>
|
| <DL>
|
| <DD>Return the system identifier for the current document event. |
| |
| <p>The return value is the system identifier of the document |
| entity or of the external parsed entity in which the markup |
| triggering the event appears.</p> |
| |
| <p>If the system identifier is a URL, the parser must resolve it |
| fully before passing it to the application. For example, a file |
| name must always be provided as a <em>file:...</em> URL, and other |
| kinds of relative URI are also resolved against their bases.</p><DD><DL>
|
| <DT><B>Returns:</B><DD>A string containing the system identifier, or null |
| if none is available.<DT><B>See Also: </B><DD><A HREF="../../../org/xml/sax/Locator.html#getPublicId()"><CODE>getPublicId()</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getLineNumber()"><!-- --></A><H3>
|
| getLineNumber</H3>
|
| <PRE>
|
| public int <B>getLineNumber</B>()</PRE>
|
| <DL>
|
| <DD>Return the line number where the current document event ends. |
| Lines are delimited by line ends, which are defined in |
| the XML specification. |
| |
| <p><strong>Warning:</strong> The return value from the method |
| is intended only as an approximation for the sake of diagnostics; |
| it is not intended to provide sufficient information |
| to edit the character content of the original XML document. |
| In some cases, these "line" numbers match what would be displayed |
| as columns, and in others they may not match the source text |
| due to internal entity expansion. </p> |
| |
| <p>The return value is an approximation of the line number |
| in the document entity or external parsed entity where the |
| markup triggering the event appears.</p> |
| |
| <p>If possible, the SAX driver should provide the line position |
| of the first character after the text associated with the document |
| event. The first line is line 1.</p><DD><DL>
|
| <DT><B>Returns:</B><DD>The line number, or -1 if none is available.<DT><B>See Also: </B><DD><A HREF="../../../org/xml/sax/Locator.html#getColumnNumber()"><CODE>getColumnNumber()</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getColumnNumber()"><!-- --></A><H3>
|
| getColumnNumber</H3>
|
| <PRE>
|
| public int <B>getColumnNumber</B>()</PRE>
|
| <DL>
|
| <DD>Return the column number where the current document event ends. |
| This is one-based number of Java <code>char</code> values since |
| the last line end. |
| |
| <p><strong>Warning:</strong> The return value from the method |
| is intended only as an approximation for the sake of diagnostics; |
| it is not intended to provide sufficient information |
| to edit the character content of the original XML document. |
| For example, when lines contain combining character sequences, wide |
| characters, surrogate pairs, or bi-directional text, the value may |
| not correspond to the column in a text editor's display. </p> |
| |
| <p>The return value is an approximation of the column number |
| in the document entity or external parsed entity where the |
| markup triggering the event appears.</p> |
| |
| <p>If possible, the SAX driver should provide the line position |
| of the first character after the text associated with the document |
| event. The first column in each line is column 1.</p><DD><DL>
|
| <DT><B>Returns:</B><DD>The column number, or -1 if none is available.<DT><B>See Also: </B><DD><A HREF="../../../org/xml/sax/Locator.html#getLineNumber()"><CODE>getLineNumber()</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <!-- ========= END OF CLASS DATA ========= -->
|
| <HR>
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <TR ALIGN="center" VALIGN="top">
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Locator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
| </TR>
|
| </TABLE>
|
| </TD>
|
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
| </EM>
|
| </TD>
|
| </TR>
|
|
|
| <TR>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../org/xml/sax/ErrorHandler.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../org/xml/sax/Parser.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="Locator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| Copyright © 2006 Apache XML Project. All Rights Reserved.
|
| </BODY>
|
| </HTML>
|
