This component requires the following features and properties from the component manager that uses it:
Modifier and Type | Field and Description |
---|---|
protected static final String | ERROR_REPORTER
Property identifier: error reporter. |
private QName | fAttributeQName
Attribute QName. |
protected XMLDocumentHandler | fDocumentHandler
Document handler. |
protected XMLDocumentSource | |
private static final Boolean[] | FEATURE_DEFAULTS
Feature defaults. |
protected XMLErrorReporter | fErrorReporter
Error reporter. |
private NamespaceContext | fNamespaceContext
Namespace context. |
protected boolean | fNamespaces
Namespaces. |
protected boolean | fOnlyPassPrefixMappingEvents
Only pass start and end prefix mapping events. |
protected SymbolTable | fSymbolTable
Symbol table. |
protected static final String | NAMESPACES
Feature identifier: namespaces. |
private static final Object[] | PROPERTY_DEFAULTS
Property defaults. |
private static final String[] | RECOGNIZED_FEATURES
Recognized features. |
private static final String[] | RECOGNIZED_PROPERTIES
Recognized properties. |
protected static final String | SYMBOL_TABLE
Property identifier: symbol table. |
Access | Constructor and Description |
---|---|
public |
Modifier and Type | Method and Description |
---|---|
public void | characters(XMLString
The content. text, Augmentations Additional information that may include infoset augmentations augs)Implements com. Character content. |
public void | comment(XMLString
The text in the comment. text, Augmentations Additional information that may include infoset augmentations augs)Implements com. A comment. |
public void | doctypeDecl(String
The name of the root element. rootElement, String The public identifier if an external DTD or null
if the external DTD is specified using SYSTEM. publicId, String The system identifier if an external DTD, null
otherwise. systemId, Augmentations Additional information that may include infoset augmentations augs)Implements com. Notifies of the presence of the DOCTYPE line in the document. |
public void | emptyElement(QName
The name of the element. element, XMLAttributes The element attributes. attributes, Augmentations Additional information that may include infoset augmentations augs)Implements com. An empty element. |
public void | endCDATA(Augmentations
Additional information that may include infoset augmentations augs)Implements com. The end of a CDATA section. |
public void | endDocument(Augmentations
Additional information that may include infoset augmentations augs)Implements com. The end of the document. |
public void | endElement(QName
The name of the element. element, Augmentations Additional information that may include infoset augmentations augs)Implements com. The end of an element. |
public void | endGeneralEntity(String
The name of the entity. name, Augmentations Additional information that may include infoset augmentations augs)Implements com. This method notifies the end of a general entity. |
public XMLDocumentHandler | getDocumentHandler()
Implements com. Returns the document handler |
public XMLDocumentSource | getDocumentSource()
Implements com. Returns the document source |
public Boolean | getFeatureDefault(String
The feature identifier. featureId)Implements com. Returns the default state for a feature, or null if this component does not want to report a default value for this feature. |
public boolean | getOnlyPassPrefixMappingEvents()
Returns true if the namespace binder only passes the prefix mapping events to the registered document handler; false if the namespace binder passes all document events. |
public Object | getPropertyDefault(String
The property identifier. propertyId)Implements com. 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()
Implements com. Returns a list of feature identifiers that are recognized by this component. |
public String[] | getRecognizedProperties()
Implements com. Returns a list of property identifiers that are recognized by this component. |
protected void | |
protected void | handleStartElement(QName element, XMLAttributes attributes, Augmentations augs, boolean isEmpty)
Handles start element. |
public void | ignorableWhitespace(XMLString
The ignorable whitespace. text, Augmentations Additional information that may include infoset augmentations augs)Implements com. Ignorable whitespace. |
protected boolean | |
public void | processingInstruction(String
The target. target, XMLString The data or null if none specified. data, Augmentations Additional information that may include infoset augmentations augs)Implements com. A processing instruction. |
public void | reset(XMLComponentManager
The component manager. componentManager)Implements com. Resets the component. |
public void | setDocumentHandler(XMLDocumentHandler documentHandler)
Implements com. Sets the document handler to receive information about the document. |
public void | setDocumentSource(XMLDocumentSource source)
Implements com. Sets the document source |
public void | setFeature(String
The feature identifier. featureId, boolean The state of the feature. state)Implements com. Sets the state of a feature. |
public void | setOnlyPassPrefixMappingEvents(boolean
True to pass only the prefix
mapping events; false to pass
all events. onlyPassPrefixMappingEvents)Sets whether the namespace binder only passes the prefix mapping events to the registered document handler or passes all document events. |
public void | setProperty(String propertyId, Object value)
Implements com. Sets the value of a property during parsing. |
public void | startCDATA(Augmentations
Additional information that may include infoset augmentations augs)Implements com. The start of a CDATA section. |
public void | startDocument(XMLLocator
The system identifier of the entity if the entity
is external, null otherwise. locator, String 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). encoding, NamespaceContext The namespace context in effect at the
start of this document.
This object represents the current context.
Implementors of this class are responsible
for copying the namespace bindings from the
the current context (and its parent contexts)
if that information is important. namespaceContext, Augmentations Additional information that may include infoset augmentations augs)Implements com. The start of the document. |
public void | startElement(QName
The name of the element. element, XMLAttributes The element attributes. attributes, Augmentations Additional information that may include infoset augmentations augs)Implements com. Binds the namespaces. |
public void | startGeneralEntity(String
The name of the general entity. name, XMLResourceIdentifier The resource identifier. identifier, String 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). encoding, Augmentations Additional information that may include infoset augmentations augs)Implements com. This method notifies the start of a general entity. |
public void | textDecl(String
The XML version, or null if not specified. version, String The IANA encoding name of the entity. encoding, Augmentations Additional information that may include infoset augmentations augs)Implements com. Notifies of the presence of a TextDecl line in an entity. |
public void | xmlDecl(String
The XML version. version, String The IANA encoding name of the document, or null if
not specified. encoding, String The standalone value, or null if not specified. standalone, Augmentations Additional information that may include infoset augmentations augs)Implements com. Notifies of the presence of an XMLDecl line in the document. |
ERROR_REPORTER | back to summary |
---|---|
protected static final String ERROR_REPORTER Property identifier: error reporter. |
fAttributeQName | back to summary |
---|---|
private QName fAttributeQName Attribute QName. |
fDocumentHandler | back to summary |
---|---|
protected XMLDocumentHandler fDocumentHandler Document handler. |
fDocumentSource | back to summary |
---|---|
protected XMLDocumentSource fDocumentSource |
FEATURE_DEFAULTS | back to summary |
---|---|
private static final Boolean[] FEATURE_DEFAULTS Feature defaults. |
fErrorReporter | back to summary |
---|---|
protected XMLErrorReporter fErrorReporter Error reporter. |
fNamespaceContext | back to summary |
---|---|
private NamespaceContext fNamespaceContext Namespace context. |
fNamespaces | back to summary |
---|---|
protected boolean fNamespaces Namespaces. |
fOnlyPassPrefixMappingEvents | back to summary |
---|---|
protected boolean fOnlyPassPrefixMappingEvents Only pass start and end prefix mapping events. |
fSymbolTable | back to summary |
---|---|
protected SymbolTable fSymbolTable Symbol table. |
NAMESPACES | back to summary |
---|---|
protected static final String NAMESPACES Feature identifier: namespaces. |
PROPERTY_DEFAULTS | back to summary |
---|---|
private static final Object[] PROPERTY_DEFAULTS Property defaults. |
RECOGNIZED_FEATURES | back to summary |
---|---|
private static final String[] RECOGNIZED_FEATURES Recognized features. |
RECOGNIZED_PROPERTIES | back to summary |
---|---|
private static final String[] RECOGNIZED_PROPERTIES Recognized properties. |
SYMBOL_TABLE | back to summary |
---|---|
protected static final String SYMBOL_TABLE Property identifier: symbol table. |
XMLNamespaceBinder | back to summary |
---|---|
public XMLNamespaceBinder() Default constructor. |
characters | back to summary |
---|---|
public void characters(XMLString text, Augmentations augs) throws XNIException Implements com. Character content.
|
comment | back to summary |
---|---|
public void comment(XMLString text, Augmentations augs) throws XNIException Implements com. A comment.
|
doctypeDecl | back to summary |
---|---|
public void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs) throws XNIException Implements com. Notifies of the presence of the DOCTYPE line in the document.
|
emptyElement | back to summary |
---|---|
public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException Implements com. An empty element.
|
endCDATA | back to summary |
---|---|
public void endCDATA(Augmentations augs) throws XNIException Implements com. The end of a CDATA section.
|
endDocument | back to summary |
---|---|
public void endDocument(Augmentations augs) throws XNIException Implements com. The end of the document.
|
endElement | back to summary |
---|---|
public void endElement(QName element, Augmentations augs) throws XNIException Implements com. The end of an element.
|
endGeneralEntity | back to summary |
---|---|
public void endGeneralEntity(String name, Augmentations augs) throws XNIException Implements com. This method notifies the end of a general entity. Note This method is not called for entity references appearing as part of attribute values.
|
getDocumentHandler | back to summary |
---|---|
public XMLDocumentHandler getDocumentHandler() Implements com. Returns the document handler |
getDocumentSource | back to summary |
---|---|
public XMLDocumentSource getDocumentSource() Implements com. Returns the document source |
getFeatureDefault | back to summary |
---|---|
public Boolean getFeatureDefault(String featureId) Implements com. Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
|
getOnlyPassPrefixMappingEvents | back to summary |
---|---|
public boolean getOnlyPassPrefixMappingEvents() Returns true if the namespace binder only passes the prefix mapping events to the registered document handler; false if the namespace binder passes all document events. |
getPropertyDefault | back to summary |
---|---|
public Object getPropertyDefault(String propertyId) Implements com. Returns the default state for a property, or null if this component does not want to report a default value for this property.
|
getRecognizedFeatures | back to summary |
---|---|
public String[] getRecognizedFeatures() Implements com. 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 | back to summary |
---|---|
public String[] getRecognizedProperties() Implements com. 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. |
handleEndElement | back to summary |
---|---|
protected void handleEndElement(QName element, Augmentations augs, boolean isEmpty) throws XNIException Handles end element. |
handleStartElement | back to summary |
---|---|
protected void handleStartElement(QName element, XMLAttributes attributes, Augmentations augs, boolean isEmpty) throws XNIException Handles start element. |
ignorableWhitespace | back to summary |
---|---|
public void ignorableWhitespace(XMLString text, Augmentations augs) throws XNIException Implements com. Ignorable whitespace. For this method to be called, the document source must have some way of determining that the text containing only whitespace characters should be considered ignorable. For example, the validator can determine if a length of whitespace characters in the document are ignorable based on the element content model.
|
prefixBoundToNullURI | back to summary |
---|---|
protected boolean prefixBoundToNullURI(String uri, String localpart) |
processingInstruction | back to summary |
---|---|
public void processingInstruction(String target, XMLString data, Augmentations augs) throws XNIException Implements com. 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.
|
reset | back to summary |
---|---|
public void reset(XMLComponentManager componentManager) throws XNIException Implements com. Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.
|
setDocumentHandler | back to summary |
---|---|
public void setDocumentHandler(XMLDocumentHandler documentHandler) Implements com. Sets the document handler to receive information about the document. |
setDocumentSource | back to summary |
---|---|
public void setDocumentSource(XMLDocumentSource source) Implements com. Sets the document source |
setFeature | back to summary |
---|---|
public void setFeature(String featureId, boolean state) throws XMLConfigurationException Implements com. 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.
|
setOnlyPassPrefixMappingEvents | back to summary |
---|---|
public void setOnlyPassPrefixMappingEvents(boolean onlyPassPrefixMappingEvents) Sets whether the namespace binder only passes the prefix mapping events to the registered document handler or passes all document events.
|
setProperty | back to summary |
---|---|
public void setProperty(String propertyId, Object value) throws XMLConfigurationException Implements com. Sets the value of a property during parsing.
|
startCDATA | back to summary |
---|---|
public void startCDATA(Augmentations augs) throws XNIException Implements com. The start of a CDATA section.
|
startDocument | back to summary |
---|---|
public void startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs) throws XNIException Implements com. The start of the document.
|
startElement | back to summary |
---|---|
public void startElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException Implements com. Binds the namespaces. This method will handle calling the document handler to start the prefix mappings. Note This method makes use of the fAttributeQName variable. Any contents of the variable will be destroyed. Caller should copy the values out of this temporary variable before calling this method.
|
startGeneralEntity | back to summary |
---|---|
public void startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException Implements com. This method notifies the start of a general entity. Note This method is not called for entity references appearing as part of attribute values.
|
textDecl | back to summary |
---|---|
public void textDecl(String version, String encoding, Augmentations augs) throws XNIException Implements com. Notifies of the presence of a TextDecl line in an entity. If present, this method will be called immediately following the startEntity call. 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.
|
xmlDecl | back to summary |
---|---|
public void xmlDecl(String version, String encoding, String standalone, Augmentations augs) throws XNIException Implements com. Notifies of the presence of an XMLDecl line in the document. If present, this method will be called immediately following the startDocument call.
|