|
Xerces 2.0.0.alpha | ||||||||
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.XMLDocumentParser
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 org.apache.xerces.impl.validation.DatatypeValidatorFactory |
fDatatypeValidatorFactory
Datatype validator factory. |
protected org.apache.xerces.impl.XMLDTDScanner |
fDTDScanner
DTD scanner. |
protected org.apache.xerces.impl.validation.GrammarPool |
fGrammarPool
Grammar pool. |
protected boolean |
fParseInProgress
True if a parse is in progress. |
protected org.apache.xerces.impl.XMLDocumentScanner |
fScanner
Document scanner. |
protected org.apache.xerces.impl.XMLValidator |
fValidator
Validator. |
Fields inherited from class org.apache.xerces.parsers.XMLParser |
fEntityManager, fErrorReporter, fFeatures, fLocator, fProperties, fSymbolTable |
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, TYPE_ANY, TYPE_CHILDREN, TYPE_EMPTY, TYPE_MIXED |
Constructor Summary | |
protected |
XMLDocumentParser()
Default Constructor. |
protected |
XMLDocumentParser(org.apache.xerces.util.SymbolTable symbolTable,
org.apache.xerces.impl.validation.GrammarPool grammarPool)
Constructor allowing to specify the SymbolTable and GrammarPool to use |
Method Summary | |
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. |
protected void |
checkFeature(java.lang.String featureId)
Check a feature. |
protected void |
checkProperty(java.lang.String propertyId)
Check a property. |
void |
childrenElement(java.lang.String elementName)
A referenced element in a children content model. |
void |
childrenEndGroup()
The end of a children group. |
void |
childrenOccurrence(short occurrence)
The occurrence count for a child in a children content model. |
void |
childrenSeparator(short separator)
The separator between choices or sequences of a children content model. |
void |
childrenStartGroup()
The start of a children group. |
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 |
elementDecl(java.lang.String name,
java.lang.String contentModel)
An element declaration. |
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()
The end of a 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 |
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)
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 |
mixedElement(java.lang.String elementName)
A referenced element in a mixed content model. |
void |
notationDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
A notation declaration |
void |
parse(InputSource source)
Parses the specified input source. |
void |
processingInstruction(java.lang.String target,
org.apache.xerces.xni.XMLString data)
A processing instruction. |
protected void |
reset()
Reset all components before parsing. |
void |
setFeature(java.lang.String featureId,
boolean state)
setFeature |
void |
setProperty(java.lang.String propertyId,
java.lang.Object value)
setProperty |
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,
short type)
The start of a content model. |
void |
startDocument()
The start of the document. |
void |
startDTD()
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 encoding)
This method notifies of the start of an entity. |
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 |
getEntityResolver, getErrorHandler, getFeature, getProperty, parse, setEntityResolver, setErrorHandler, setLocale |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected org.apache.xerces.impl.validation.GrammarPool fGrammarPool
protected org.apache.xerces.impl.validation.DatatypeValidatorFactory fDatatypeValidatorFactory
protected org.apache.xerces.impl.XMLDocumentScanner fScanner
protected org.apache.xerces.impl.XMLDTDScanner fDTDScanner
protected org.apache.xerces.impl.XMLValidator fValidator
protected boolean fParseInProgress
Constructor Detail |
protected XMLDocumentParser()
protected XMLDocumentParser(org.apache.xerces.util.SymbolTable symbolTable, org.apache.xerces.impl.validation.GrammarPool grammarPool)
symbolTable
- grammarPool
- Method Detail |
protected void reset() throws SAXException
reset
in class XMLParser
SAXException
- Thrown if an error occurs during initialization.public void setFeature(java.lang.String featureId, boolean state) throws SAXNotRecognizedException, SAXNotSupportedException
setFeature
in class XMLParser
featureId
- state
- public void setProperty(java.lang.String propertyId, java.lang.Object value) throws SAXNotRecognizedException, SAXNotSupportedException
setProperty
in class XMLParser
propertyId
- value
- public void parse(InputSource source) throws SAXException, java.io.IOException
parse
in class XMLParser
source
- The input source.SAXException
- Throws exception on SAX error.java.io.IOException
- Throws exception on i/o error.public void startDocument() throws SAXException
startDocument
in interface org.apache.xerces.xni.XMLDocumentHandler
SAXException
- Thrown by handler to signal an error.public void xmlDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone) throws SAXException
xmlDecl
in interface org.apache.xerces.xni.XMLDocumentHandler
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.SAXException
- Thrown by handler to signal an error.public void doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.String systemId) throws SAXException
doctypeDecl
in interface org.apache.xerces.xni.XMLDocumentHandler
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.SAXException
- Thrown by handler to signal an error.public void startPrefixMapping(java.lang.String prefix, java.lang.String uri) throws SAXException
startPrefixMapping
in interface org.apache.xerces.xni.XMLDocumentHandler
prefix
- The namespace prefix.uri
- The URI bound to the prefix.SAXException
- Thrown by handler to signal an error.public void startElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes) throws SAXException
startElement
in interface org.apache.xerces.xni.XMLDocumentHandler
element
- The name of the element.attributes
- The element attributes.SAXException
- Thrown by handler to signal an error.public void characters(org.apache.xerces.xni.XMLString text) throws SAXException
characters
in interface org.apache.xerces.xni.XMLDocumentHandler
text
- The content.SAXException
- Thrown by handler to signal an error.public void ignorableWhitespace(org.apache.xerces.xni.XMLString text) throws SAXException
ignorableWhitespace
in interface org.apache.xerces.xni.XMLDocumentHandler
text
- The ignorable whitespace.SAXException
- Thrown by handler to signal an error.public void endElement(org.apache.xerces.xni.QName element) throws SAXException
endElement
in interface org.apache.xerces.xni.XMLDocumentHandler
element
- The name of the element.SAXException
- Thrown by handler to signal an error.public void endPrefixMapping(java.lang.String prefix) throws SAXException
endPrefixMapping
in interface org.apache.xerces.xni.XMLDocumentHandler
prefix
- The namespace prefix.SAXException
- Thrown by handler to signal an error.public void startCDATA() throws SAXException
startCDATA
in interface org.apache.xerces.xni.XMLDocumentHandler
SAXException
- Thrown by handler to signal an error.public void endCDATA() throws SAXException
endCDATA
in interface org.apache.xerces.xni.XMLDocumentHandler
SAXException
- Thrown by handler to signal an error.public void endDocument() throws SAXException
endDocument
in interface org.apache.xerces.xni.XMLDocumentHandler
SAXException
- Thrown by handler to signal an error.public void startEntity(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String encoding) throws SAXException
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 SAX 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.
startEntity
in interface org.apache.xerces.xni.XMLDocumentHandler
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.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).SAXException
- Thrown by handler to signal an error.public void textDecl(java.lang.String version, java.lang.String encoding) throws SAXException
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.
textDecl
in interface org.apache.xerces.xni.XMLDocumentHandler
version
- The XML version, or null if not specified.encoding
- The IANA encoding name of the entity.SAXException
- Thrown by handler to signal an error.public void comment(org.apache.xerces.xni.XMLString text) throws SAXException
comment
in interface org.apache.xerces.xni.XMLDocumentHandler
text
- The text in the comment.SAXException
- Thrown by application to signal an error.public void processingInstruction(java.lang.String target, org.apache.xerces.xni.XMLString data) throws SAXException
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.
processingInstruction
in interface org.apache.xerces.xni.XMLDocumentHandler
target
- The target.data
- The data or null if none specified.SAXException
- Thrown by handler to signal an error.public void endEntity(java.lang.String name) throws SAXException
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 SAX 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.
endEntity
in interface org.apache.xerces.xni.XMLDocumentHandler
name
- The name of the entity.SAXException
- Thrown by handler to signal an error.public void startDTD() throws SAXException
startDTD
in interface org.apache.xerces.xni.XMLDTDHandler
SAXException
- Thrown by handler to signal an error.public void elementDecl(java.lang.String name, java.lang.String contentModel) throws SAXException
elementDecl
in interface org.apache.xerces.xni.XMLDTDHandler
name
- The name of the element.contentModel
- The element content model.SAXException
- Thrown by handler to signal an error.public void startAttlist(java.lang.String elementName) throws SAXException
startAttlist
in interface org.apache.xerces.xni.XMLDTDHandler
elementName
- The name of the element that this attribute
list is associated with.SAXException
- Thrown by handler to signal an error.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 SAXException
attributeDecl
in interface org.apache.xerces.xni.XMLDTDHandler
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.SAXException
- Thrown by handler to signal an error.public void endAttlist() throws SAXException
endAttlist
in interface org.apache.xerces.xni.XMLDTDHandler
SAXException
- Thrown by handler to signal an error.public void internalEntityDecl(java.lang.String name, org.apache.xerces.xni.XMLString text) throws SAXException
internalEntityDecl
in interface org.apache.xerces.xni.XMLDTDHandler
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.SAXException
- Thrown by handler to signal an error.public void externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws SAXException
externalEntityDecl
in interface org.apache.xerces.xni.XMLDTDHandler
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.SAXException
- Thrown by handler to signal an error.public void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notation) throws SAXException
unparsedEntityDecl
in interface org.apache.xerces.xni.XMLDTDHandler
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.SAXException
- Thrown by handler to signal an error.public void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws SAXException
notationDecl
in interface org.apache.xerces.xni.XMLDTDHandler
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.SAXException
- Thrown by handler to signal an error.public void startConditional(short type) throws SAXException
startConditional
in interface org.apache.xerces.xni.XMLDTDHandler
type
- The type of the conditional section. This value will
either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE.SAXException
- Thrown by handler to signal an error.CONDITIONAL_INCLUDE
,
CONDITIONAL_IGNORE
public void endConditional() throws SAXException
endConditional
in interface org.apache.xerces.xni.XMLDTDHandler
SAXException
- Thrown by handler to signal an error.public void endDTD() throws SAXException
endDTD
in interface org.apache.xerces.xni.XMLDTDHandler
SAXException
- Thrown by handler to signal an error.public void startContentModel(java.lang.String elementName, short type) throws SAXException
startContentModel
in interface org.apache.xerces.xni.XMLDTDContentModelHandler
elementName
- The name of the element.type
- The content model type.SAXException
- Thrown by handler to signal an error.TYPE_EMPTY
,
TYPE_ANY
,
TYPE_MIXED
,
TYPE_CHILDREN
public void mixedElement(java.lang.String elementName) throws SAXException
Note: This method is only called after a call to the startContentModel method where the type is TYPE_MIXED.
mixedElement
in interface org.apache.xerces.xni.XMLDTDContentModelHandler
elementName
- The name of the referenced element.SAXException
- Thrown by handler to signal an error.TYPE_MIXED
public void childrenStartGroup() throws SAXException
Note: This method is only called after a call to the startContentModel method where the type is TYPE_CHILDREN.
Note: Children groups can be nested and have associated occurrence counts.
childrenStartGroup
in interface org.apache.xerces.xni.XMLDTDContentModelHandler
SAXException
- Thrown by handler to signal an error.TYPE_CHILDREN
public void childrenElement(java.lang.String elementName) throws SAXException
childrenElement
in interface org.apache.xerces.xni.XMLDTDContentModelHandler
elementName
- The name of the referenced element.SAXException
- Thrown by handler to signal an error.TYPE_CHILDREN
public void childrenSeparator(short separator) throws SAXException
Note: This method is only called after a call to the startContentModel method where the type is TYPE_CHILDREN.
childrenSeparator
in interface org.apache.xerces.xni.XMLDTDContentModelHandler
separator
- The type of children separator.SAXException
- Thrown by handler to signal an error.SEPARATOR_CHOICE
,
SEPARATOR_SEQUENCE
,
TYPE_CHILDREN
public void childrenOccurrence(short occurrence) throws SAXException
Note: This method is only called after a call to the startContentModel method where the type is TYPE_CHILDREN.
childrenOccurrence
in interface org.apache.xerces.xni.XMLDTDContentModelHandler
occurrence
- The occurrence count for the last children element
or children group.SAXException
- Thrown by handler to signal an error.OCCURS_ZERO_OR_ONE
,
OCCURS_ZERO_OR_MORE
,
OCCURS_ONE_OR_MORE
,
TYPE_CHILDREN
public void childrenEndGroup() throws SAXException
Note: This method is only called after a call to the startContentModel method where the type is TYPE_CHILDREN.
childrenEndGroup
in interface org.apache.xerces.xni.XMLDTDContentModelHandler
TYPE_CHILDREN
public void endContentModel() throws SAXException
endContentModel
in interface org.apache.xerces.xni.XMLDTDContentModelHandler
SAXException
- Thrown by handler to signal an error.protected void checkFeature(java.lang.String featureId) throws SAXNotRecognizedException, SAXNotSupportedException
checkFeature
in class XMLParser
featureId
- The unique identifier (URI) of the feature.SAXNotRecognizedException
- If the
requested feature is not known.SAXNotSupportedException
- If the
requested feature is known, but the requested
state is not supported.SAXException
- If there is any other
problem fulfilling the request.protected void checkProperty(java.lang.String propertyId) throws SAXNotRecognizedException, SAXNotSupportedException
checkProperty
in class XMLParser
propertyId
- The unique identifier (URI) of the property
being set.SAXNotRecognizedException
- If the
requested property is not known.SAXNotSupportedException
- If the
requested property is known, but the requested
value is not supported.SAXException
- If there is any other
problem fulfilling the request.
|
Xerces 2.0.0.alpha | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |