|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.esri.aims.mtier.model.axl.AXLContentHandler
Defines an implementation of ContentHandler so that ArcIMS programmers are not required to write common or empty implementations of methods.
ContentHandler
Constructor Summary | |
AXLContentHandler()
|
Method Summary | |
void |
characters(char[] ch,
int start,
int length)
Receives notification of character data inside an element. |
void |
endDocument()
Receives notification of the end of the document. |
void |
endElement(String uri,
String localName,
String qName)
Receive notification of the end of an element. |
void |
endPrefixMapping(String prefix)
Ends the scope of a prefix-URI mapping. |
void |
ignorableWhitespace(char[] ch,
int start,
int length)
Receives notification of ignorable whitespace in element content. |
void |
processingInstruction(String target,
String data)
Receives notification of a processing instruction. |
void |
setDocumentLocator(com.esri.xml.sax.Locator locator)
Receives an object for locating the origin of SAX document events. |
void |
skippedEntity(String name)
Receives notification of a skipped entity. |
void |
startDocument()
Receives notification of the beginning of a document. |
void |
startElement(String uri,
String localName,
String qName,
com.esri.xml.sax.Attributes atts)
Receives notification of the beginning of an element. |
void |
startPrefixMapping(String prefix,
String uri)
Begin the scope of a prefix-URI Namespace mapping. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AXLContentHandler()
Method Detail |
public void characters(char[] ch, int start, int length) throws com.esri.xml.sax.SAXException
By default, does nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).
The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
Note that some parsers will report whitespace in element
content using the ignorableWhitespace
method rather than this one (validating parsers must
do so).
characters
in interface com.esri.xml.sax.ContentHandler
ch
- the characters from the XML document.start
- the start position in the array.length
- the number of characters to read from the array.
com.esri.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.ignorableWhitespace(char[], int, int)
,
Locator
public void endDocument() throws com.esri.xml.sax.SAXException
By default, does nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as finalising a tree or closing an output file).
The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.
endDocument
in interface com.esri.xml.sax.ContentHandler
com.esri.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.startDocument()
public void endElement(String uri, String localName, String qName) throws com.esri.xml.sax.SAXException
By default, does nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).
The SAX parser will invoke this method at the end of every
element in the XML document; there will be a corresponding
startElement
event for every endElement
event (even when the element is empty).
For information on the names, see startElement
.
endElement
in interface com.esri.xml.sax.ContentHandler
uri
- the Namespace URI, or the empty string if the
element has no Namespace URI, or if Namespace
processing is not being performed.localName
- the local name (without prefix), or the
empty string if Namespace processing is not being
performed.qName
- the qualified XML 1.0 name (with prefix), or the
empty string if qualified names are not available.
com.esri.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.public void endPrefixMapping(String prefix) throws com.esri.xml.sax.SAXException
By default, does nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).
See startPrefixMapping
for
details. This event will always occur after the corresponding
endElement
event, but the order of
endPrefixMapping
events is not otherwise
guaranteed.
endPrefixMapping
in interface com.esri.xml.sax.ContentHandler
prefix
- the prefix that was being mapping.
com.esri.xml.sax.SAXException
- The client may throw
an exception during processing.startPrefixMapping(java.lang.String, java.lang.String)
,
endElement(java.lang.String, java.lang.String, java.lang.String)
public void ignorableWhitespace(char[] ch, int start, int length) throws com.esri.xml.sax.SAXException
By default, does nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).
Validating Parsers must use this method to report each chunk of whitespace in element content (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.
SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
ignorableWhitespace
in interface com.esri.xml.sax.ContentHandler
ch
- the characters from the XML document.start
- the start position in the array.length
- the number of characters to read from the array.
com.esri.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.characters(char[], int, int)
public void processingInstruction(String target, String data) throws com.esri.xml.sax.SAXException
By default, does nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).
The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.
A SAX parser must never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.
processingInstruction
in interface com.esri.xml.sax.ContentHandler
target
- the processing instruction target.data
- the processing instruction data, or null if
none was supplied. The data does not include any
whitespace separating it from the target.
com.esri.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.public void setDocumentLocator(com.esri.xml.sax.Locator locator)
By default, does nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).
SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface.
The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.
Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.
setDocumentLocator
in interface com.esri.xml.sax.ContentHandler
locator
- An object that can return the location of
any SAX document event.Locator
public void skippedEntity(String name) throws com.esri.xml.sax.SAXException
By default, does nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).
The Parser will invoke this method once for each entity
skipped. Non-validating processors may skip entities if they
have not seen the declarations (because, for example, the
entity was declared in an external DTD subset). All processors
may skip external entities, depending on the values of the
http://xml.org/sax/features/external-general-entities
and the
http://xml.org/sax/features/external-parameter-entities
properties.
skippedEntity
in interface com.esri.xml.sax.ContentHandler
name
- the name of the skipped entity. If it is a
parameter entity, the name will begin with '%', and if
it is the external DTD subset, it will be the string
"[dtd]".
com.esri.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.public void startDocument() throws com.esri.xml.sax.SAXException
By default, does nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).
The SAX parser will invoke this method only once, before any
other methods in this interface or in DTDHandler
(except for setDocumentLocator
).
startDocument
in interface com.esri.xml.sax.ContentHandler
com.esri.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.endDocument()
public void startElement(String uri, String localName, String qName, com.esri.xml.sax.Attributes atts) throws com.esri.xml.sax.SAXException
By default, does nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).
The Parser will invoke this method at the beginning of every
element in the XML document; there will be a corresponding
endElement
event for every startElement event
(even when the element is empty). All of the element's content will be
reported, in order, before the corresponding endElement
event.
This event allows up to three name components for each element:
Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:
Note that the attribute list provided will contain only
attributes with explicit values (specified or defaulted):
#IMPLIED attributes will be omitted. The attribute list
will contain attributes used for Namespace declarations
(xmlns* attributes) only if the
http://xml.org/sax/features/namespace-prefixes
property is true (it is false by default, and support for a
true value is optional).
startElement
in interface com.esri.xml.sax.ContentHandler
uri
- the Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performed.localName
- the local name (without prefix), or the
empty string if Namespace processing is not being
performed.qName
- the qualified name (with prefix), or the
empty string if qualified names are not available.atts
- the attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object.
com.esri.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.endElement(java.lang.String, java.lang.String, java.lang.String)
,
Attributes
public void startPrefixMapping(String prefix, String uri) throws com.esri.xml.sax.SAXException
By default, does nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).
The information from this event is not necessary for
normal Namespace processing: the SAX XML reader will
automatically replace prefixes for element and attribute
names when the http://xml.org/sax/features/namespaces
feature is true (the default).
There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary.
Note that start/endPrefixMapping events are not
guaranteed to be properly nested relative to each-other:
all startPrefixMapping events will occur before the
corresponding startElement
event,
and all endPrefixMapping
events will occur after the corresponding endElement
event, but their order is not otherwise
guaranteed.
There should never be start/endPrefixMapping events for the "xml" prefix, since it is predeclared and immutable.
startPrefixMapping
in interface com.esri.xml.sax.ContentHandler
prefix
- the Namespace prefix being declared.uri
- the Namespace URI the prefix is mapped to.
com.esri.xml.sax.SAXException
- The client may throw
an exception during processing.endPrefixMapping(java.lang.String)
,
startElement(java.lang.String, java.lang.String, java.lang.String, com.esri.xml.sax.Attributes)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |