You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by an...@apache.org on 2001/07/30 10:21:57 UTC
cvs commit: xml-xerces/java/docs/dtd blocks.ent
andyc 01/07/30 01:21:57
Modified: java/docs Tag: xerces_j_2 docs-book.xml xni-api.xml
xni-config.xml xni.xml
java/docs/dtd Tag: xerces_j_2 blocks.ent
Log:
Added XNI API overview and samples to documentation.
Revision Changes Path
No revision
No revision
1.5.2.6 +2 -0 xml-xerces/java/docs/docs-book.xml
Index: docs-book.xml
===================================================================
RCS file: /home/cvs/xml-xerces/java/docs/docs-book.xml,v
retrieving revision 1.5.2.5
retrieving revision 1.5.2.6
diff -u -r1.5.2.5 -r1.5.2.6
--- docs-book.xml 2001/07/27 10:03:37 1.5.2.5
+++ docs-book.xml 2001/07/30 08:21:56 1.5.2.6
@@ -29,8 +29,10 @@
id='xni' source='xni.xml'/>
<hidden title='XNI Design' id='xni-design' source='xni-design.xml'/>
<hidden title='XNI API' id='xni-api' source='xni-api.xml'/>
+ <!--
<design title='Xerces Native Interface Design'
id='design-xni' source='design-xni.xml'/>
+-->
<hidden title='XNI Parser Configuration'
id='xni-config' source='xni-config.xml'/>
<faqs label='FAQs' title='Frequently Asked Questions' id='faqs'>
1.1.2.3 +1334 -3 xml-xerces/java/docs/Attic/xni-api.xml
Index: xni-api.xml
===================================================================
RCS file: /home/cvs/xml-xerces/java/docs/Attic/xni-api.xml,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- xni-api.xml 2001/07/27 10:03:37 1.1.2.2
+++ xni-api.xml 2001/07/30 08:21:56 1.1.2.3
@@ -1,9 +1,1340 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE s1 SYSTEM 'dtd/document.dtd'>
<s1 title='XNI API Documentation'>
- <s2 title='XNI Core'>
- <p>Package <code>org.apache.xerces.xni</code>:</p>
+ <s2 title='XNI API Documentation'>
+ <p>
+ The Xerces Native Interface core contains a series of
+ interfaces and classes designed to communicate a document's
+ "streaming" information set. This page documents the API
+ available for receiving this information in the following
+ sections:
+ </p>
+ <ul>
+ <li><link anchor='document-information'>Document Information</link></li>
+ <li><link anchor='dtd-information'>DTD Information</link></li>
+ </ul>
+ <p>
+ A few examples are also included to illustrate the use of the
+ streaming information set:
+ </p>
+ <ul>
+ <li>
+ <link anchor='pass-through-filter'>Pass-Through Document
+ Handler Filter</link>
+ </li>
+ <li><link anchor=''></link></li>
+ </ul>
+ <p>
+ For information regarding the parser configuration framework,
+ refer to the <link idref='xni-config'>Parser Configuration</link>
+ documentation.
+ </p>
</s2>
- <s2 title='XNI Parser Configuration'>
+ <s2 title='Document Information'>
+ <p>
+ The document information is communicated using the
+ <code>XMLDocumentHandler</code> interface. In addition, the
+ <code>XMLDocumentFragmentHandler</code> interface is included
+ to get information regarding document fragments. Programmers
+ already familiar with the SAX programming interfaces should
+ be immediately comfortable programming to the Xerces Native
+ Interface. However, XNI does not depend on the SAX interfaces
+ and classes.
+ </p>
+ <anchor name='document-handler'/>
+ <s3 title='Interface XMLDocumentHandler'>
+ <p>
+ Communicates document structure and content information. This
+ is the most important handler interface in the Xerces Native
+ Interface.
+ </p>
+ <table>
+ <tr><th>Methods</th></tr>
+ <tr>
+ <td>
+ <code>
+ public void startDocument(
+ <link anchor='locator'>XMLLocator</link> locator,
+ String encoding
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void xmlDecl(
+ String version,
+ String encoding,
+ String standalone
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void doctypeDecl(
+ String rootElement,
+ String publicId,
+ String systemId
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void comment(
+ <link anchor='string'>XMLString</link> text
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void processingInstruction(
+ String target,
+ <link anchor='string'>XMLString</link> data
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void startPrefixMapping(
+ String prefix,
+ String uri
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endPrefixMapping(
+ String prefix
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void startElement(
+ <link anchor='qname'>QName</link> element,
+ <link anchor='attributes'>XMLAttributes</link> attributes
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void emptyElement(
+ <link anchor='qname'>QName</link> element,
+ <link anchor='attributes'>XMLAttributes</link> attributes
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endElement(
+ <link anchor='qname'>QName</link> element
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void startEntity(
+ String name,
+ String publicId,
+ String systemId,
+ String baseSystemId,
+ String encoding
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void textDecl(
+ String version,
+ String encoding
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endEntity(
+ String name
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void characters(
+ <link anchor='string'>XMLString</link> text
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void ignorableWhitespace(
+ <link anchor='string'>XMLString</link> text
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void startCDATA()
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endCDATA()
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endDocument()
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ </table>
+ </s3>
+ <anchor name='document-fragment-handler'/>
+ <s3 title='Interface XMLDocumentFragmentHandler'>
+ <p>
+ Communicates information about a document fragment. This
+ interface is provided for convenience in defining a document
+ fragment but is not required to be used by a compliant XNI
+ parser component or configuration.
+ </p>
+ <table>
+ <tr><th>Methods</th></tr>
+ <tr>
+ <td>
+ <code>
+ public void startDocumentFragment(
+ <link anchor='locator'>XMLLocator</link> locator,
+ <link anchor='namespace-context'>NamespaceContext</link>
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void startEntity(
+ String name,
+ String publicId,
+ String systemId,
+ String baseSystemId,
+ String encoding
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void textDecl(
+ String version,
+ String encoding
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endEntity(
+ String name
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void comment(
+ <link anchor='string'>XMLString</link> text
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void processingInstruction(
+ String target,
+ <link anchor='string'>XMLString</link> data
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void startPrefixMapping(
+ String prefix,
+ String uri
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endPrefixMapping(
+ String prefix
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void startElement(
+ <link anchor='qname'>QName</link> element,
+ <link anchor='attributes'>XMLAttributes</link> attributes
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void emptyElement(
+ <link anchor='qname'>QName</link> element,
+ <link anchor='attributes'>XMLAttributes</link> attributes
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endElement(
+ <link anchor='qname'>QName</link> element
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void characters(
+ <link anchor='string'>XMLString</link> text
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void ignorableWhitespace(
+ <link anchor='string'>XMLString</link> text
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void startCDATA()
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endCDATA()
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endDocumentFragment()
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ </table>
+ </s3>
+ <p>
+ Besides the handler interfaces there are several related
+ interfaces and classes. All of these are described below.
+ </p>
+ <anchor name='exception'/>
+ <s3 title='Class XNIException'>
+ <p>Represents a generic Xerces Native Interface exception.</p>
+ <p>
+ <strong>Note:</strong>
+ This exception extends <code>java.lang.RuntimeException</code>.
+ Therefore, even though all of the handler interface methods can
+ throw this type of exception, it is not explicitly required to
+ be caught. Since XNI is intended to be an internal set of
+ interfaces, it is expected that XNI implementations will provide
+ a catch block for this exception at the top level so that XNI
+ exceptions do not "leak" out to the application code.
+ </p>
+ <table>
+ <tr><th>Constructors</th></tr>
+ <tr><td><code>public XNIException(String message);</code></td></tr>
+ <tr>
+ <td><code>public XNIException(Exception exception);</code></td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public XNIException(String message, Exception exception);
+ </code>
+ </td>
+ </tr>
+ <tr><th>Methods</th></tr>
+ <tr><td><code>public Exception getException();</code></td></tr>
+ </table>
+ </s3>
+ <anchor name='locator'/>
+ <s3 title='Interface XMLLocator'>
+ <p>
+ This interface is used to communicate the document location to
+ the various handler interfaces. The application can use the
+ methods on this interface to query the public, system, and
+ base system identifier as well as the line and column number.
+ </p>
+ <p>
+ A locator is passed as a parameter in the first method called
+ by the <code>XMLDocumentHandler</code>,
+ <code>XMLDocumentFragmentHandler</code>, and
+ <code>XMLDTDHandler</code> interfaces.
+ </p>
+ <p>
+ <strong>Note:</strong>
+ Parser components that emit document information are not required
+ to provide a locator object. However, the Xerces2 reference
+ implementation <em>does</em> provide a locator to registered
+ handlers.
+ </p>
+ <table>
+ <tr><th>Methods</th></tr>
+ <tr><td><code>public String getPublicId();</code></td></tr>
+ <tr><td><code>public String getSystemId();</code></td></tr>
+ <tr><td><code>public String getBaseSystemId();</code></td></tr>
+ <tr><td><code>public int getLineNumber();</code></td></tr>
+ <tr><td><code>public int getColumnNumber();</code></td></tr>
+ </table>
+ </s3>
+ <anchor name='qname'/>
+ <s3 title='Class QName'>
+ <p>The QName object is a structure of qualified name information.</p>
+ <p>
+ <strong>Note:</strong>
+ The fields of this object have public visibility but should be
+ considered to be <em>read-only</em> to all methods that are
+ passed this object. The caller that creates and passes the QName
+ object "owns" the data. Therefore, callees should
+ <strong>not</strong> retain a reference to the passed object and
+ are required to copy the references contained in the object if
+ the data is to be used beyond the scope of the method call.
+ </p>
+ <table>
+ <tr><th>Fields</th></tr>
+ <tr><td><code>public String prefix;</code></td></tr>
+ <tr><td><code>public String localpart;</code></td></tr>
+ <tr><td><code>public String rawname;</code></td></tr>
+ <tr><td><code>public String uri;</code></td></tr>
+ <tr><th>Constructors</th></tr>
+ <tr><td><code>public QName();</code></td></tr>
+ <tr>
+ <td>
+ <code>
+ public QName(String prefix, String localpart,
+ String rawname, String uri);
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public QName(<link anchor='qname'>QName</link> qname);
+ </code>
+ </td>
+ </tr>
+ <tr><th>Convenience Methods</th></tr>
+ <tr>
+ <td>
+ <code>
+ public void setValues(String prefix, String localpart,
+ String rawname, String uri);
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void setValues(<link anchor='qname'>QName</link> qname);
+ </code>
+ </td>
+ </tr>
+ <tr><td><code>public void clear();</code></td></tr>
+ </table>
+ </s3>
+ <anchor name='attributes'/>
+ <s3 title='Interface XMLAttributes'>
+ <p>
+ This interface represents the collection of attributes that is
+ passed to the <code>startElement</code> and <code>emptyElement</code>
+ methods of the <code>XMLDocumentHandler</code> and
+ <code>XMLDocumentFragmentHandler</code> interfaces. This
+ collection of attributes contains all of the information about
+ the attributes of an element (except order) and is editable.
+ </p>
+ <p>
+ This interface is also capable of storing information about
+ entities appearing in the attribute value. However, it should
+ be noted that if entity information is set for an attribute,
+ then the non-normalized value of the attribute <strong>must</strong>
+ also be stored because the offsets and lengths of entities in
+ the attribute have no meaning for the normalized value.
+ </p>
+ <table>
+ <tr><th>Methods</th></tr>
+ <tr>
+ <td>
+ <code>
+ public void addAttribute(
+ <link anchor='qname'>QName</link> attrName,
+ String attrType,
+ String attrValue
+ );
+ </code>
+ </td>
+ </tr>
+ <tr><td><code>public void removeAllAttributes();</code></td></tr>
+ <tr>
+ <td><code>public void removeAttributeAt(int attrIndex);</code></td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void addAttributeEntity(
+ int attrIndex,
+ String entityName,
+ int entityOffset,
+ int entityLength
+ );
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>public void removeAllEntitiesFor(int attrIndex);</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void removeEntityAt(int attrIndex, int entityIndex);
+ </code>
+ </td>
+ </tr>
+ <tr><td><code>public int getLength();</code></td></tr>
+ <tr><td><code>public int getIndex(String qName);</code></td></tr>
+ <tr>
+ <td>
+ <code>public int getIndex(String uri, String localName);</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void setName(
+ int attrIndex,
+ <link anchor='qname'>QName</link> attrName
+ );
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void getName(
+ int attrIndex,
+ <link anchor='qname'>QName</link> attrName
+ );
+ </code>
+ </td>
+ </tr>
+ <tr><td><code>public String getURI(int attrIndex);</code></td></tr>
+ <tr>
+ <td><code>public String getLocalName(int attrIndex);</code></td>
+ </tr>
+ <tr><td><code>public String getQName(int attrIndex);</code></td></tr>
+ <tr>
+ <td>
+ <code>public void setType(int attrIndex, String attrType);</code>
+ </td>
+ </tr>
+ <tr><td><code>public String getType(int attrIndex);</code></td></tr>
+ <tr><td><code>public String getType(String qName);</code></td></tr>
+ <tr>
+ <td>
+ <code>public String getType(String uri, String localName);</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>public void setValue(int attrIndex, String attrValue);</code>
+ </td>
+ </tr>
+ <tr><td><code>public String getValue(int attrIndex);</code></td></tr>
+ <tr><td><code>public String getValue(String qName);</code></td></tr>
+ <tr>
+ <td>
+ <code>public String getValue(String uri, String localName);</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void setNonNormalizedValue(int attrIndex, String attrValue);
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>public String getNonNormalizedValue(int attrIndex);</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void setSpecified(int attrIndex, boolean specified);
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td><code>public boolean isSpecified(int attrIndex);</code></td>
+ </tr>
+ <tr>
+ <td><code>public int getEntityCount(int attrIndex);</code></td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void setEntityName(
+ int attrIndex,
+ int entityIndex,
+ String entityName
+ );
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public String getEntityName(
+ int attrIndex,
+ int entityIndex
+ );
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void setEntityOffset(
+ int attrIndex,
+ int entityIndex,
+ int entityOffset
+ );
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public int getEntityOffset(
+ int attrIndex,
+ int entityIndex
+ );
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void setEntityLength(
+ int attrIndex,
+ int entityIndex,
+ int entityLength
+ );
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public int getEntityLength(
+ int attrIndex,
+ int entityIndex
+ );
+ </code>
+ </td>
+ </tr>
+ </table>
+ </s3>
+ <anchor name='string'/>
+ <s3 title='Class XMLString'>
+ <p>
+ The XMLString object is a structure for holding text information.
+ This object allows the underlying implementation to pass text
+ information by using its own internal character buffer without
+ creating new String objects or copying the data.
+ </p>
+ <p>
+ <strong>Note:</strong>
+ The fields of this object have public visibility but should be
+ considered to be <em>read-only</em> to all methods that are
+ passed this object. The caller that creates and passes the
+ XMLString object "owns" the data. Therefore, callees should
+ <strong>not</strong> retain a reference to the passed object and
+ are required to copy the information contained in the object if
+ the data is to be used beyond the scope of the method call. Also,
+ callees should <strong>never</strong> modify the contents of the
+ character array directly as that could adversely affect the
+ operation of the caller.
+ </p>
+ <table>
+ <tr><th>Fields</th></tr>
+ <tr><td><code>public char[] ch;</code></td></tr>
+ <tr><td><code>public int offset;</code></td></tr>
+ <tr><td><code>public int length;</code></td></tr>
+ <tr><th>Constructors</th></tr>
+ <tr><td><code>public XMLString();</code></td></tr>
+ <tr>
+ <td>
+ <code>
+ public XMLString(char[] ch, int offset, int length);
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public XMLString(<link anchor='string'>XMLString</link> string);
+ </code>
+ </td>
+ </tr>
+ <tr><th>Convenience Methods</th></tr>
+ <tr>
+ <td>
+ <code>
+ public void setValues(char[] ch, int offset, int length);
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void setValues(<link anchor='string'>XMLString</link> string);
+ </code>
+ </td>
+ </tr>
+ <tr><td><code>public void clear();</code></td></tr>
+ </table>
+ </s3>
+ <anchor name='namespace-context'/>
+ <s3 title='Interface NamespaceContext'>
+ <p>
+ Namespace context information for document fragments. This
+ object is passed to the first method of the
+ <code>XMLDocumentFragmentHandler</code> interface.
+ </p>
+ <table>
+ <tr><th>Constants</th></tr>
+ <tr><td><code>public static final String XMLNS;</code></td></tr>
+ <tr><td><code>public String getURI(String prefix);</code></td></tr>
+ <tr><td><code>public int getDeclaredPrefixCount();</code></td></tr>
+ <tr>
+ <td><code>public String getDeclaredPrefixAt(int index);</code></td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public <link anchor='namespace-context'>NamespaceContext</link>
+ getParentContext();
+ </code>
+ </td>
+ </tr>
+ </table>
+ </s3>
+ </s2>
+ <s2 title='DTD Information'>
+ <p>
+ The DTD information is communicated through two interfaces:
+ <code>XMLDTDHandler</code> and <code>XMLDTDContentModelHandler</code>.
+ The first handler interface passes the basic DTD information
+ whereas the second handler interface breaks down each element
+ declaration content model into separate callbacks.
+ </p>
+ <s3 title='Interface XMLDTDHandler'>
+ <p>
+ Communicates basic DTD information such as element and attribute
+ declarations. The implementor of this interface can also be
+ informed of characters within an ignored conditional section.
+ </p>
+ <table>
+ <tr><th>Constants</th></tr>
+ <tr>
+ <td><code>public static final short CONDITIONAL_INCLUDE;</code></td>
+ </tr>
+ <tr>
+ <td><code>public static final short CONDITIONAL_IGNORE;</code></td>
+ </tr>
+ <tr><th>Methods</th></tr>
+ <tr>
+ <td>
+ <code>
+ public void startDTD(
+ <link anchor='locator'>XMLLocator</link> locator
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void startEntity(
+ String name,
+ String publicId,
+ String systemId,
+ String baseSystemId,
+ String encoding
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void textDecl(
+ String version,
+ String encoding
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endEntity(
+ String name
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void comment(
+ <link anchor='string'>XMLString</link> text
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void processingInstruction(
+ String target,
+ <link anchor='string'>XMLString</link> data
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void elementDecl(
+ String name,
+ String contentModel
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void startAttlist(
+ String elementName
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void attributeDecl(
+ String elementName,
+ String attributeName,
+ String type,
+ String[] enumeration,
+ String defaultType,
+ <link anchor='string'>XMLString</link> defaultValue
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endAttlist() throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void internalEntityDecl(
+ String name,
+ <link anchor='string'>XMLString</link> text
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void externalEntityDecl(
+ String name,
+ String publicId,
+ String systemId,
+ String baseSystemId
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void unparsedEntityDecl(
+ String name,
+ String publicId,
+ String systemId,
+ String notation
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void notationDecl(
+ String name,
+ String publicId,
+ String systemId
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void startConditional(
+ short type
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void characters(
+ <link anchor='string'>XMLString</link> text
+ ) throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endConditional() throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endDTD() throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ </table>
+ </s3>
+ <s3 title='Interface XMLDTDContentModelHandler'>
+ <p>
+ Breaks down each element declaration's content model into
+ a set of separate methods so that handlers don't have to
+ reparse the content model string given in the
+ <code>XMLDTDHandler#elementDecl(String,String)</code> method.
+ This separation also helps those applications that want to
+ know boundaries of entities when used as part of an element's
+ content model.
+ </p>
+ <table>
+ <tr><th>Constants</th></tr>
+ <tr>
+ <td>
+ <code>public static final short SEPARATOR_CHOICE;</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>public static final short SEPARATOR_SEQUENCE;</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>public static final short OCCURS_ZERO_OR_ONE;</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>public static final short OCCURS_ZERO_OR_MORE;</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>public static final short OCCURS_ONE_OR_MORE;</code>
+ </td>
+ </tr>
+ <tr><th>Methods</th></tr>
+ <tr>
+ <td>
+ <code>
+ public void startContentModel()
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void any()
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void empty()
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void startGroup()
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void pcdata()
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void element(String elementName)
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void separator(short type)
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void occurrence(short type)
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endGroup()
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ public void endContentModel()
+ throws <link anchor='exception'>XNIException</link>;
+ </code>
+ </td>
+ </tr>
+ </table>
+ </s3>
+ </s2>
+ <s2 title='Examples'>
+ <p>
+ The following examples demonstrate the basic use of the various
+ XNI handler interfaces.
+ </p>
+ <anchor name='pass-through-filter'/>
+ <s3 title='Pass-Through Document Handler Filter'>
+ <p>
+ The following example demonstrates a basic pass-through
+ document handler filter. This filter receives document handler
+ events and passes them through to the next document handler.
+ </p>
+ <source>import org.apache.xerces.xni.<link anchor='qname'>QName</link>;
+import org.apache.xerces.xni.<link anchor='attributes'>XMLAttributes</link>;
+import org.apache.xerces.xni.<link anchor='document-handler'>XMLDocumentHandler</link>;
+import org.apache.xerces.xni.<link anchor='locator'>XMLLocator</link>;
+import org.apache.xerces.xni.<link anchor='string'>XMLString</link>;
+import org.apache.xerces.xni.<link anchor='string'>XNIException</link>;
+
+public class PassThroughFilter
+ implements <link anchor='document-handler'>XMLDocumentHandler</link> {
+
+ // Data
+
+ protected <link anchor='document-handler'>XMLDocumentHandler</link> fDocumentHandler;
+
+ // Public methods
+
+ public void setDocumentHandler(<link anchor='document-handler'>XMLDocumentHandler</link> handler) {
+ fDocumentHandler = handler;
+ }
+
+ // XMLDocumentHandler methods
+
+ public void startDocument(<link anchor='locator'>XMLLocator</link> locator, String encoding)
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.startDocument(locator, encoding);
+ }
+ }
+
+ public void xmlDecl(String version, String encoding,
+ String standalone) throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.xmlDecl(version, encoding, standalone);
+ }
+ }
+
+ public void doctypeDecl(String rootElement, String publicId,
+ String systemId) throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.doctypeDecl(rootElement, publicId, systemId);
+ }
+ }
+
+ public void comment(<link anchor='string'>XMLString</link> text)
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.comment(text);
+ }
+ }
+
+ public void processingInstruction(String target, <link anchor='string'>XMLString</link> data)
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.processingInstruction(target, data);
+ }
+ }
+
+ public void startPrefixMapping(String prefix, String uri)
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.startPrefixMapping(prefix, uri);
+ }
+ }
+
+ public void endPrefixMapping(String prefix)
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.endPrefixMapping(prefix);
+ }
+ }
+
+ public void startElement(<link anchor='qname'>QName</link> element, <link anchor='attributes'>XMLAttributes</link> attributes)
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.startElement(element, attributes);
+ }
+ }
+
+ public void emptyElement(<link anchor='qname'>QName</link> element, <link anchor='attributes'>XMLAttributes</link> attributes)
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.emptyElement(element, attributes);
+ }
+ }
+
+ public void endElement(<link anchor='qname'>QName</link> element)
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.endElement(element);
+ }
+ }
+
+ public void startEntity(String name,
+ String publicId, String systemId,
+ String baseSystemId, String encoding)
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.startEntity(name,
+ publicId, systemId,
+ baseSystemId, encoding);
+ }
+ }
+
+ public void textDecl(String version, String encoding)
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.textDecl(version, encoding);
+ }
+ }
+
+ public void endEntity(String name)
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.endEntity(name);
+ }
+ }
+
+ public void characters(<link anchor='string'>XMLString</link> text)
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.characters(text);
+ }
+ }
+
+ public void ignorableWhitespace(<link anchor='string'>XMLString</link> text)
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.ignorableWhitespace(text);
+ }
+ }
+
+ public void startCDATA()
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.startCDATA();
+ }
+ }
+
+ public void endCDATA()
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.endCDATA();
+ }
+ }
+
+ public void endDocument()
+ throws <link anchor='exception'>XNIException</link> {
+ if (fDocumentHandler != null) {
+ fDocumentHandler.endDocument();
+ }
+ }
+
+} // class PassThroughFilter</source>
+ </s3>
+ <s3 title='Upper-Case Filter'>
+ <p>
+ The following code extends the pass-through document handler
+ filter to upper-case all of the element names.
+ </p>
+ <source>import org.apache.xerces.xni.<link anchor='qname'>QName</link>;
+import org.apache.xerces.xni.<link anchor='attributes'>XMLAttributes</link>;
+import org.apache.xerces.xni.<link anchor='string'>XNIException</link>;
+
+public class UpperCaseFilter
+ extends PassThroughFilter {
+
+ // Data
+
+ private final <link anchor='qname'>QName</link> fQName = new QName();
+
+ // XMLDocumentHandler methods
+
+ public void startElement(<link anchor='qname'>QName</link> element, <link anchor='attributes'>XMLAttributes attributes</link>)
+ throws <link anchor='exception'>XNIException</link> {
+ super.startElement(toUpperCase(element), attributes);
+ }
+
+ public void emptyElement(<link anchor='qname'>QName</link> element, <link anchor='attributes'>XMLAttributes attributes</link>)
+ throws <link anchor='exception'>XNIException</link> {
+ super.emptyElement(toUpperCase(element), attributes);
+ }
+
+ public void endElement(<link anchor='qname'>QName</link> element)
+ throws <link anchor='exception'>XNIException</link> {
+ super.endElement(toUpperCase(element));
+ }
+
+ // Protected methods
+
+ protected QName toUpperCase(<link anchor='qname'>QName</link> qname) {
+ String prefix = qname.prefix != null
+ ? qname.prefix.toUpperCase() : null;
+ String localpart = qname.localpart != null
+ ? qname.localpart.toUpperCase() : null;
+ String rawname = qname.rawname != null
+ ? qname.rawname.toUpperCase() : null;
+ String uri = qname.uri;
+ fQName.setValues(prefix, localpart, rawname, uri);
+ return fQName;
+ }
+
+} // class UpperCaseFilter</source>
+ </s3>
</s2>
</s1>
1.1.2.2 +12 -0 xml-xerces/java/docs/Attic/xni-config.xml
Index: xni-config.xml
===================================================================
RCS file: /home/cvs/xml-xerces/java/docs/Attic/xni-config.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- xni-config.xml 2001/07/25 08:43:36 1.1.2.1
+++ xni-config.xml 2001/07/30 08:21:56 1.1.2.2
@@ -2,4 +2,16 @@
<!DOCTYPE s1 SYSTEM 'dtd/document.dtd'>
<s1 title='XNI Parser Configuration'>
<p><strong>TODO</strong></p>
+ <!--
+ <s2 title='XNI Parser Configuration'>
+ <p>
+ An XML application programmer can use the Xerces Native Interface
+ parser configuration interfaces to build different parser
+ configurations, either completely from scratch or by mixing
+ and matching existing parser components. For advanced users
+ that want to take advantage of this capability, an understanding
+ of the parser configuration framework is required.
+ </p>
+ </s2>
+ -->
</s1>
1.1.2.4 +1 -1 xml-xerces/java/docs/Attic/xni.xml
Index: xni.xml
===================================================================
RCS file: /home/cvs/xml-xerces/java/docs/Attic/xni.xml,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -u -r1.1.2.3 -r1.1.2.4
--- xni.xml 2001/07/25 08:43:36 1.1.2.3
+++ xni.xml 2001/07/30 08:21:56 1.1.2.4
@@ -109,7 +109,7 @@
</table>
<p>
For complete details of the Xerces Native Interface, refer to
- the <link idref='xni-api'>XNI API</link> documentation.
+ the <link idref='xni-api'>API Documentation</link>.
</p>
</s2>
<anchor name='generic-parser-configurations'/>
No revision
No revision
1.1.2.2 +1 -1 xml-xerces/java/docs/dtd/blocks.ent
Index: blocks.ent
===================================================================
RCS file: /home/cvs/xml-xerces/java/docs/dtd/blocks.ent,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- blocks.ent 2001/07/25 08:43:37 1.1.2.1
+++ blocks.ent 2001/07/30 08:21:57 1.1.2.2
@@ -20,7 +20,7 @@
<!ELEMENT label %content;>
<!ELEMENT item %content;>
-<!ELEMENT source (#PCDATA)>
+<!ELEMENT source (#PCDATA|link)*>
<!ELEMENT table (tr)+>
---------------------------------------------------------------------
To unsubscribe, e-mail: xerces-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xerces-cvs-help@xml.apache.org