| <!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 LSParser
|
| </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/LSParser.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/w3c/dom/ls/LSOutput.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../org/w3c/dom/ls/LSParserFilter.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="LSParser.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| <!-- ======== START OF CLASS DATA ======== -->
|
| <H2>
|
| <FONT SIZE="-1">
|
| org.w3c.dom.ls</FONT>
|
| <BR>
|
| Interface LSParser</H2>
|
| <HR>
|
| <DL>
|
| <DT>public interface <B>LSParser</B></DL>
|
|
|
| <P>
|
| An interface to an object that is able to build, or augment, a DOM tree |
| from various input sources. |
| <p> <code>LSParser</code> provides an API for parsing XML and building the |
| corresponding DOM document structure. A <code>LSParser</code> instance |
| can be obtained by invoking the |
| <code>DOMImplementationLS.createLSParser()</code> method. |
| <p> As specified in [<a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>DOM Level 3 Core</a>] |
| , when a document is first made available via the LSParser: |
| <ul> |
| <li> there will |
| never be two adjacent nodes of type NODE_TEXT, and there will never be |
| empty text nodes. |
| </li> |
| <li> it is expected that the <code>value</code> and |
| <code>nodeValue</code> attributes of an <code>Attr</code> node initially |
| return the <a href='http://www.w3.org/TR/2004/REC-xml-20040204#AVNormalize'>XML 1.0 |
| normalized value</a>. However, if the parameters "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-validate-if-schema'> |
| validate-if-schema</a>" and "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-datatype-normalization'> |
| datatype-normalization</a>" are set to <code>true</code>, depending on the attribute normalization |
| used, the attribute values may differ from the ones obtained by the XML |
| 1.0 attribute normalization. If the parameters "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-datatype-normalization'> |
| datatype-normalization</a>" is set to <code>false</code>, the XML 1.0 attribute normalization is |
| guaranteed to occur, and if the attributes list does not contain |
| namespace declarations, the <code>attributes</code> attribute on |
| <code>Element</code> node represents the property <b>[attributes]</b> defined in [<a href='http://www.w3.org/TR/2004/REC-xml-infoset-20040204/'>XML Information Set</a>] |
| . |
| </li> |
| </ul> |
| <p> Asynchronous <code>LSParser</code> objects are expected to also |
| implement the <code>events::EventTarget</code> interface so that event |
| listeners can be registered on asynchronous <code>LSParser</code> |
| objects. |
| <p> Events supported by asynchronous <code>LSParser</code> objects are: |
| <dl> |
| <dt>load</dt> |
| <dd> |
| The <code>LSParser</code> finishes to load the document. See also the |
| definition of the <code>LSLoadEvent</code> interface. </dd> |
| <dt>progress</dt> |
| <dd> The |
| <code>LSParser</code> signals progress as data is parsed. This |
| specification does not attempt to define exactly when progress events |
| should be dispatched. That is intentionally left as |
| implementation-dependent. Here is one example of how an application might |
| dispatch progress events: Once the parser starts receiving data, a |
| progress event is dispatched to indicate that the parsing starts. From |
| there on, a progress event is dispatched for every 4096 bytes of data |
| that is received and processed. This is only one example, though, and |
| implementations can choose to dispatch progress events at any time while |
| parsing, or not dispatch them at all. See also the definition of the |
| <code>LSProgressEvent</code> interface. </dd> |
| </dl> |
| <p ><b>Note:</b> All events defined in this specification use the |
| namespace URI <code>"http://www.w3.org/2002/DOMLS"</code>. |
| <p> While parsing an input source, errors are reported to the application |
| through the error handler (<code>LSParser.domConfig</code>'s "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-error-handler'> |
| error-handler</a>" parameter). This specification does in no way try to define all possible |
| errors that can occur while parsing XML, or any other markup, but some |
| common error cases are defined. The types (<code>DOMError.type</code>) of |
| errors and warnings defined by this specification are: |
| <dl> |
| <dt> |
| <code>"check-character-normalization-failure" [error]</code> </dt> |
| <dd> Raised if |
| the parameter "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-check-character-normalization'> |
| check-character-normalization</a>" is set to true and a string is encountered that fails normalization |
| checking. </dd> |
| <dt><code>"doctype-not-allowed" [fatal]</code></dt> |
| <dd> Raised if the |
| configuration parameter "disallow-doctype" is set to <code>true</code> |
| and a doctype is encountered. </dd> |
| <dt><code>"no-input-specified" [fatal]</code></dt> |
| <dd> |
| Raised when loading a document and no input is specified in the |
| <code>LSInput</code> object. </dd> |
| <dt> |
| <code>"pi-base-uri-not-preserved" [warning]</code></dt> |
| <dd> Raised if a processing |
| instruction is encountered in a location where the base URI of the |
| processing instruction can not be preserved. One example of a case where |
| this warning will be raised is if the configuration parameter "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-entities'> |
| entities</a>" is set to <code>false</code> and the following XML file is parsed: |
| <pre> |
| <!DOCTYPE root [ <!ENTITY e SYSTEM 'subdir/myentity.ent' ]> |
| <root> &e; </root></pre> |
| And <code>subdir/myentity.ent</code> |
| contains: |
| <pre><one> <two/> </one> <?pi 3.14159?> |
| <more/></pre> |
| </dd> |
| <dt><code>"unbound-prefix-in-entity" [warning]</code></dt> |
| <dd> An |
| implementation dependent warning that may be raised if the configuration |
| parameter "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-namespaces'> |
| namespaces</a>" is set to <code>true</code> and an unbound namespace prefix is |
| encountered in an entity's replacement text. Raising this warning is not |
| enforced since some existing parsers may not recognize unbound namespace |
| prefixes in the replacement text of entities. </dd> |
| <dt> |
| <code>"unknown-character-denormalization" [fatal]</code></dt> |
| <dd> Raised if the |
| configuration parameter "ignore-unknown-character-denormalizations" is |
| set to <code>false</code> and a character is encountered for which the |
| processor cannot determine the normalization properties. </dd> |
| <dt> |
| <code>"unsupported-encoding" [fatal]</code></dt> |
| <dd> Raised if an unsupported |
| encoding is encountered. </dd> |
| <dt><code>"unsupported-media-type" [fatal]</code></dt> |
| <dd> |
| Raised if the configuration parameter "supported-media-types-only" is set |
| to <code>true</code> and an unsupported media type is encountered. </dd> |
| </dl> |
| <p> In addition to raising the defined errors and warnings, implementations |
| are expected to raise implementation specific errors and warnings for any |
| other error and warning cases such as IO errors (file not found, |
| permission denied,...), XML well-formedness errors, and so on. |
| <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407'>Document Object Model (DOM) Level 3 Load |
| and Save Specification</a>.
|
| <P>
|
| <HR>
|
|
|
| <P>
|
| <!-- ======== INNER CLASS SUMMARY ======== -->
|
|
|
|
|
| <!-- =========== FIELD SUMMARY =========== -->
|
|
|
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Field Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static short</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#ACTION_APPEND_AS_CHILDREN">ACTION_APPEND_AS_CHILDREN</A></B></CODE>
|
|
|
| <BR>
|
| Append the result of the parse operation as children of the context |
| node.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static short</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#ACTION_INSERT_AFTER">ACTION_INSERT_AFTER</A></B></CODE>
|
|
|
| <BR>
|
| Insert the result of the parse operation as the immediately following |
| sibling of the context node.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static short</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#ACTION_INSERT_BEFORE">ACTION_INSERT_BEFORE</A></B></CODE>
|
|
|
| <BR>
|
| Insert the result of the parse operation as the immediately preceding |
| sibling of the context node.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static short</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#ACTION_REPLACE">ACTION_REPLACE</A></B></CODE>
|
|
|
| <BR>
|
| Replace the context node with the result of the parse operation.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static short</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#ACTION_REPLACE_CHILDREN">ACTION_REPLACE_CHILDREN</A></B></CODE>
|
|
|
| <BR>
|
| Replace all the children of the context node with the result of the |
| parse operation.</TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <!-- ======== 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> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#abort()">abort</A></B>()</CODE>
|
|
|
| <BR>
|
| Abort the loading of the document that is currently being loaded by |
| the <code>LSParser</code>.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#getAsync()">getAsync</A></B>()</CODE>
|
|
|
| <BR>
|
| <code>true</code> if the <code>LSParser</code> is asynchronous, |
| <code>false</code> if it is synchronous.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#getBusy()">getBusy</A></B>()</CODE>
|
|
|
| <BR>
|
| <code>true</code> if the <code>LSParser</code> is currently busy |
| loading a document, otherwise <code>false</code>.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/w3c/dom/DOMConfiguration.html">DOMConfiguration</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#getDomConfig()">getDomConfig</A></B>()</CODE>
|
|
|
| <BR>
|
| The <code>DOMConfiguration</code> object used when parsing an input |
| source.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/w3c/dom/ls/LSParserFilter.html">LSParserFilter</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#getFilter()">getFilter</A></B>()</CODE>
|
|
|
| <BR>
|
| When a filter is provided, the implementation will call out to the |
| filter as it is constructing the DOM tree structure.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/w3c/dom/Document.html">Document</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#parse(org.w3c.dom.ls.LSInput)">parse</A></B>(<A HREF="../../../../org/w3c/dom/ls/LSInput.html">LSInput</A> input)</CODE>
|
|
|
| <BR>
|
| Parse an XML document from a resource identified by a |
| <code>LSInput</code>.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/w3c/dom/Document.html">Document</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#parseURI(java.lang.String)">parseURI</A></B>(java.lang.String uri)</CODE>
|
|
|
| <BR>
|
| Parse an XML document from a location identified by a URI reference [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>].</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#parseWithContext(org.w3c.dom.ls.LSInput, org.w3c.dom.Node, short)">parseWithContext</A></B>(<A HREF="../../../../org/w3c/dom/ls/LSInput.html">LSInput</A> input, |
| <A HREF="../../../../org/w3c/dom/Node.html">Node</A> contextArg, |
| short action)</CODE>
|
|
|
| <BR>
|
| Parse an XML fragment from a resource identified by a |
| <code>LSInput</code> and insert the content into an existing document |
| at the position specified with the <code>context</code> and |
| <code>action</code> arguments.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/ls/LSParser.html#setFilter(org.w3c.dom.ls.LSParserFilter)">setFilter</A></B>(<A HREF="../../../../org/w3c/dom/ls/LSParserFilter.html">LSParserFilter</A> filter)</CODE>
|
|
|
| <BR>
|
| When a filter is provided, the implementation will call out to the |
| filter as it is constructing the DOM tree structure.</TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <P>
|
|
|
| <!-- ============ FIELD DETAIL =========== -->
|
|
|
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Field Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="ACTION_APPEND_AS_CHILDREN"><!-- --></A><H3>
|
| ACTION_APPEND_AS_CHILDREN</H3>
|
| <PRE>
|
| public static final short <B>ACTION_APPEND_AS_CHILDREN</B></PRE>
|
| <DL>
|
| <DD>Append the result of the parse operation as children of the context |
| node. For this action to work, the context node must be an |
| <code>Element</code> or a <code>DocumentFragment</code>.</DL>
|
| <HR>
|
|
|
| <A NAME="ACTION_REPLACE_CHILDREN"><!-- --></A><H3>
|
| ACTION_REPLACE_CHILDREN</H3>
|
| <PRE>
|
| public static final short <B>ACTION_REPLACE_CHILDREN</B></PRE>
|
| <DL>
|
| <DD>Replace all the children of the context node with the result of the |
| parse operation. For this action to work, the context node must be an |
| <code>Element</code>, a <code>Document</code>, or a |
| <code>DocumentFragment</code>.</DL>
|
| <HR>
|
|
|
| <A NAME="ACTION_INSERT_BEFORE"><!-- --></A><H3>
|
| ACTION_INSERT_BEFORE</H3>
|
| <PRE>
|
| public static final short <B>ACTION_INSERT_BEFORE</B></PRE>
|
| <DL>
|
| <DD>Insert the result of the parse operation as the immediately preceding |
| sibling of the context node. For this action to work the context |
| node's parent must be an <code>Element</code> or a |
| <code>DocumentFragment</code>.</DL>
|
| <HR>
|
|
|
| <A NAME="ACTION_INSERT_AFTER"><!-- --></A><H3>
|
| ACTION_INSERT_AFTER</H3>
|
| <PRE>
|
| public static final short <B>ACTION_INSERT_AFTER</B></PRE>
|
| <DL>
|
| <DD>Insert the result of the parse operation as the immediately following |
| sibling of the context node. For this action to work the context |
| node's parent must be an <code>Element</code> or a |
| <code>DocumentFragment</code>.</DL>
|
| <HR>
|
|
|
| <A NAME="ACTION_REPLACE"><!-- --></A><H3>
|
| ACTION_REPLACE</H3>
|
| <PRE>
|
| public static final short <B>ACTION_REPLACE</B></PRE>
|
| <DL>
|
| <DD>Replace the context node with the result of the parse operation. For |
| this action to work, the context node must have a parent, and the |
| parent must be an <code>Element</code> or a |
| <code>DocumentFragment</code>.</DL>
|
|
|
| <!-- ========= 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="getDomConfig()"><!-- --></A><H3>
|
| getDomConfig</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/w3c/dom/DOMConfiguration.html">DOMConfiguration</A> <B>getDomConfig</B>()</PRE>
|
| <DL>
|
| <DD>The <code>DOMConfiguration</code> object used when parsing an input |
| source. This <code>DOMConfiguration</code> is specific to the parse |
| operation. No parameter values from this <code>DOMConfiguration</code> |
| object are passed automatically to the <code>DOMConfiguration</code> |
| object on the <code>Document</code> that is created, or used, by the |
| parse operation. The DOM application is responsible for passing any |
| needed parameter values from this <code>DOMConfiguration</code> |
| object to the <code>DOMConfiguration</code> object referenced by the |
| <code>Document</code> object. |
| <br> In addition to the parameters recognized in on the <a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#DOMConfiguration'> |
| DOMConfiguration</a> interface defined in [<a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>DOM Level 3 Core</a>] |
| , the <code>DOMConfiguration</code> objects for <code>LSParser</code> |
| add or modify the following parameters: |
| <dl> |
| <dt> |
| <code>"charset-overrides-xml-encoding"</code></dt> |
| <dd> |
| <dl> |
| <dt><code>true</code></dt> |
| <dd>[<em>optional</em>] (<em>default</em>) If a higher level protocol such as HTTP [<a href='http://www.ietf.org/rfc/rfc2616.txt'>IETF RFC 2616</a>] provides an |
| indication of the character encoding of the input stream being |
| processed, that will override any encoding specified in the XML |
| declaration or the Text declaration (see also section 4.3.3, |
| "Character Encoding in Entities", in [<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>]). |
| Explicitly setting an encoding in the <code>LSInput</code> overrides |
| any encoding from the protocol. </dd> |
| <dt><code>false</code></dt> |
| <dd>[<em>required</em>] The parser ignores any character set encoding information from |
| higher-level protocols. </dd> |
| </dl></dd> |
| <dt><code>"disallow-doctype"</code></dt> |
| <dd> |
| <dl> |
| <dt> |
| <code>true</code></dt> |
| <dd>[<em>optional</em>] Throw a fatal <b>"doctype-not-allowed"</b> error if a doctype node is found while parsing the document. This is |
| useful when dealing with things like SOAP envelopes where doctype |
| nodes are not allowed. </dd> |
| <dt><code>false</code></dt> |
| <dd>[<em>required</em>] (<em>default</em>) Allow doctype nodes in the document. </dd> |
| </dl></dd> |
| <dt> |
| <code>"ignore-unknown-character-denormalizations"</code></dt> |
| <dd> |
| <dl> |
| <dt> |
| <code>true</code></dt> |
| <dd>[<em>required</em>] (<em>default</em>) If, while verifying full normalization when [<a href='http://www.w3.org/TR/2004/REC-xml11-20040204/'>XML 1.1</a>] is |
| supported, a processor encounters characters for which it cannot |
| determine the normalization properties, then the processor will |
| ignore any possible denormalizations caused by these characters. |
| This parameter is ignored for [<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>]. </dd> |
| <dt> |
| <code>false</code></dt> |
| <dd>[<em>optional</em>] Report an fatal <b>"unknown-character-denormalization"</b> error if a character is encountered for which the processor cannot |
| determine the normalization properties. </dd> |
| </dl></dd> |
| <dt><code>"infoset"</code></dt> |
| <dd> See |
| the definition of <code>DOMConfiguration</code> for a description of |
| this parameter. Unlike in [<a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>DOM Level 3 Core</a>] |
| , this parameter will default to <code>true</code> for |
| <code>LSParser</code>. </dd> |
| <dt><code>"namespaces"</code></dt> |
| <dd> |
| <dl> |
| <dt><code>true</code></dt> |
| <dd>[<em>required</em>] (<em>default</em>) Perform the namespace processing as defined in [<a href='http://www.w3.org/TR/1999/REC-xml-names-19990114/'>XML Namespaces</a>] |
| and [<a href='http://www.w3.org/TR/2004/REC-xml-names11-20040204/'>XML Namespaces 1.1</a>] |
| . </dd> |
| <dt><code>false</code></dt> |
| <dd>[<em>optional</em>] Do not perform the namespace processing. </dd> |
| </dl></dd> |
| <dt> |
| <code>"resource-resolver"</code></dt> |
| <dd>[<em>required</em>] A reference to a <code>LSResourceResolver</code> object, or null. If |
| the value of this parameter is not null when an external resource |
| (such as an external XML entity or an XML schema location) is |
| encountered, the implementation will request that the |
| <code>LSResourceResolver</code> referenced in this parameter resolves |
| the resource. </dd> |
| <dt><code>"supported-media-types-only"</code></dt> |
| <dd> |
| <dl> |
| <dt> |
| <code>true</code></dt> |
| <dd>[<em>optional</em>] Check that the media type of the parsed resource is a supported media |
| type. If an unsupported media type is encountered, a fatal error of |
| type <b>"unsupported-media-type"</b> will be raised. The media types defined in [<a href='http://www.ietf.org/rfc/rfc3023.txt'>IETF RFC 3023</a>] must always |
| be accepted. </dd> |
| <dt><code>false</code></dt> |
| <dd>[<em>required</em>] (<em>default</em>) Accept any media type. </dd> |
| </dl></dd> |
| <dt><code>"validate"</code></dt> |
| <dd> See the definition of |
| <code>DOMConfiguration</code> for a description of this parameter. |
| Unlike in [<a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>DOM Level 3 Core</a>] |
| , the processing of the internal subset is always accomplished, even |
| if this parameter is set to <code>false</code>. </dd> |
| <dt> |
| <code>"validate-if-schema"</code></dt> |
| <dd> See the definition of |
| <code>DOMConfiguration</code> for a description of this parameter. |
| Unlike in [<a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>DOM Level 3 Core</a>] |
| , the processing of the internal subset is always accomplished, even |
| if this parameter is set to <code>false</code>. </dd> |
| <dt> |
| <code>"well-formed"</code></dt> |
| <dd> See the definition of |
| <code>DOMConfiguration</code> for a description of this parameter. |
| Unlike in [<a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>DOM Level 3 Core</a>] |
| , this parameter cannot be set to <code>false</code>. </dd> |
| </dl></DL>
|
| <HR>
|
|
|
| <A NAME="getFilter()"><!-- --></A><H3>
|
| getFilter</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/w3c/dom/ls/LSParserFilter.html">LSParserFilter</A> <B>getFilter</B>()</PRE>
|
| <DL>
|
| <DD>When a filter is provided, the implementation will call out to the |
| filter as it is constructing the DOM tree structure. The filter can |
| choose to remove elements from the document being constructed, or to |
| terminate the parsing early. |
| <br> The filter is invoked after the operations requested by the |
| <code>DOMConfiguration</code> parameters have been applied. For |
| example, if "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-validate'> |
| validate</a>" is set to <code>true</code>, the validation is done before invoking the |
| filter.</DL>
|
| <HR>
|
|
|
| <A NAME="setFilter(org.w3c.dom.ls.LSParserFilter)"><!-- --></A><H3>
|
| setFilter</H3>
|
| <PRE>
|
| public void <B>setFilter</B>(<A HREF="../../../../org/w3c/dom/ls/LSParserFilter.html">LSParserFilter</A> filter)</PRE>
|
| <DL>
|
| <DD>When a filter is provided, the implementation will call out to the |
| filter as it is constructing the DOM tree structure. The filter can |
| choose to remove elements from the document being constructed, or to |
| terminate the parsing early. |
| <br> The filter is invoked after the operations requested by the |
| <code>DOMConfiguration</code> parameters have been applied. For |
| example, if "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-validate'> |
| validate</a>" is set to <code>true</code>, the validation is done before invoking the |
| filter.</DL>
|
| <HR>
|
|
|
| <A NAME="getAsync()"><!-- --></A><H3>
|
| getAsync</H3>
|
| <PRE>
|
| public boolean <B>getAsync</B>()</PRE>
|
| <DL>
|
| <DD><code>true</code> if the <code>LSParser</code> is asynchronous, |
| <code>false</code> if it is synchronous.</DL>
|
| <HR>
|
|
|
| <A NAME="getBusy()"><!-- --></A><H3>
|
| getBusy</H3>
|
| <PRE>
|
| public boolean <B>getBusy</B>()</PRE>
|
| <DL>
|
| <DD><code>true</code> if the <code>LSParser</code> is currently busy |
| loading a document, otherwise <code>false</code>.</DL>
|
| <HR>
|
|
|
| <A NAME="parse(org.w3c.dom.ls.LSInput)"><!-- --></A><H3>
|
| parse</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/w3c/dom/Document.html">Document</A> <B>parse</B>(<A HREF="../../../../org/w3c/dom/ls/LSInput.html">LSInput</A> input) |
| throws <A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A>, |
| <A HREF="../../../../org/w3c/dom/ls/LSException.html">LSException</A></PRE>
|
| <DL>
|
| <DD>Parse an XML document from a resource identified by a |
| <code>LSInput</code>.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>input</CODE> - The <code>LSInput</code> from which the source of the |
| document is to be read.<DT><B>Returns:</B><DD>If the <code>LSParser</code> is a synchronous |
| <code>LSParser</code>, the newly created and populated |
| <code>Document</code> is returned. If the <code>LSParser</code> is |
| asynchronous, <code>null</code> is returned since the document |
| object may not yet be constructed when this method returns.<DT><B>Throws:</B><DD><A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A> - INVALID_STATE_ERR: Raised if the <code>LSParser</code>'s |
| <code>LSParser.busy</code> attribute is <code>true</code>.<DD><A HREF="../../../../org/w3c/dom/ls/LSException.html">LSException</A> - PARSE_ERR: Raised if the <code>LSParser</code> was unable to load |
| the XML document. DOM applications should attach a |
| <code>DOMErrorHandler</code> using the parameter "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-error-handler'> |
| error-handler</a>" if they wish to get details on the error.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="parseURI(java.lang.String)"><!-- --></A><H3>
|
| parseURI</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/w3c/dom/Document.html">Document</A> <B>parseURI</B>(java.lang.String uri) |
| throws <A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A>, |
| <A HREF="../../../../org/w3c/dom/ls/LSException.html">LSException</A></PRE>
|
| <DL>
|
| <DD>Parse an XML document from a location identified by a URI reference [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>]. If the URI |
| contains a fragment identifier (see section 4.1 in [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>]), the |
| behavior is not defined by this specification, future versions of |
| this specification may define the behavior.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>uri</CODE> - The location of the XML document to be read.<DT><B>Returns:</B><DD>If the <code>LSParser</code> is a synchronous |
| <code>LSParser</code>, the newly created and populated |
| <code>Document</code> is returned, or <code>null</code> if an error |
| occured. If the <code>LSParser</code> is asynchronous, |
| <code>null</code> is returned since the document object may not yet |
| be constructed when this method returns.<DT><B>Throws:</B><DD><A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A> - INVALID_STATE_ERR: Raised if the <code>LSParser.busy</code> |
| attribute is <code>true</code>.<DD><A HREF="../../../../org/w3c/dom/ls/LSException.html">LSException</A> - PARSE_ERR: Raised if the <code>LSParser</code> was unable to load |
| the XML document. DOM applications should attach a |
| <code>DOMErrorHandler</code> using the parameter "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-error-handler'> |
| error-handler</a>" if they wish to get details on the error.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="parseWithContext(org.w3c.dom.ls.LSInput, org.w3c.dom.Node, short)"><!-- --></A><H3>
|
| parseWithContext</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/w3c/dom/Node.html">Node</A> <B>parseWithContext</B>(<A HREF="../../../../org/w3c/dom/ls/LSInput.html">LSInput</A> input, |
| <A HREF="../../../../org/w3c/dom/Node.html">Node</A> contextArg, |
| short action) |
| throws <A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A>, |
| <A HREF="../../../../org/w3c/dom/ls/LSException.html">LSException</A></PRE>
|
| <DL>
|
| <DD>Parse an XML fragment from a resource identified by a |
| <code>LSInput</code> and insert the content into an existing document |
| at the position specified with the <code>context</code> and |
| <code>action</code> arguments. When parsing the input stream, the |
| context node (or its parent, depending on where the result will be |
| inserted) is used for resolving unbound namespace prefixes. The |
| context node's <code>ownerDocument</code> node (or the node itself if |
| the node of type <code>DOCUMENT_NODE</code>) is used to resolve |
| default attributes and entity references. |
| <br> As the new data is inserted into the document, at least one |
| mutation event is fired per new immediate child or sibling of the |
| context node. |
| <br> If the context node is a <code>Document</code> node and the action |
| is <code>ACTION_REPLACE_CHILDREN</code>, then the document that is |
| passed as the context node will be changed such that its |
| <code>xmlEncoding</code>, <code>documentURI</code>, |
| <code>xmlVersion</code>, <code>inputEncoding</code>, |
| <code>xmlStandalone</code>, and all other such attributes are set to |
| what they would be set to if the input source was parsed using |
| <code>LSParser.parse()</code>. |
| <br> This method is always synchronous, even if the |
| <code>LSParser</code> is asynchronous (<code>LSParser.async</code> is |
| <code>true</code>). |
| <br> If an error occurs while parsing, the caller is notified through |
| the <code>ErrorHandler</code> instance associated with the "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-error-handler'> |
| error-handler</a>" parameter of the <code>DOMConfiguration</code>. |
| <br> When calling <code>parseWithContext</code>, the values of the |
| following configuration parameters will be ignored and their default |
| values will always be used instead: "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-validate'> |
| validate</a>", "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-validate-if-schema'> |
| validate-if-schema</a>", and "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-element-content-whitespace'> |
| element-content-whitespace</a>". Other parameters will be treated normally, and the parser is expected |
| to call the <code>LSParserFilter</code> just as if a whole document |
| was parsed.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>input</CODE> - The <code>LSInput</code> from which the source document |
| is to be read. The source document must be an XML fragment, i.e. |
| anything except a complete XML document (except in the case where |
| the context node of type <code>DOCUMENT_NODE</code>, and the action |
| is <code>ACTION_REPLACE_CHILDREN</code>), a DOCTYPE (internal |
| subset), entity declaration(s), notation declaration(s), or XML or |
| text declaration(s).<DD><CODE>contextArg</CODE> - The node that is used as the context for the data |
| that is being parsed. This node must be a <code>Document</code> |
| node, a <code>DocumentFragment</code> node, or a node of a type |
| that is allowed as a child of an <code>Element</code> node, e.g. it |
| cannot be an <code>Attribute</code> node.<DD><CODE>action</CODE> - This parameter describes which action should be taken |
| between the new set of nodes being inserted and the existing |
| children of the context node. The set of possible actions is |
| defined in <code>ACTION_TYPES</code> above.<DT><B>Returns:</B><DD>Return the node that is the result of the parse operation. If |
| the result is more than one top-level node, the first one is |
| returned.<DT><B>Throws:</B><DD><A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A> - HIERARCHY_REQUEST_ERR: Raised if the content cannot replace, be |
| inserted before, after, or as a child of the context node (see also |
| <code>Node.insertBefore</code> or <code>Node.replaceChild</code> in [<a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>DOM Level 3 Core</a>] |
| ). |
| <br> NOT_SUPPORTED_ERR: Raised if the <code>LSParser</code> doesn't |
| support this method, or if the context node is of type |
| <code>Document</code> and the DOM implementation doesn't support |
| the replacement of the <code>DocumentType</code> child or |
| <code>Element</code> child. |
| <br> NO_MODIFICATION_ALLOWED_ERR: Raised if the context node is a |
| read only node and the content is being appended to its child list, |
| or if the parent node of the context node is read only node and the |
| content is being inserted in its child list. |
| <br> INVALID_STATE_ERR: Raised if the <code>LSParser.busy</code> |
| attribute is <code>true</code>.<DD><A HREF="../../../../org/w3c/dom/ls/LSException.html">LSException</A> - PARSE_ERR: Raised if the <code>LSParser</code> was unable to load |
| the XML fragment. DOM applications should attach a |
| <code>DOMErrorHandler</code> using the parameter "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-error-handler'> |
| error-handler</a>" if they wish to get details on the error.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="abort()"><!-- --></A><H3>
|
| abort</H3>
|
| <PRE>
|
| public void <B>abort</B>()</PRE>
|
| <DL>
|
| <DD>Abort the loading of the document that is currently being loaded by |
| the <code>LSParser</code>. If the <code>LSParser</code> is currently |
| not busy, a call to this method does nothing.</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/LSParser.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/w3c/dom/ls/LSOutput.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../org/w3c/dom/ls/LSParserFilter.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="LSParser.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: <A HREF="#field_detail">FIELD</A> | 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>
|
