| java.lang.Object
 org.apache.xerces.impl.dtd.XMLDTDProcessor
All known Subclasses: org.apache.xerces.impl.dtd.XMLDTDLoader,
| XMLDTDProcessor | | public class XMLDTDProcessor implements XMLComponent,XMLDTDFilter,XMLDTDContentModelFilter(Code) | | The DTD processor. The processor implements a DTD
filter: receiving DTD events from the DTD scanner; validating
the content and structure; building a grammar, if applicable;
and notifying the DTDHandler of the information resulting from the
process.
This component requires the following features and properties from the
component manager that uses it:
- http://xml.org/sax/features/namespaces
- http://apache.org/xml/properties/internal/symbol-table
- http://apache.org/xml/properties/internal/error-reporter
- http://apache.org/xml/properties/internal/grammar-pool
- http://apache.org/xml/properties/internal/datatype-validator-factory
author:
Neil Graham, IBM
version:
$Id: XMLDTDProcessor.java 572055 2007-09-02 17:55:43Z mrglavas $ |
| Method Summary | |
| public void | any(Augmentations augs)
A content model of ANY. | | public void | attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augs)
An attribute declaration.
Parameters:
elementName - The name of the element that this attributeis associated with.
Parameters:
attributeName - The name of the attribute.
Parameters:
type - The attribute type. | | protected static void | checkStandaloneEntityRef(String name, DTDGrammar grammar, XMLEntityDecl tempEntityDecl, XMLErrorReporter errorReporter)
Check standalone entity reference. | | public void | comment(XMLString text, Augmentations augs)
A comment. | | public void | element(String elementName, Augmentations augs)
A referenced element in a mixed or children content model. | | public void | elementDecl(String name, String contentModel, Augmentations augs)
An element declaration. | | public void | empty(Augmentations augs)
A content model of EMPTY. | | public void | endAttlist(Augmentations augs)
The end of an attribute list. | | public void | endConditional(Augmentations augs)
The end of a conditional section. | | public void | endContentModel(Augmentations augs)
The end of a content model. | | public void | endDTD(Augmentations augs)
The end of the DTD. | | public void | endExternalSubset(Augmentations augs)
The end of the DTD external subset. | | public void | endGroup(Augmentations augs)
The end of a group for mixed or children content models. | | public void | endParameterEntity(String name, Augmentations augs)
This method notifies the end of a parameter entity. | | public void | externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
An external entity declaration.
Parameters:
name - The name of the entity. | | public XMLDTDContentModelHandler | getDTDContentModelHandler()
Gets the DTD content model handler. | | public XMLDTDContentModelSource | getDTDContentModelSource()
| | public XMLDTDHandler | getDTDHandler()
Returns the DTD handler. | | public XMLDTDSource | getDTDSource()
| | public Boolean | getFeatureDefault(String featureId)
Returns the default state for a feature, or null if this
component does not want to report a default value for this
feature. | | public Object | getPropertyDefault(String propertyId)
Returns the default state for a property, or null if this
component does not want to report a default value for this
property. | | public String[] | getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by
this component. | | public String[] | getRecognizedProperties()
Returns a list of property identifiers that are recognized by
this component. | | public void | ignoredCharacters(XMLString text, Augmentations augs)
Characters within an IGNORE conditional section. | | public void | internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augs)
An internal entity declaration.
Parameters:
name - The name of the entity. | | protected boolean | isValidName(String name)
| | protected boolean | isValidNmtoken(String nmtoken)
| | public void | notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
| | public void | occurrence(short occurrence, Augmentations augs)
The occurrence count for a child in a children content model or
for the mixed content model group. | | public void | pcdata(Augmentations augs)
The appearance of "#PCDATA" within a group signifying a
mixed content model. | | public void | processingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction. | | public void | reset(XMLComponentManager componentManager)
| | protected void | reset()
| | public void | separator(short separator, Augmentations augs)
The separator between choices or sequences of a mixed or children
content model. | | public void | setDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler)
Sets the DTD content model handler. | | public void | setDTDContentModelSource(XMLDTDContentModelSource source)
| | public void | setDTDHandler(XMLDTDHandler dtdHandler)
Sets the DTD handler. | | public void | setDTDSource(XMLDTDSource source)
| | public void | setFeature(String featureId, boolean state)
Sets the state of a feature. | | public void | setProperty(String propertyId, Object value)
Sets the value of a property. | | public void | startAttlist(String elementName, Augmentations augs)
The start of an attribute list. | | public void | startConditional(short type, Augmentations augs)
The start of a conditional section.
Parameters:
type - The type of the conditional section. | | public void | startContentModel(String elementName, Augmentations augs)
The start of a content model. | | public void | startDTD(XMLLocator locator, Augmentations augs)
The start of the DTD.
Parameters:
locator - The document locator, or null if the documentlocation cannot be reported during the parsing of the document DTD. | | public void | startExternalSubset(XMLResourceIdentifier identifier, Augmentations augs)
The start of the DTD external subset. | | public void | startGroup(Augmentations augs)
A start of either a mixed or children content model. | | public void | startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies of the start of a parameter entity. | | public void | textDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity. | | public void | unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augs)
An unparsed entity declaration. |
| DTD_VALIDATOR | | final protected static String DTD_VALIDATOR(Code) | | Property identifier: validator .
|
| ERROR_REPORTER | | final protected static String ERROR_REPORTER(Code) | | Property identifier: error reporter.
|
| GRAMMAR_POOL | | final protected static String GRAMMAR_POOL(Code) | | Property identifier: grammar pool.
|
| NOTIFY_CHAR_REFS | | final protected static String NOTIFY_CHAR_REFS(Code) | | Feature identifier: notify character references.
|
| PARSER_SETTINGS | | final protected static String PARSER_SETTINGS(Code) | | |
| SYMBOL_TABLE | | final protected static String SYMBOL_TABLE(Code) | | Property identifier: symbol table.
|
| VALIDATION | | final protected static String VALIDATION(Code) | | Feature identifier: validation.
|
| WARN_ON_DUPLICATE_ATTDEF | | final protected static String WARN_ON_DUPLICATE_ATTDEF(Code) | | Feature identifier: warn on duplicate attdef
|
| WARN_ON_UNDECLARED_ELEMDEF | | final protected static String WARN_ON_UNDECLARED_ELEMDEF(Code) | | Feature identifier: warn on undeclared element referenced in content model.
|
| fDTDValidation | | protected boolean fDTDValidation(Code) | | Validation against only DTD
|
| fInDTDIgnore | | protected boolean fInDTDIgnore(Code) | | True if in an ignore conditional section of the DTD.
|
| fValidation | | protected boolean fValidation(Code) | | Validation.
|
| fWarnDuplicateAttdef | | protected boolean fWarnDuplicateAttdef(Code) | | warn on duplicate attribute definition, this feature works only when validation is true
|
| fWarnOnUndeclaredElemdef | | protected boolean fWarnOnUndeclaredElemdef(Code) | | warn on undeclared element referenced in content model, this feature only works when valiation is true
|
| XMLDTDProcessor | | public XMLDTDProcessor()(Code) | | Default constructor.
|
| attributeDecl | | public void attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augs) throws XNIException(Code) | | An attribute declaration.
Parameters:
elementName - The name of the element that this attributeis associated with.
Parameters:
attributeName - The name of the attribute.
Parameters:
type - The attribute type. This value will be one ofthe following: "CDATA", "ENTITY", "ENTITIES","ENUMERATION", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", or "NOTATION".
Parameters:
enumeration - If the type has the value "ENUMERATION" or"NOTATION", this array holds the allowed attributevalues; otherwise, this array is null.
Parameters:
defaultType - The attribute default type. This value will beone of the following: "#FIXED", "#IMPLIED","#REQUIRED", or null.
Parameters:
defaultValue - The attribute default value, or null if nodefault value is specified.
Parameters:
nonNormalizedDefaultValue - The attribute default value with no normalization performed, or null if no default value is specified.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| checkStandaloneEntityRef | | protected static void checkStandaloneEntityRef(String name, DTDGrammar grammar, XMLEntityDecl tempEntityDecl, XMLErrorReporter errorReporter) throws XNIException(Code) | | Check standalone entity reference.
Made static to make common between the validator and loader.
Parameters:
name -
Parameters:
grammar - grammar to which entity belongs
Parameters:
tempEntityDecl - empty entity declaration to put results in
Parameters:
errorReporter - error reporter to send errors to
throws:
XNIException - Thrown by application to signal an error. |
| comment | | public void comment(XMLString text, Augmentations augs) throws XNIException(Code) | | A comment.
Parameters:
text - The text in the comment.
Parameters:
augs - Additional information that may include infoset augmentations
throws:
XNIException - Thrown by application to signal an error. |
| element | | public void element(String elementName, Augmentations augs) throws XNIException(Code) | | A referenced element in a mixed or children content model.
Parameters:
elementName - The name of the referenced element.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| elementDecl | | public void elementDecl(String name, String contentModel, Augmentations augs) throws XNIException(Code) | | An element declaration.
Parameters:
name - The name of the element.
Parameters:
contentModel - The element content model.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endAttlist | | public void endAttlist(Augmentations augs) throws XNIException(Code) | | The end of an attribute list.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endConditional | | public void endConditional(Augmentations augs) throws XNIException(Code) | | The end of a conditional section.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endContentModel | | public void endContentModel(Augmentations augs) throws XNIException(Code) | | The end of a content model.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endDTD | | public void endDTD(Augmentations augs) throws XNIException(Code) | | The end of the DTD.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endExternalSubset | | public void endExternalSubset(Augmentations augs) throws XNIException(Code) | | The end of the DTD external subset.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endGroup | | public void endGroup(Augmentations augs) throws XNIException(Code) | | The end of a group for mixed or children content models.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endParameterEntity | | public void endParameterEntity(String name, Augmentations augs) throws XNIException(Code) | | This method notifies the end of a parameter entity. Parameter entity
names begin with a '%' character.
Parameters:
name - The name of the parameter entity.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| externalEntityDecl | | public void externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augs) throws XNIException(Code) | | An external entity declaration.
Parameters:
name - The name of the entity. Parameter entity names startwith '%', whereas the name of a general entity is justthe entity name.
Parameters:
identifier - An object containing all location information pertinent to this external entity.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| getDTDContentModelHandler | | public XMLDTDContentModelHandler getDTDContentModelHandler()(Code) | | Gets the DTD content model handler.
dtdContentModelHandler The DTD content model handler. |
| getDTDHandler | | public XMLDTDHandler getDTDHandler()(Code) | | Returns the DTD handler.
The DTD handler. |
| getFeatureDefault | | public Boolean getFeatureDefault(String featureId)(Code) | | Returns the default state for a feature, or null if this
component does not want to report a default value for this
feature.
Parameters:
featureId - The feature identifier.
since:
Xerces 2.2.0 |
| getPropertyDefault | | public Object getPropertyDefault(String propertyId)(Code) | | Returns the default state for a property, or null if this
component does not want to report a default value for this
property.
Parameters:
propertyId - The property identifier.
since:
Xerces 2.2.0 |
| getRecognizedFeatures | | public String[] getRecognizedFeatures()(Code) | | Returns a list of feature identifiers that are recognized by
this component. This method may return null if no features
are recognized by this component.
|
| getRecognizedProperties | | public String[] getRecognizedProperties()(Code) | | Returns a list of property identifiers that are recognized by
this component. This method may return null if no properties
are recognized by this component.
|
| ignoredCharacters | | public void ignoredCharacters(XMLString text, Augmentations augs) throws XNIException(Code) | | Characters within an IGNORE conditional section.
Parameters:
text - The ignored text.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| internalEntityDecl | | public void internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augs) throws XNIException(Code) | | An internal entity declaration.
Parameters:
name - The name of the entity. Parameter entity names start with'%', whereas the name of a general entity is just the entity name.
Parameters:
text - The value of the entity.
Parameters:
nonNormalizedText - The non-normalized value of the entity. Thisvalue contains the same sequence of characters that was in the internal entity declaration, without any entityreferences expanded.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| isValidNmtoken | | protected boolean isValidNmtoken(String nmtoken)(Code) | | |
| notationDecl | | public void notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augs) throws XNIException(Code) | | A notation declaration
Parameters:
name - The name of the notation.
Parameters:
identifier - An object containing all location information pertinent to this notation.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| pcdata | | public void pcdata(Augmentations augs)(Code) | | The appearance of "#PCDATA" within a group signifying a
mixed content model. This method will be the first called
following the content model's startGroup().
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error.
See Also: XMLDTDProcessor.startGroup |
| processingInstruction | | public void processingInstruction(String target, XMLString data, Augmentations augs) throws XNIException(Code) | | A processing instruction. Processing instructions consist of a
target name and, optionally, text data. The data is only meaningful
to the application.
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.
Parameters:
target - The target.
Parameters:
data - The data or null if none specified.
Parameters:
augs - Additional information that may include infoset augmentations
throws:
XNIException - Thrown by handler to signal an error. |
| reset | | protected void reset()(Code) | | |
| setDTDContentModelHandler | | public void setDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler)(Code) | | Sets the DTD content model handler.
Parameters:
dtdContentModelHandler - The DTD content model handler. |
| setDTDHandler | | public void setDTDHandler(XMLDTDHandler dtdHandler)(Code) | | Sets the DTD handler.
Parameters:
dtdHandler - The DTD handler. |
| setFeature | | public void setFeature(String featureId, boolean state) throws XMLConfigurationException(Code) | | Sets the state of a feature. This method is called by the component
manager any time after reset when a feature changes state.
Note: Components should silently ignore features
that do not affect the operation of the component.
Parameters:
featureId - The feature identifier.
Parameters:
state - The state of the feature.
throws:
SAXNotRecognizedException - The component should not throwthis exception.
throws:
SAXNotSupportedException - The component should not throwthis exception. |
| setProperty | | public void setProperty(String propertyId, Object value) throws XMLConfigurationException(Code) | | Sets the value of a property. This method is called by the component
manager any time after reset when a property changes value.
Note: Components should silently ignore properties
that do not affect the operation of the component.
Parameters:
propertyId - The property identifier.
Parameters:
value - The value of the property.
throws:
SAXNotRecognizedException - The component should not throwthis exception.
throws:
SAXNotSupportedException - The component should not throwthis exception. |
| startAttlist | | public void startAttlist(String elementName, Augmentations augs) throws XNIException(Code) | | The start of an attribute list.
Parameters:
elementName - The name of the element that this attributelist is associated with.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| startContentModel | | public void startContentModel(String elementName, Augmentations augs) throws XNIException(Code) | | The start of a content model. Depending on the type of the content
model, specific methods may be called between the call to the
startContentModel method and the call to the endContentModel method.
Parameters:
elementName - The name of the element.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| startDTD | | public void startDTD(XMLLocator locator, Augmentations augs) throws XNIException(Code) | | The start of the DTD.
Parameters:
locator - The document locator, or null if the documentlocation cannot be reported during the parsing of the document DTD. However, it is stronglyrecommended that a locator be supplied that can at least report the base system identifier of theDTD.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| startGroup | | public void startGroup(Augmentations augs) throws XNIException(Code) | | A start of either a mixed or children content model. A mixed
content model will immediately be followed by a call to the
pcdata() method. A children content model will
contain additional groups and/or elements.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error.
See Also: XMLDTDProcessor.any
See Also: XMLDTDProcessor.empty |
| startParameterEntity | | public void startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException(Code) | | This method notifies of the start of a parameter entity. The parameter
entity name start with a '%' character.
Parameters:
name - The name of the parameter entity.
Parameters:
identifier - The resource identifier.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. This value will be null in those situationswhere the entity encoding is not auto-detected (e.g.internal parameter entities).
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| textDecl | | public void textDecl(String version, String encoding, Augmentations augs) throws XNIException(Code) | | Notifies of the presence of a TextDecl line in an entity. If present,
this method will be called immediately following the startParameterEntity call.
Note: This method is only called for external
parameter entities referenced in the DTD.
Parameters:
version - The XML version, or null if not specified.
Parameters:
encoding - The IANA encoding name of the entity.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| unparsedEntityDecl | | public void unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augs) throws XNIException(Code) | | An unparsed entity declaration.
Parameters:
name - The name of the entity.
Parameters:
identifier - An object containing all location information pertinent to this entity.
Parameters:
notation - The name of the notation.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
|
|