|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.enhydra.apache.xerces.framework.XMLParser | +--org.enhydra.apache.xerces.parsers.DOMParser
DOMParser provides a parser which produces a W3C DOM tree as its output
Inner classes inherited from class org.enhydra.apache.xerces.framework.XMLDocumentHandler |
XMLDocumentHandler.DTDHandler |
Field Summary | |
static String |
DEFAULT_DEFERRED_DOCUMENT_CLASS_NAME
Default deferred document class name (org.enhydra.apache.xerces.dom.DeferredDocumentImpl). |
static String |
DEFAULT_DOCUMENT_CLASS_NAME
Default programmatic document class name (org.enhydra.apache.xerces.dom.DocumentImpl). |
protected int |
fAmpIndex
|
protected int |
fAposIndex
|
protected Node |
fCurrentElementNode
|
protected int |
fCurrentEntityName
|
protected int |
fCurrentEntityNode
|
protected int |
fCurrentNodeIndex
|
protected DeferredDocumentImpl |
fDeferredDocumentImpl
|
protected Document |
fDocument
|
protected DocumentImpl |
fDocumentImpl
|
protected int |
fDocumentIndex
|
protected DocumentType |
fDocumentType
|
protected int |
fDocumentTypeIndex
|
protected int |
fGtIndex
|
protected boolean |
fInCDATA
|
protected boolean |
fInDTD
|
protected int |
fLtIndex
|
protected int |
fQuotIndex
|
protected boolean |
fWithinElement
|
Fields inherited from class org.enhydra.apache.xerces.framework.XMLParser |
fEntityHandler, fErrorReporter, fGrammarResolver, fParseInProgress, fScanner, fStringPool, fValidator, SAX2_FEATURES_PREFIX, SAX2_PROPERTIES_PREFIX, XERCES_FEATURES_PREFIX, XERCES_PROPERTIES_PREFIX |
Fields inherited from interface org.enhydra.apache.xerces.framework.XMLErrorReporter |
ERRORTYPE_FATAL_ERROR, ERRORTYPE_RECOVERABLE_ERROR, ERRORTYPE_WARNING |
Constructor Summary | |
DOMParser()
Default constructor. |
Method Summary | |
void |
attlistDecl(QName elementDecl,
QName attributeDecl,
int attType,
boolean attList,
String enumString,
int attDefaultType,
int attDefaultValue)
<!ATTLIST Name AttDef> |
void |
characters(char[] ch,
int start,
int length)
callback for characters. |
void |
characters(int dataIndex)
Characters. |
void |
comment(int dataIndex)
Comment. |
void |
elementDecl(QName elementDecl,
int contentSpecType,
int contentSpecIndex,
XMLContentSpec.Provider contentSpecProvider)
<!ELEMENT Name contentspec> |
void |
endCDATA()
End CDATA section. |
void |
endDocument()
End document. |
void |
endDTD()
This function will be called at the end of the DTD. |
void |
endElement(QName elementQName)
End element. |
void |
endEntityReference(int entityName,
int entityType,
int entityContext)
End entity reference. |
void |
endNamespaceDeclScope(int prefix)
Report the end of the scope of a namespace declaration. |
void |
externalEntityDecl(int entityNameIndex,
int publicIdIndex,
int systemIdIndex)
<!ENTITY Name ExternalID> (external) |
void |
externalPEDecl(int entityNameIndex,
int publicIdIndex,
int systemIdIndex)
<!ENTITY % Name ExternalID> (external) |
boolean |
getCreateEntityReferenceNodes()
Returns true if entity references within the document are included in the document tree as EntityReference nodes. |
protected Element |
getCurrentElementNode()
Returns the current element node. |
protected boolean |
getDeferNodeExpansion()
Returns true if the expansion of the nodes in the default DOM implementation are deferred. |
Document |
getDocument()
Returns the document. |
protected String |
getDocumentClassName()
Returns the fully qualified class name of the document factory used when constructing the DOM tree. |
boolean |
getFeature(String featureId)
Query the current state of any feature in a SAX2 parser. |
String[] |
getFeaturesRecognized()
Returns a list of features that this parser recognizes. |
boolean |
getIncludeIgnorableWhitespace()
Returns true if ignorable whitespace text nodes are included in the DOM tree. |
String[] |
getPropertiesRecognized()
Returns a list of properties that this parser recognizes. |
Object |
getProperty(String propertyId)
Return the current value of a property in a SAX2 parser. |
void |
ignorableWhitespace(char[] ch,
int start,
int length)
Not called. |
void |
ignorableWhitespace(int dataIndex)
Ignorable whitespace. |
protected void |
init()
Initializes the parser to a pre-parse state. |
void |
internalEntityDecl(int entityNameIndex,
int entityValueIndex)
<!ENTITY Name EntityValue> (internal) |
void |
internalPEDecl(int entityNameIndex,
int entityValueIndex)
<!ENTITY % Name EntityValue> (internal) |
void |
internalSubset(int internalSubset)
Supports DOM Level 2 internalSubset additions. |
void |
notationDecl(int notationNameIndex,
int publicIdIndex,
int systemIdIndex)
<!NOTATION Name ExternalId> |
void |
processingInstruction(int targetIndex,
int dataIndex)
Processing instruction. |
void |
reset()
Resets the parser. |
void |
resetOrCopy()
Resets or copies the parser. |
protected void |
setCreateEntityReferenceNodes(boolean create)
This feature determines whether entity references within the document are included in the document tree as EntityReference nodes. |
protected void |
setDeferNodeExpansion(boolean deferNodeExpansion)
This method sets whether the expansion of the nodes in the default DOM implementation are deferred. |
protected void |
setDocumentClassName(String documentClassName)
This method allows the programmer to decide which document factory to use when constructing the DOM tree. |
void |
setFeature(String featureId,
boolean state)
Set the state of any feature in a SAX2 parser. |
void |
setIncludeIgnorableWhitespace(boolean include)
This feature determines whether text nodes that can be considered "ignorable whitespace" are included in the DOM tree. |
void |
setProperty(String propertyId,
Object value)
Set the value of any property in a SAX2 parser. |
void |
startCDATA()
Start CDATA section. |
void |
startDocument()
Start document. |
void |
startDTD(QName rootElement,
int publicId,
int systemId)
This function will be called when a <!DOCTYPE...> declaration is encountered. |
void |
startElement(QName elementQName,
XMLAttrList xmlAttrList,
int attrListIndex)
Start element. |
void |
startEntityReference(int entityName,
int entityType,
int entityContext)
Start entity reference. |
void |
startNamespaceDeclScope(int prefix,
int uri)
Report the start of the scope of a namespace declaration. |
void |
textDecl(int versionIndex,
int encodingIndex)
Text declaration. |
void |
unparsedEntityDecl(int entityNameIndex,
int publicIdIndex,
int systemIdIndex,
int notationNameIndex)
<!ENTITY Name ExternalID NDataDecl> (unparsed) |
void |
xmlDecl(int versionIndex,
int encodingIndex,
int standaloneIndex)
XML declaration. |
Methods inherited from class java.lang.Object |
|
Field Detail |
public static final String DEFAULT_DOCUMENT_CLASS_NAME
public static final String DEFAULT_DEFERRED_DOCUMENT_CLASS_NAME
protected Document fDocument
protected DeferredDocumentImpl fDeferredDocumentImpl
protected int fDocumentIndex
protected int fDocumentTypeIndex
protected int fCurrentNodeIndex
protected int fCurrentEntityName
protected int fCurrentEntityNode
protected DocumentImpl fDocumentImpl
protected DocumentType fDocumentType
protected Node fCurrentElementNode
protected boolean fInDTD
protected boolean fWithinElement
protected boolean fInCDATA
protected int fAmpIndex
protected int fLtIndex
protected int fGtIndex
protected int fAposIndex
protected int fQuotIndex
Constructor Detail |
public DOMParser()
Method Detail |
public Document getDocument()
public String[] getFeaturesRecognized()
getFeaturesRecognized
in class XMLParser
XMLParser.isFeatureRecognized(java.lang.String)
,
setFeature(java.lang.String, boolean)
,
getFeature(java.lang.String)
public String[] getPropertiesRecognized()
getPropertiesRecognized
in class XMLParser
XMLParser.isPropertyRecognized(java.lang.String)
,
setProperty(java.lang.String, java.lang.Object)
,
getProperty(java.lang.String)
public void reset() throws Exception
reset
in class XMLParser
public void resetOrCopy() throws Exception
resetOrCopy
in class XMLParser
protected void init()
parse()
.protected void setDeferNodeExpansion(boolean deferNodeExpansion) throws SAXNotRecognizedException, SAXNotSupportedException
getDeferNodeExpansion()
,
setDocumentClassName(java.lang.String)
protected boolean getDeferNodeExpansion() throws SAXNotRecognizedException, SAXNotSupportedException
setDeferNodeExpansion(boolean)
protected void setCreateEntityReferenceNodes(boolean create) throws SAXNotRecognizedException, SAXNotSupportedException
Note: The children of the entity reference are always added to the document. This feature only affects whether an EntityReference node is also included as the parent of the entity reference children.
create
- True to create entity reference nodes; false
to only insert the entity reference children.getCreateEntityReferenceNodes()
public boolean getCreateEntityReferenceNodes() throws SAXNotRecognizedException, SAXNotSupportedException
setCreateEntityReferenceNodes(boolean)
public void setIncludeIgnorableWhitespace(boolean include) throws SAXNotRecognizedException, SAXNotSupportedException
Note: The only way that the parser can determine if text is ignorable is by reading the associated grammar and having a content model for the document. When ignorable whitespace text nodes *are* included in the DOM tree, they will be flagged as ignorable. The ignorable flag can be queried by calling the TextImpl#isIgnorableWhitespace():boolean method.
include
- True to include ignorable whitespace text nodes;
false to not include ignorable whitespace text
nodes.getIncludeIgnorableWhitespace()
public boolean getIncludeIgnorableWhitespace() throws SAXNotRecognizedException, SAXNotSupportedException
setIncludeIgnorableWhitespace(boolean)
protected void setDocumentClassName(String documentClassName) throws SAXNotRecognizedException, SAXNotSupportedException
documentClassName
- The fully qualified class name of the
document factory to use when constructing
the DOM tree.getDocumentClassName()
,
setDeferNodeExpansion(boolean)
,
DEFAULT_DOCUMENT_CLASS_NAME
protected String getDocumentClassName() throws SAXNotRecognizedException, SAXNotSupportedException
setDocumentClassName(java.lang.String)
protected Element getCurrentElementNode() throws SAXNotRecognizedException, SAXNotSupportedException
Note: This method is not supported when the "deferNodeExpansion" property is set to true and the document factory is set to the default factory.
public void setFeature(String featureId, boolean state) throws SAXNotRecognizedException, SAXNotSupportedException
setFeature
in class XMLParser
featureId
- The unique identifier (URI) of the feature.state
- The requested state of the feature (true or false).SAXNotRecognizedException
- If the requested feature is
not known.SAXNotSupportedException
- If the requested feature is
known, but the requested state
is not supported.public boolean getFeature(String featureId) throws SAXNotRecognizedException, SAXNotSupportedException
getFeature
in class XMLParser
featureId
- The unique identifier (URI) of the feature
being set.SAXNotRecognizedException
- If the requested feature is
not known.public void setProperty(String propertyId, Object value) throws SAXNotRecognizedException, SAXNotSupportedException
setProperty
in class XMLParser
propertyId
- The unique identifier (URI) of the property
being set.Object
- The value to which the property is being set.SAXNotRecognizedException
- If the requested property is
not known.SAXNotSupportedException
- If the requested property is
known, but the requested
value is not supported.public Object getProperty(String propertyId) throws SAXNotRecognizedException, SAXNotSupportedException
getProperty
in class XMLParser
propertyId
- The unique identifier (URI) of the property
being set.SAXNotRecognizedException
- If the requested property is
not known.Configurable#getProperty
public void startDocument()
startDocument
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
Exception
- public void endDocument() throws Exception
endDocument
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
Exception
- public void xmlDecl(int versionIndex, int encodingIndex, int standaloneIndex) throws Exception
xmlDecl
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
version
- the handle in the string pool for the version numberencoding
- the handle in the string pool for the encodingstandalong
- the handle in the string pool for the standalone valueException
- public void textDecl(int versionIndex, int encodingIndex) throws Exception
textDecl
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
Exception
- public void startNamespaceDeclScope(int prefix, int uri) throws Exception
startNamespaceDeclScope
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
prefix
- string pool index of the namespace prefix being declareduri
- string pool index of the namespace uri begin boundjava.lang.Exception
- public void endNamespaceDeclScope(int prefix) throws Exception
endNamespaceDeclScope
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
prefix
- string pool index of the namespace prefix being declaredException
- public void startElement(QName elementQName, XMLAttrList xmlAttrList, int attrListIndex) throws Exception
startElement
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
elementType
- element handle for the element being scannedattrList
- attrList containing the attributes of the elementattrListHandle
- handle into attrList. Allows attributes to be retreived.Exception
- public void endElement(QName elementQName) throws Exception
endElement
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
elementType
- element handle for the element being scannedException
- public void characters(int dataIndex) throws Exception
characters
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
data
- string pool index of the characters that were scannedException
- public void ignorableWhitespace(int dataIndex) throws Exception
ignorableWhitespace
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
data
- string pool index of ignorable whitespaceException
- public void processingInstruction(int targetIndex, int dataIndex) throws Exception
processingInstruction
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
target
- string pool index of the PI targetdata
- string pool index of the PI dataException
- public void comment(int dataIndex) throws Exception
comment
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
comment
- string pool index of the comment textException
- public void characters(char[] ch, int start, int length) throws Exception
XMLDocumentHandler
characters
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
ch
- character array containing the characters that were scannedstart
- offset in ch where scanned characters beginlength
- length of scanned characters in chException
- public void ignorableWhitespace(char[] ch, int start, int length) throws Exception
ignorableWhitespace
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
ch
- character array containing the whitespace that was scannedstart
- offset in ch where scanned whitespace beginslength
- length of scanned whitespace in chException
- public void startCDATA() throws Exception
startCDATA
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
Exception
- public void endCDATA() throws Exception
endCDATA
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
Exception
- public void startEntityReference(int entityName, int entityType, int entityContext) throws Exception
startEntityReference
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
entityName
- string pool index of the entity nameentityType
- the XMLEntityHandler.ENTITYTYPE_* typeentityContext
- the XMLEntityHandler.ENTITYREF_* type for where
the entity reference appearsException
- XMLEntityHandler
,
XMLEntityHandler
public void endEntityReference(int entityName, int entityType, int entityContext) throws Exception
endEntityReference
in interface XMLDocumentHandler
org.enhydra.apache.xerces.framework.XMLDocumentHandler
entityName
- string pool index of the entity anementityType
- the XMLEntityHandler.ENTITYTYPE_* typeentityContext
- the XMLEntityHandler.ENTITYREF_* type for where
the entity reference appearsException
- XMLEntityHandler
,
XMLEntityHandler
public void startDTD(QName rootElement, int publicId, int systemId) throws Exception
org.enhydra.apache.xerces.framework.XMLDocumentHandler.DTDHandler
rootElementType
- element handle for the root element of the documentpublicId
- string pool index of the DTD's public IDsystemId
- string pool index of the DTD's system IDException
- public void internalSubset(int internalSubset)
public void endDTD() throws Exception
public void elementDecl(QName elementDecl, int contentSpecType, int contentSpecIndex, XMLContentSpec.Provider contentSpecProvider) throws Exception
org.enhydra.apache.xerces.framework.XMLDocumentHandler.DTDHandler
elementType
- element handle of the element being declaredcontentSpec
- contentSpec for the element being declaredException
- XMLContentSpec
public void attlistDecl(QName elementDecl, QName attributeDecl, int attType, boolean attList, String enumString, int attDefaultType, int attDefaultValue) throws Exception
org.enhydra.apache.xerces.framework.XMLDocumentHandler.DTDHandler
elementType
- element handle for the attribute's elementattrName
- string pool index of the attribute nameattType
- type of attributeenumString
- String representing the values of the enumeration,
if the attribute is of enumerated type, or null if it is not.attDefaultType
- an integer value denoting the DefaultDecl valueattDefaultValue
- string pool index of this attribute's default value
or -1 if there is no defaultvalueException
- public void internalPEDecl(int entityNameIndex, int entityValueIndex) throws Exception
org.enhydra.apache.xerces.framework.XMLDocumentHandler.DTDHandler
entityName
- string pool index of the entity nameentityValue
- string pool index of the entity replacement textException
- public void externalPEDecl(int entityNameIndex, int publicIdIndex, int systemIdIndex) throws Exception
org.enhydra.apache.xerces.framework.XMLDocumentHandler.DTDHandler
entityName
- string pool index of the entity namepublicId
- string pool index of the entity's public id.systemId
- string pool index of the entity's system id.Exception
- public void internalEntityDecl(int entityNameIndex, int entityValueIndex) throws Exception
org.enhydra.apache.xerces.framework.XMLDocumentHandler.DTDHandler
entityName
- string pool index of the entity nameentityValue
- string pool index of the entity replacement textException
- public void externalEntityDecl(int entityNameIndex, int publicIdIndex, int systemIdIndex) throws Exception
org.enhydra.apache.xerces.framework.XMLDocumentHandler.DTDHandler
entityName
- string pool index of the entity namepublicId
- string pool index of the entity's public id.systemId
- string pool index of the entity's system id.Exception
- public void unparsedEntityDecl(int entityNameIndex, int publicIdIndex, int systemIdIndex, int notationNameIndex) throws Exception
org.enhydra.apache.xerces.framework.XMLDocumentHandler.DTDHandler
entityName
- string pool index of the entity namepublicId
- string pool index of the entity's public id.systemId
- string pool index of the entity's system id.notationName
- string pool index of the notation name.Exception
- public void notationDecl(int notationNameIndex, int publicIdIndex, int systemIdIndex) throws Exception
org.enhydra.apache.xerces.framework.XMLDocumentHandler.DTDHandler
notationName
- string pool index of the notation namepublicId
- string pool index of the notation's public id.systemId
- string pool index of the notation's system id.Exception
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |