jdk7u.jaxp.org.apache.xerces.external.xinclude

Class XPointerElementHandler

java.lang.Object

jdk7u.jaxp.org.apache.xerces.external.xinclude.XPointerElementHandler

All Implemented Interfaces:

XPointerSchema, XMLComponent, XMLDocumentFilter, XMLDocumentSource, XMLDocumentHandler

public class XPointerElementHandler
extends Object
implements XPointerSchema

Author:

Arun Yadav, Sun Microsystem

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ENTITY_RESOLVER Property identifier: grammar pool .
protected static String	ERROR_REPORTER Property identifier: error handler.
protected XMLLocator	fDocLocation
protected XMLDocumentHandler	fDocumentHandler
protected XMLDocumentSource	fDocumentSource
protected DTDGrammar	fDTDGrammar
protected XMLEntityResolver	fEntityResolver
protected XMLErrorReporter	fErrorReporter
protected XMLGrammarDescription	fGrammarDesc
protected XMLGrammarPool	fGrammarPool
protected XIncludeNamespaceSupport	fNamespaceContext
protected XIncludeHandler	fParentXIncludeHandler
protected StringBuffer	fPointer
protected ParserConfigurationSettings	fSettings
protected static String	GRAMMAR_POOL Property identifier: grammar pool .
protected static String	XPOINTER_SCHEMA

Constructor Summary

Constructors

Constructor and Description
XPointerElementHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	addQName(QName element)
void	characters(XMLString text, Augmentations augs) Character content.
boolean	checkIntegerToken(QName element)
boolean	checkStringToken(QName element, XMLAttributes attributes)
void	comment(XMLString text, Augmentations augs) A comment.
void	doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs) Notifies of the presence of the DOCTYPE line in the document.
void	emptyElement(QName element, XMLAttributes attributes, Augmentations augs) An empty element.
void	endCDATA(Augmentations augs) The end of a CDATA section.
void	endDocument(Augmentations augs) The end of the document.
void	endElement(QName element, Augmentations augs) The end of an element.
void	endGeneralEntity(String name, Augmentations augs) This method notifies the end of a general entity.
XMLDocumentHandler	getDocumentHandler() Returns the document handler
XMLDocumentSource	getDocumentSource() Returns the document source.
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.
boolean	getNextToken()
Object	getParent() return the Parent Contenthandler
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.
String[]	getRecognizedFeatures() Returns a list of feature identifiers that are recognized by this component.
String[]	getRecognizedProperties() Returns a list of property identifiers that are recognized by this component.
void	getTokens()
String	getXpointerSchemaName() Return Schema Name eg element , xpointer
String	getXPointerSchemaPointer() Return the XPointer Schema.
boolean	hasMoreToken()
void	ignorableWhitespace(XMLString text, Augmentations augs) Ignorable whitespace.
protected boolean	isRootDocument()
boolean	isSubResourceIndentified()
void	processingInstruction(String target, XMLString data, Augmentations augs) A processing instruction.
protected void	reportFatalError(String key)
protected void	reportFatalError(String key, Object[] args)
void	reset()
void	reset(XMLComponentManager componentManager) Resets the component.
void	setDocumentHandler(XMLDocumentHandler handler) Sets the document handler.
void	setDocumentSource(XMLDocumentSource source) Sets the document source.
void	setFeature(String featureId, boolean state) Sets the state of a feature.
void	setParent(Object parent) Parent Contenhandler for the this contenthandler. // not sure about the parameter type.
void	setProperty(String propertyId, Object value) Sets the value of a property.
void	setXPointerSchemaName(String schemaName) set the Schema Name eg element , xpointer
void	setXPointerSchemaPointer(String content) Content of the XPointer Schema.
void	startCDATA(Augmentations augs) The start of a CDATA section.
void	startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs) The start of the document.
void	startElement(QName element, XMLAttributes attributes, Augmentations augs) The start of an element.
void	startGeneralEntity(String name, XMLResourceIdentifier resId, String encoding, Augmentations augs) This method notifies the start of a general entity.
void	textDecl(String version, String encoding, Augmentations augs) Notifies of the presence of a TextDecl line in an entity.
void	xmlDecl(String version, String encoding, String standalone, Augmentations augs) Notifies of the presence of an XMLDecl line in the document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERROR_REPORTER

protected static final String ERROR_REPORTER

Property identifier: error handler.

See Also:

Constant Field Values

GRAMMAR_POOL

protected static final String GRAMMAR_POOL

Property identifier: grammar pool .

See Also:

Constant Field Values

ENTITY_RESOLVER

protected static final String ENTITY_RESOLVER

Property identifier: grammar pool .

See Also:

Constant Field Values

XPOINTER_SCHEMA

protected static final String XPOINTER_SCHEMA

See Also:

Constant Field Values

fDocumentHandler

protected XMLDocumentHandler fDocumentHandler

fDocumentSource

protected XMLDocumentSource fDocumentSource

fParentXIncludeHandler

protected XIncludeHandler fParentXIncludeHandler

fDocLocation

protected XMLLocator fDocLocation

fNamespaceContext

protected XIncludeNamespaceSupport fNamespaceContext

fErrorReporter

protected XMLErrorReporter fErrorReporter

fGrammarPool

protected XMLGrammarPool fGrammarPool

fGrammarDesc

protected XMLGrammarDescription fGrammarDesc

fDTDGrammar

protected DTDGrammar fDTDGrammar

fEntityResolver

protected XMLEntityResolver fEntityResolver

fSettings

protected ParserConfigurationSettings fSettings

fPointer

protected StringBuffer fPointer

Constructor Detail

XPointerElementHandler

public XPointerElementHandler()

Method Detail

reset

public void reset()

Specified by:

reset in interface XPointerSchema

reset

public void reset(XMLComponentManager componentManager)
           throws XNIException

Description copied from interface: XMLComponent

Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.

Specified by:

reset in interface XMLComponent

Parameters:

componentManager - The component manager.

Throws:

XNIException - Thrown by component on initialization error.

getRecognizedFeatures

public String[] getRecognizedFeatures()

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.

Specified by:

getRecognizedFeatures in interface XMLComponent

setFeature

public void setFeature(String featureId,
              boolean state)
                throws XMLConfigurationException

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.

Specified by:

setFeature in interface XMLComponent

Parameters:

featureId - The feature identifier.

state - The state of the feature.

Throws:

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.

getRecognizedProperties

public String[] getRecognizedProperties()

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.

Specified by:

getRecognizedProperties in interface XMLComponent

setProperty

public void setProperty(String propertyId,
               Object value)
                 throws XMLConfigurationException

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.

Specified by:

setProperty in interface XMLComponent

Parameters:

propertyId - The property identifier.

value - The value of the property.

Throws:

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.

getFeatureDefault

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.

Specified by:

getFeatureDefault in interface XMLComponent

Parameters:

featureId - The feature identifier.

Since:

Xerces 2.2.0

getPropertyDefault

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.

Specified by:

getPropertyDefault in interface XMLComponent

Parameters:

propertyId - The property identifier.

Since:

Xerces 2.2.0

setDocumentHandler

public void setDocumentHandler(XMLDocumentHandler handler)

Description copied from interface: XMLDocumentSource

Sets the document handler.

Specified by:

setDocumentHandler in interface XMLDocumentSource

getDocumentHandler

public XMLDocumentHandler getDocumentHandler()

Description copied from interface: XMLDocumentSource

Returns the document handler

Specified by:

getDocumentHandler in interface XMLDocumentSource

setXPointerSchemaName

public void setXPointerSchemaName(String schemaName)

set the Schema Name eg element , xpointer

Specified by:

setXPointerSchemaName in interface XPointerSchema

getXpointerSchemaName

public String getXpointerSchemaName()

Return Schema Name eg element , xpointer

Specified by:

getXpointerSchemaName in interface XPointerSchema

setParent

public void setParent(Object parent)

Parent Contenhandler for the this contenthandler. // not sure about the parameter type. It can be Contenthandler instead of Object type.

Specified by:

setParent in interface XPointerSchema

getParent

public Object getParent()

return the Parent Contenthandler

Specified by:

getParent in interface XPointerSchema

setXPointerSchemaPointer

public void setXPointerSchemaPointer(String content)

Content of the XPointer Schema. Xpath to be resolved.

Specified by:

setXPointerSchemaPointer in interface XPointerSchema

getXPointerSchemaPointer

public String getXPointerSchemaPointer()

Return the XPointer Schema.

Specified by:

getXPointerSchemaPointer in interface XPointerSchema

isSubResourceIndentified

public boolean isSubResourceIndentified()

Specified by:

isSubResourceIndentified in interface XPointerSchema

getTokens

public void getTokens()

hasMoreToken

public boolean hasMoreToken()

getNextToken

public boolean getNextToken()

checkStringToken

public boolean checkStringToken(QName element,
                       XMLAttributes attributes)

checkIntegerToken

public boolean checkIntegerToken(QName element)

addQName

public void addQName(QName element)

startDocument

public void startDocument(XMLLocator locator,
                 String encoding,
                 NamespaceContext namespaceContext,
                 Augmentations augs)
                   throws XNIException

Description copied from interface: XMLDocumentHandler

The start of the document.

Specified by:

startDocument in interface XMLDocumentHandler

Parameters:

locator - The document locator, or null if the document location cannot be reported during the parsing of this document. However, it is strongly recommended that a locator be supplied that can at least report the system identifier of the document.

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).

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.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

doctypeDecl

public void doctypeDecl(String rootElement,
               String publicId,
               String systemId,
               Augmentations augs)
                 throws XNIException

Description copied from interface: XMLDocumentHandler

Notifies of the presence of the DOCTYPE line in the document.

Specified by:

doctypeDecl in interface XMLDocumentHandler

Parameters:

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.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

xmlDecl

public void xmlDecl(String version,
           String encoding,
           String standalone,
           Augmentations augs)
             throws XNIException

Description copied from interface: XMLDocumentHandler

Notifies of the presence of an XMLDecl line in the document. If present, this method will be called immediately following the startDocument call.

Specified by:

xmlDecl in interface XMLDocumentHandler

Parameters:

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.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

comment

public void comment(XMLString text,
           Augmentations augs)
             throws XNIException

Description copied from interface: XMLDocumentHandler

A comment.

Specified by:

comment in interface XMLDocumentHandler

Parameters:

text - The text in the comment.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by application to signal an error.

processingInstruction

public void processingInstruction(String target,
                         XMLString data,
                         Augmentations augs)
                           throws XNIException

Description copied from interface: XMLDocumentHandler

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.

Specified by:

processingInstruction in interface XMLDocumentHandler

Parameters:

target - The target.

data - The data or null if none specified.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

startElement

public void startElement(QName element,
                XMLAttributes attributes,
                Augmentations augs)
                  throws XNIException

Description copied from interface: XMLDocumentHandler

The start of an element.

Specified by:

startElement in interface XMLDocumentHandler

Parameters:

element - The name of the element.

attributes - The element attributes.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endElement

public void endElement(QName element,
              Augmentations augs)
                throws XNIException

Description copied from interface: XMLDocumentHandler

The end of an element.

Specified by:

endElement in interface XMLDocumentHandler

Parameters:

element - The name of the element.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

emptyElement

public void emptyElement(QName element,
                XMLAttributes attributes,
                Augmentations augs)
                  throws XNIException

Description copied from interface: XMLDocumentHandler

An empty element.

Specified by:

emptyElement in interface XMLDocumentHandler

Parameters:

element - The name of the element.

attributes - The element attributes.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

startGeneralEntity

public void startGeneralEntity(String name,
                      XMLResourceIdentifier resId,
                      String encoding,
                      Augmentations augs)
                        throws XNIException

Description copied from interface: XMLDocumentHandler

This method notifies the start of a general entity.

Note: This method is not called for entity references appearing as part of attribute values.

Specified by:

startGeneralEntity in interface XMLDocumentHandler

Parameters:

name - The name of the general entity.

resId - 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

Throws:

XNIException - Thrown by handler to signal an error.

textDecl

public void textDecl(String version,
            String encoding,
            Augmentations augs)
              throws XNIException

Description copied from interface: XMLDocumentHandler

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.

Specified by:

textDecl in interface XMLDocumentHandler

Parameters:

version - The XML version, or null if not specified.

encoding - The IANA encoding name of the entity.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endGeneralEntity

public void endGeneralEntity(String name,
                    Augmentations augs)
                      throws XNIException

Description copied from interface: XMLDocumentHandler

This method notifies the end of a general entity.

Note: This method is not called for entity references appearing as part of attribute values.

Specified by:

endGeneralEntity in interface XMLDocumentHandler

Parameters:

name - The name of the entity.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

characters

public void characters(XMLString text,
              Augmentations augs)
                throws XNIException

Description copied from interface: XMLDocumentHandler

Character content.

Specified by:

characters in interface XMLDocumentHandler

Parameters:

text - The content.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

ignorableWhitespace

public void ignorableWhitespace(XMLString text,
                       Augmentations augs)
                         throws XNIException

Description copied from interface: XMLDocumentHandler

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.

Specified by:

ignorableWhitespace in interface XMLDocumentHandler

Parameters:

text - The ignorable whitespace.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

startCDATA

public void startCDATA(Augmentations augs)
                throws XNIException

Description copied from interface: XMLDocumentHandler

The start of a CDATA section.

Specified by:

startCDATA in interface XMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endCDATA

public void endCDATA(Augmentations augs)
              throws XNIException

Description copied from interface: XMLDocumentHandler

The end of a CDATA section.

Specified by:

endCDATA in interface XMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endDocument

public void endDocument(Augmentations augs)
                 throws XNIException

Description copied from interface: XMLDocumentHandler

The end of the document.

Specified by:

endDocument in interface XMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

setDocumentSource

public void setDocumentSource(XMLDocumentSource source)

Description copied from interface: XMLDocumentHandler

Sets the document source.

Specified by:

setDocumentSource in interface XMLDocumentHandler

getDocumentSource

public XMLDocumentSource getDocumentSource()

Description copied from interface: XMLDocumentHandler

Returns the document source.

Specified by:

getDocumentSource in interface XMLDocumentHandler

reportFatalError

protected void reportFatalError(String key)

reportFatalError

protected void reportFatalError(String key,
                    Object[] args)

isRootDocument

protected boolean isRootDocument()