|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xerces.parsers.XMLParser | +--org.apache.xerces.parsers.AbstractXMLDocumentParser
This is the base class for all XML document parsers. XMLDocumentParser provides a common implementation shared by the various document parsers in the Xerces package. While this class is provided for convenience, it does not prevent other kinds of parsers to be constructed using the XNI interfaces.
Field Summary | |
protected boolean |
fInDTD
True if inside DTD. |
Fields inherited from class org.apache.xerces.parsers.XMLParser |
ENTITY_RESOLVER,
ERROR_HANDLER,
fConfiguration |
Fields inherited from interface org.apache.xerces.xni.XMLDTDHandler |
CONDITIONAL_IGNORE,
CONDITIONAL_INCLUDE |
Fields inherited from interface org.apache.xerces.xni.XMLDTDContentModelHandler |
OCCURS_ONE_OR_MORE,
OCCURS_ZERO_OR_MORE,
OCCURS_ZERO_OR_ONE,
SEPARATOR_CHOICE,
SEPARATOR_SEQUENCE |
Constructor Summary | |
protected |
AbstractXMLDocumentParser(org.apache.xerces.xni.parser.XMLParserConfiguration config)
Constructs a document parser using the default symbol table and grammar pool. |
Method Summary | |
void |
any()
ANY. |
void |
attributeDecl(java.lang.String elementName,
java.lang.String attributeName,
java.lang.String type,
java.lang.String[] enumeration,
java.lang.String defaultType,
org.apache.xerces.xni.XMLString defaultValue)
An attribute declaration. |
void |
characters(org.apache.xerces.xni.XMLString text)
Character content. |
void |
comment(org.apache.xerces.xni.XMLString text)
A comment. |
void |
doctypeDecl(java.lang.String rootElement,
java.lang.String publicId,
java.lang.String systemId)
Notifies of the presence of the DOCTYPE line in the document. |
void |
element(java.lang.String elementName)
Element. |
void |
elementDecl(java.lang.String name,
java.lang.String contentModel)
An element declaration. |
void |
empty()
EMPTY. |
void |
emptyElement(org.apache.xerces.xni.QName element,
org.apache.xerces.xni.XMLAttributes attributes)
An empty element. |
void |
endAttlist()
The end of an attribute list. |
void |
endCDATA()
The end of a CDATA section. |
void |
endConditional()
The end of a conditional section. |
void |
endContentModel()
End content model. |
void |
endDocument()
The end of the document. |
void |
endDTD()
The end of the DTD. |
void |
endElement(org.apache.xerces.xni.QName element)
The end of an element. |
void |
endEntity(java.lang.String name)
This method notifies the end of an entity. |
void |
endGroup()
End group. |
void |
endPrefixMapping(java.lang.String prefix)
The end of a namespace prefix mapping. |
void |
externalEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String baseSystemId)
An external entity declaration. |
void |
ignorableWhitespace(org.apache.xerces.xni.XMLString text)
Ignorable whitespace. |
void |
internalEntityDecl(java.lang.String name,
org.apache.xerces.xni.XMLString text)
An internal entity declaration. |
void |
notationDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
A notation declaration |
void |
occurrence(short occurrence)
Occurrence. |
void |
pcdata()
#PCDATA. |
void |
processingInstruction(java.lang.String target,
org.apache.xerces.xni.XMLString data)
A processing instruction. |
protected void |
reset()
reset all components before parsing |
void |
separator(short separator)
Separator. |
void |
startAttlist(java.lang.String elementName)
The start of an attribute list. |
void |
startCDATA()
The start of a CDATA section. |
void |
startConditional(short type)
The start of a conditional section. |
void |
startContentModel(java.lang.String elementName)
Start content model. |
void |
startDocument(org.apache.xerces.xni.XMLLocator locator,
java.lang.String encoding)
The start of the document. |
void |
startDTD(org.apache.xerces.xni.XMLLocator locator)
The start of the DTD. |
void |
startElement(org.apache.xerces.xni.QName element,
org.apache.xerces.xni.XMLAttributes attributes)
The start of an element. |
void |
startEntity(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String baseSystemId,
java.lang.String encoding)
This method notifies of the start of an entity. |
void |
startGroup()
Start group. |
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
The start of a namespace prefix mapping. |
void |
textDecl(java.lang.String version,
java.lang.String encoding)
Notifies of the presence of a TextDecl line in an entity. |
void |
unparsedEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String notation)
An unparsed entity declaration. |
void |
xmlDecl(java.lang.String version,
java.lang.String encoding,
java.lang.String standalone)
Notifies of the presence of an XMLDecl line in the document. |
Methods inherited from class org.apache.xerces.parsers.XMLParser |
parse |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
protected boolean fInDTD
Constructor Detail |
protected AbstractXMLDocumentParser(org.apache.xerces.xni.parser.XMLParserConfiguration config)
Method Detail |
public void startDocument(org.apache.xerces.xni.XMLLocator locator, java.lang.String encoding) throws org.apache.xerces.xni.XNIException
systemId
- The system identifier of the entity if the entity
is external, null otherwise.encoding
- The auto-detected IANA encoding name of the entity
stream. This value will be null in those situations
where the entity encoding is not auto-detected (e.g.
internal entities or a document entity that is
parsed from a java.io.Reader).public void xmlDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone) throws org.apache.xerces.xni.XNIException
version
- The XML version.encoding
- The IANA encoding name of the document, or null if
not specified.standalone
- The standalone value, or null if not specified.public void doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.String systemId) throws org.apache.xerces.xni.XNIException
rootElement
- The name of the root element.publicId
- The public identifier if an external DTD or null
if the external DTD is specified using SYSTEM.systemId
- The system identifier if an external DTD, null
otherwise.public void startPrefixMapping(java.lang.String prefix, java.lang.String uri) throws org.apache.xerces.xni.XNIException
prefix
- The namespace prefix.uri
- The URI bound to the prefix.public void startElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes) throws org.apache.xerces.xni.XNIException
element
- The name of the element.attributes
- The element attributes.public void emptyElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes) throws org.apache.xerces.xni.XNIException
element
- The name of the element.attributes
- The element attributes.public void characters(org.apache.xerces.xni.XMLString text) throws org.apache.xerces.xni.XNIException
text
- The content.public void ignorableWhitespace(org.apache.xerces.xni.XMLString text) throws org.apache.xerces.xni.XNIException
text
- The ignorable whitespace.public void endElement(org.apache.xerces.xni.QName element) throws org.apache.xerces.xni.XNIException
element
- The name of the element.public void endPrefixMapping(java.lang.String prefix) throws org.apache.xerces.xni.XNIException
prefix
- The namespace prefix.public void startCDATA() throws org.apache.xerces.xni.XNIException
public void endCDATA() throws org.apache.xerces.xni.XNIException
public void endDocument() throws org.apache.xerces.xni.XNIException
public void startEntity(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId, java.lang.String encoding) throws org.apache.xerces.xni.XNIException
Note: Since the document is an entity, the handler will be notified of the start of the document entity by calling the startEntity method with the entity name "[xml]" before calling the startDocument method. When exposing entity boundaries through the XNI API, the document entity is never reported, however.
Note: Since the DTD is an entity, the handler will be notified of the start of the DTD entity by calling the startEntity method with the entity name "[dtd]" before calling the startDTD method.
Note: This method is not called for entity references appearing as part of attribute values.
name
- The name of the entity.publicId
- The public identifier of the entity if the entity
is external, null otherwise.systemId
- The system identifier of the entity if the entity
is external, null otherwise.baseSystemId
- The base system identifier of the entity if
the entity is external, null otherwise.encoding
- The auto-detected IANA encoding name of the entity
stream. This value will be null in those situations
where the entity encoding is not auto-detected (e.g.
internal parameter entities).public void textDecl(java.lang.String version, java.lang.String encoding) throws org.apache.xerces.xni.XNIException
Note: This method will never be called for the document entity; it is only called for external general entities referenced in document content.
Note: This method is not called for entity references appearing as part of attribute values.
version
- The XML version, or null if not specified.encoding
- The IANA encoding name of the entity.public void comment(org.apache.xerces.xni.XMLString text) throws org.apache.xerces.xni.XNIException
text
- The text in the comment.public void processingInstruction(java.lang.String target, org.apache.xerces.xni.XMLString data) throws org.apache.xerces.xni.XNIException
Typically, a processing instruction's data will contain a series of pseudo-attributes. These pseudo-attributes follow the form of element attributes but are not parsed or presented to the application as anything other than text. The application is responsible for parsing the data.
target
- The target.data
- The data or null if none specified.public void endEntity(java.lang.String name) throws org.apache.xerces.xni.XNIException
Note: Since the document is an entity, the handler will be notified of the end of the document entity by calling the endEntity method with the entity name "[xml]" after calling the endDocument method. When exposing entity boundaries through the XNI API, the document entity is never reported, however.
Note: Since the DTD is an entity, the handler will be notified of the end of the DTD entity by calling the endEntity method with the entity name "[dtd]" after calling the endDTD method.
Note: This method is not called for entity references appearing as part of attribute values.
name
- The name of the entity.public void startDTD(org.apache.xerces.xni.XMLLocator locator) throws org.apache.xerces.xni.XNIException
public void elementDecl(java.lang.String name, java.lang.String contentModel) throws org.apache.xerces.xni.XNIException
name
- The name of the element.contentModel
- The element content model.public void startAttlist(java.lang.String elementName) throws org.apache.xerces.xni.XNIException
elementName
- The name of the element that this attribute
list is associated with.public void attributeDecl(java.lang.String elementName, java.lang.String attributeName, java.lang.String type, java.lang.String[] enumeration, java.lang.String defaultType, org.apache.xerces.xni.XMLString defaultValue) throws org.apache.xerces.xni.XNIException
elementName
- The name of the element that this attribute
is associated with.attributeName
- The name of the attribute.type
- The attribute type. This value will be one of
the following: "CDATA", "ENTITY", "ENTITIES",
"ENUMERATION", "ID", "IDREF", "IDREFS",
"NMTOKEN", "NMTOKENS", or "NOTATION".enumeration
- If the type has the value "ENUMERATION", this
array holds the allowed attribute values;
otherwise, this array is null.defaultType
- The attribute default type. This value will be
one of the following: "#FIXED", "#IMPLIED",
"#REQUIRED", or null.defaultValue
- The attribute default value, or null if no
default value is specified.public void endAttlist() throws org.apache.xerces.xni.XNIException
public void internalEntityDecl(java.lang.String name, org.apache.xerces.xni.XMLString text) throws org.apache.xerces.xni.XNIException
name
- The name of the entity. Parameter entity names start with
'%', whereas the name of a general entity is just the
entity name.text
- The value of the entity.public void externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId) throws org.apache.xerces.xni.XNIException
name
- The name of the entity. Parameter entity names start
with '%', whereas the name of a general entity is just
the entity name.publicId
- The public identifier of the entity or null if the
the entity was specified with SYSTEM.systemId
- The system identifier of the entity.baseSystemId
- The base system identifier where this entity
is declared.public void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notation) throws org.apache.xerces.xni.XNIException
name
- The name of the entity.publicId
- The public identifier of the entity, or null if not
specified.systemId
- The system identifier of the entity, or null if not
specified.notation
- The name of the notation.public void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws org.apache.xerces.xni.XNIException
name
- The name of the notation.publicId
- The public identifier of the notation, or null if not
specified.systemId
- The system identifier of the notation, or null if not
specified.public void startConditional(short type) throws org.apache.xerces.xni.XNIException
type
- The type of the conditional section. This value will
either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE.CONDITIONAL_INCLUDE
,
CONDITIONAL_IGNORE
public void endConditional() throws org.apache.xerces.xni.XNIException
public void endDTD() throws org.apache.xerces.xni.XNIException
public void startContentModel(java.lang.String elementName) throws org.apache.xerces.xni.XNIException
elementName
- The name of the element.public void any() throws org.apache.xerces.xni.XNIException
XMLDTDContentModelHandler.empty()
,
XMLDTDContentModelHandler.startGroup()
public void empty() throws org.apache.xerces.xni.XNIException
XMLDTDContentModelHandler.any()
,
XMLDTDContentModelHandler.startGroup()
public void startGroup() throws org.apache.xerces.xni.XNIException
XMLDTDContentModelHandler.any()
,
XMLDTDContentModelHandler.empty()
public void pcdata() throws org.apache.xerces.xni.XNIException
XMLDTDContentModelHandler.startGroup()
public void element(java.lang.String elementName) throws org.apache.xerces.xni.XNIException
elementName
- The name of the referenced element.public void separator(short separator) throws org.apache.xerces.xni.XNIException
separator
- The type of children separator.XMLDTDContentModelHandler.SEPARATOR_CHOICE
,
XMLDTDContentModelHandler.SEPARATOR_SEQUENCE
public void occurrence(short occurrence) throws org.apache.xerces.xni.XNIException
occurrence
- The occurrence count for the last element
or group.XMLDTDContentModelHandler.OCCURS_ZERO_OR_ONE
,
XMLDTDContentModelHandler.OCCURS_ZERO_OR_MORE
,
XMLDTDContentModelHandler.OCCURS_ONE_OR_MORE
public void endGroup() throws org.apache.xerces.xni.XNIException
public void endContentModel() throws org.apache.xerces.xni.XNIException
protected void reset() throws org.apache.xerces.xni.XNIException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |