|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.xerces.impl.XMLScanner org.apache.xerces.impl.XMLDocumentFragmentScannerImpl org.apache.xerces.impl.XMLDocumentScannerImpl
public class XMLDocumentScannerImpl
This class is responsible for scanning XML document structure and content. The scanner acts as the source for the document information which is communicated to the document handler.
This component requires the following features and properties from the component manager that uses it:
Constructor Summary | |
---|---|
XMLDocumentScannerImpl()
Default constructor. |
Method Summary | |
---|---|
void |
endEntity(java.lang.String name,
Augmentations augs)
This method notifies the end of an entity. |
java.lang.Boolean |
getFeatureDefault(java.lang.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. |
java.lang.Object |
getPropertyDefault(java.lang.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. |
java.lang.String[] |
getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by this component. |
java.lang.String[] |
getRecognizedProperties()
Returns a list of property identifiers that are recognized by this component. |
void |
reset(XMLComponentManager componentManager)
Resets the component. |
void |
setFeature(java.lang.String featureId,
boolean state)
Sets the state of a feature. |
void |
setInputSource(XMLInputSource inputSource)
Sets the input source. |
void |
setProperty(java.lang.String propertyId,
java.lang.Object value)
Sets the value of a property. |
void |
startEntity(java.lang.String name,
XMLResourceIdentifier identifier,
java.lang.String encoding,
Augmentations augs)
This method notifies of the start of an entity. |
Methods inherited from class org.apache.xerces.impl.XMLDocumentFragmentScannerImpl |
---|
getDispatcherName, getDocumentHandler, scanDocument, setDocumentHandler |
Methods inherited from class org.apache.xerces.impl.XMLScanner |
---|
getFeature, scanPseudoAttribute |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XMLDocumentScannerImpl()
Method Detail |
---|
public void setInputSource(XMLInputSource inputSource) throws java.io.IOException
setInputSource
in interface XMLDocumentScanner
setInputSource
in class XMLDocumentFragmentScannerImpl
inputSource
- The input source.
java.io.IOException
- Thrown on i/o error.public void reset(XMLComponentManager componentManager) throws XMLConfigurationException
reset
in interface XMLComponent
reset
in class XMLDocumentFragmentScannerImpl
componentManager
- The component manager.
SAXException
- Thrown by component on initialization error.
For example, if a feature or property is
required for the operation of the component, the
component manager may throw a
SAXNotRecognizedException or a
SAXNotSupportedException.
XMLConfigurationException
public java.lang.String[] getRecognizedFeatures()
getRecognizedFeatures
in interface XMLComponent
getRecognizedFeatures
in class XMLDocumentFragmentScannerImpl
public void setFeature(java.lang.String featureId, boolean state) throws XMLConfigurationException
Note: Components should silently ignore features that do not affect the operation of the component.
setFeature
in interface XMLComponent
setFeature
in class XMLDocumentFragmentScannerImpl
featureId
- The feature identifier.state
- The state of the feature.
SAXNotRecognizedException
- The component should not throw
this exception.
SAXNotSupportedException
- The component should not throw
this exception.
XMLConfigurationException
- Thrown for configuration error.
In general, components should
only throw this exception if
it is really
a critical error.public java.lang.String[] getRecognizedProperties()
getRecognizedProperties
in interface XMLComponent
getRecognizedProperties
in class XMLDocumentFragmentScannerImpl
public void setProperty(java.lang.String propertyId, java.lang.Object value) throws XMLConfigurationException
Note: Components should silently ignore properties that do not affect the operation of the component.
setProperty
in interface XMLComponent
setProperty
in class XMLDocumentFragmentScannerImpl
propertyId
- The property identifier.value
- The value of the property.
SAXNotRecognizedException
- The component should not throw
this exception.
SAXNotSupportedException
- The component should not throw
this exception.
XMLConfigurationException
- Thrown for configuration error.
In general, components should
only throw this exception if
it is really
a critical error.public java.lang.Boolean getFeatureDefault(java.lang.String featureId)
getFeatureDefault
in interface XMLComponent
getFeatureDefault
in class XMLDocumentFragmentScannerImpl
featureId
- The feature identifier.public java.lang.Object getPropertyDefault(java.lang.String propertyId)
getPropertyDefault
in interface XMLComponent
getPropertyDefault
in class XMLDocumentFragmentScannerImpl
propertyId
- The property identifier.public void startEntity(java.lang.String name, XMLResourceIdentifier identifier, java.lang.String encoding, Augmentations augs) throws XNIException
startEntity
in interface XMLEntityHandler
startEntity
in class XMLDocumentFragmentScannerImpl
name
- The name of the entity.identifier
- The resource identifier.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).augs
- Additional information that may include infoset augmentations
XNIException
- Thrown by handler to signal an error.public void endEntity(java.lang.String name, Augmentations augs) throws XNIException
endEntity
in interface XMLEntityHandler
endEntity
in class XMLDocumentFragmentScannerImpl
name
- The name of the entity.augs
- Additional information that may include infoset augmentations
XNIException
- Thrown by handler to signal an error.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |