org.apache.xerces.impl.xs

Class XMLSchemaValidator

Implemented Interfaces:
FieldActivator, RevalidationHandler, org.apache.xerces.xni.parser.XMLComponent, org.apache.xerces.xni.parser.XMLDocumentFilter, org.apache.xerces.xni.XMLDocumentHandler, org.apache.xerces.xni.parser.XMLDocumentSource

public class XMLSchemaValidator
extends java.lang.Object
implements org.apache.xerces.xni.parser.XMLComponent, org.apache.xerces.xni.parser.XMLDocumentFilter, FieldActivator, RevalidationHandler

The XML Schema validator. The validator implements a document filter: receiving document events from the scanner; validating the content and structure; augmenting the InfoSet, if applicable; and notifying the parser of the information resulting from the validation process.

This component requires the following features and properties from the component manager that uses it:

Version:
$Id: XMLSchemaValidator.java 426369 2006-07-28 03:17:09Z mrglavas $
Authors:
Sandy Gao IBM
Elena Litani IBM
Andy Clark IBM
Neeraj Bajaj, Sun Microsystems, inc.

Nested Class Summary

protected class
XMLSchemaValidator.KeyRefValueStore
Key reference value store.
protected class
XMLSchemaValidator.KeyValueStore
Key value store.
protected class
XMLSchemaValidator.LocalIDKey
protected static class
XMLSchemaValidator.ShortVector
A simple vector for shorts.
protected class
XMLSchemaValidator.UniqueValueStore
Unique value store.
protected abstract class
XMLSchemaValidator.ValueStoreBase
Value store implementation base class.
protected class
XMLSchemaValidator.ValueStoreCache
Value store cache.
protected static class
XMLSchemaValidator.XPathMatcherStack
Stack of XPath matchers for identity constraints.
protected class
XMLSchemaValidator.XSIErrorReporter
A wrapper of the standard error reporter.

Field Summary

protected static String
ALLOW_JAVA_ENCODINGS
Feature identifier: whether to recognize java encoding names
protected static String
CONTINUE_AFTER_FATAL_ERROR
Feature identifier: whether to continue parsing a schema after a fatal error is encountered
protected static String
DYNAMIC_VALIDATION
Feature identifier: dynamic validation.
protected static String
ENTITY_MANAGER
static String
ENTITY_RESOLVER
Property identifier: entity resolver.
static String
ERROR_REPORTER
Property identifier: error reporter.
protected static String
GENERATE_SYNTHETIC_ANNOTATIONS
Feature: generate synthetic annotations
protected static String
HONOUR_ALL_SCHEMALOCATIONS
Feature identifier: honour all schemaLocations
protected static String
IDENTITY_CONSTRAINT_CHECKING
Feature identifier: whether to ignore identity constraint errors
protected static int
ID_CONSTRAINT_NUM
protected static String
ID_IDREF_CHECKING
Feature identifier: whether to ignore ID/IDREF errors
protected static String
IGNORE_XSI_TYPE
Feature identifier: whether to ignore xsi:type attributes until a global element declaration is encountered
protected static String
JAXP_SCHEMA_LANGUAGE
Property identifier: JAXP schema language.
protected static String
JAXP_SCHEMA_SOURCE
Property identifier: JAXP schema source.
protected static String
NORMALIZE_DATA
Feature identifier: expose schema normalized value
protected static String
PARSER_SETTINGS
protected static String
ROOT_TYPE_DEF
Property identifier: root type definition.
protected static String
SCHEMA_AUGMENT_PSVI
Feature identifier: augment PSVI
protected static String
SCHEMA_ELEMENT_DEFAULT
Feature identifier: send element default value via characters()
protected static String
SCHEMA_FULL_CHECKING
Feature identifier: schema full checking
protected static String
SCHEMA_LOCATION
Property identifier: schema location.
protected static String
SCHEMA_NONS_LOCATION
Property identifier: no namespace schema location.
protected static String
SCHEMA_VALIDATION
Feature identifier: validation.
protected static String
STANDARD_URI_CONFORMANT_FEATURE
Feature identifier: standard uri conformant feature.
static String
SYMBOL_TABLE
Property identifier: symbol table.
protected static String
UNPARSED_ENTITY_CHECKING
Feature identifier: whether to ignore unparsed entity errors
protected static String
USE_GRAMMAR_POOL_ONLY
Feature identifier: use grammar pool only
protected static String
VALIDATE_ANNOTATIONS
Feature identifier: validate annotations.
protected static String
VALIDATION
Feature identifier: validation.
protected static String
VALIDATION_MANAGER
static String
XMLGRAMMAR_POOL
Property identifier: grammar pool.
protected boolean
fAugPSVI
protected AugmentationsImpl
fAugmentations
protected ElementPSVImpl
fCurrentPSVI
current PSVI element info
protected org.apache.xerces.xni.XMLString
fDefaultValue
protected boolean
fDoValidation
protected org.apache.xerces.xni.XMLDocumentHandler
fDocumentHandler
Document handler.
protected org.apache.xerces.xni.parser.XMLDocumentSource
fDocumentSource
protected boolean
fDynamicValidation
protected boolean
fEntityRef
protected org.apache.xerces.xni.parser.XMLEntityResolver
fEntityResolver
Entity resolver
protected String
fExternalNoNamespaceSchema
protected String
fExternalSchemas
protected boolean
fFullChecking
protected org.apache.xerces.xni.grammars.XMLGrammarPool
fGrammarPool
protected boolean
fIdConstraint
protected boolean
fInCDATA
protected Object
fJaxpSchemaSource
protected Hashtable
fLocationPairs
protected XMLSchemaValidator.XPathMatcherStack
fMatcherStack
Stack of active XPath matchers for identity constraints.
protected HashMap
fMayMatchFieldMap
Map which is used to catch instance documents that try and match a field several times in the same scope.
protected boolean
fNormalizeData
protected boolean
fSchemaDynamicValidation
protected boolean
fSchemaElementDefault
protected SymbolTable
fSymbolTable
Symbol table.
protected boolean
fUseGrammarPoolOnly
protected ValidationManager
fValidationManager
protected ConfigurableValidationState
fValidationState
protected XMLSchemaValidator.ValueStoreCache
fValueStoreCache
Cache of value stores for identity constraint fields.
protected XSDDescription
fXSDDescription
Schema Grammar Description passed, to give a chance to application to supply the Grammar
protected XMLSchemaValidator.XSIErrorReporter
fXSIErrorReporter
Error reporter.

Constructor Summary

XMLSchemaValidator()
Default constructor.

Method Summary

XPathMatcher
activateField(Field field, int initialDepth)
Request to activate the specified field.
boolean
characterData(String data, org.apache.xerces.xni.Augmentations augs)
void
characters(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)
Character content.
void
comment(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)
A comment.
void
doctypeDecl(String rootElement, String publicId, String systemId, org.apache.xerces.xni.Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.
void
elementDefault(String data)
void
emptyElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs)
An empty element.
void
endCDATA(org.apache.xerces.xni.Augmentations augs)
The end of a CDATA section.
void
endDocument(org.apache.xerces.xni.Augmentations augs)
The end of the document.
void
endElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.Augmentations augs)
The end of an element.
void
endGeneralEntity(String name, org.apache.xerces.xni.Augmentations augs)
This method notifies the end of a general entity.
void
endValueScopeFor(IdentityConstraint identityConstraint, int initialDepth)
Ends the value scope for the specified identity constraint.
org.apache.xerces.xni.XMLDocumentHandler
getDocumentHandler()
Returns the document handler
org.apache.xerces.xni.parser.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.
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
ignorableWhitespace(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)
Ignorable whitespace.
Boolean
mayMatch(Field field)
Returns whether the given field is permitted to match a value.
void
processingInstruction(String target, org.apache.xerces.xni.XMLString data, org.apache.xerces.xni.Augmentations augs)
A processing instruction.
void
reset(org.apache.xerces.xni.parser.XMLComponentManager componentManager)
void
setDocumentHandler(org.apache.xerces.xni.XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.
void
setDocumentSource(org.apache.xerces.xni.parser.XMLDocumentSource source)
Sets the document source
void
setFeature(String featureId, boolean state)
Sets the state of a feature.
void
setMayMatch(Field field, Boolean state)
Sets whether the given field is permitted to match a value.
void
setProperty(String propertyId, Object value)
Sets the value of a property.
void
startCDATA(org.apache.xerces.xni.Augmentations augs)
The start of a CDATA section.
void
startDocument(org.apache.xerces.xni.XMLLocator locator, String encoding, org.apache.xerces.xni.NamespaceContext namespaceContext, org.apache.xerces.xni.Augmentations augs)
The start of the document.
void
startElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs)
The start of an element.
void
startGeneralEntity(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String encoding, org.apache.xerces.xni.Augmentations augs)
This method notifies the start of a general entity.
void
startValueScopeFor(IdentityConstraint identityConstraint, int initialDepth)
Start the value scope for the specified identity constraint.
void
textDecl(String version, String encoding, org.apache.xerces.xni.Augmentations augs)
Notifies of the presence of a TextDecl line in an entity.
void
xmlDecl(String version, String encoding, String standalone, org.apache.xerces.xni.Augmentations augs)
Notifies of the presence of an XMLDecl line in the document.

Field Details

ALLOW_JAVA_ENCODINGS

protected static final String ALLOW_JAVA_ENCODINGS
Feature identifier: whether to recognize java encoding names

CONTINUE_AFTER_FATAL_ERROR

protected static final String CONTINUE_AFTER_FATAL_ERROR
Feature identifier: whether to continue parsing a schema after a fatal error is encountered

DYNAMIC_VALIDATION

protected static final String DYNAMIC_VALIDATION
Feature identifier: dynamic validation.

ENTITY_MANAGER

protected static final String ENTITY_MANAGER

ENTITY_RESOLVER

public static final String ENTITY_RESOLVER
Property identifier: entity resolver.

ERROR_REPORTER

public static final String ERROR_REPORTER
Property identifier: error reporter.

GENERATE_SYNTHETIC_ANNOTATIONS

protected static final String GENERATE_SYNTHETIC_ANNOTATIONS
Feature: generate synthetic annotations

HONOUR_ALL_SCHEMALOCATIONS

protected static final String HONOUR_ALL_SCHEMALOCATIONS
Feature identifier: honour all schemaLocations

IDENTITY_CONSTRAINT_CHECKING

protected static final String IDENTITY_CONSTRAINT_CHECKING
Feature identifier: whether to ignore identity constraint errors

ID_CONSTRAINT_NUM

protected static final int ID_CONSTRAINT_NUM
Field Value:
1

ID_IDREF_CHECKING

protected static final String ID_IDREF_CHECKING
Feature identifier: whether to ignore ID/IDREF errors

IGNORE_XSI_TYPE

protected static final String IGNORE_XSI_TYPE
Feature identifier: whether to ignore xsi:type attributes until a global element declaration is encountered

JAXP_SCHEMA_LANGUAGE

protected static final String JAXP_SCHEMA_LANGUAGE
Property identifier: JAXP schema language.

JAXP_SCHEMA_SOURCE

protected static final String JAXP_SCHEMA_SOURCE
Property identifier: JAXP schema source.

NORMALIZE_DATA

protected static final String NORMALIZE_DATA
Feature identifier: expose schema normalized value

PARSER_SETTINGS

protected static final String PARSER_SETTINGS

ROOT_TYPE_DEF

protected static final String ROOT_TYPE_DEF
Property identifier: root type definition.

SCHEMA_AUGMENT_PSVI

protected static final String SCHEMA_AUGMENT_PSVI
Feature identifier: augment PSVI

SCHEMA_ELEMENT_DEFAULT

protected static final String SCHEMA_ELEMENT_DEFAULT
Feature identifier: send element default value via characters()

SCHEMA_FULL_CHECKING

protected static final String SCHEMA_FULL_CHECKING
Feature identifier: schema full checking

SCHEMA_LOCATION

protected static final String SCHEMA_LOCATION
Property identifier: schema location.

SCHEMA_NONS_LOCATION

protected static final String SCHEMA_NONS_LOCATION
Property identifier: no namespace schema location.

SCHEMA_VALIDATION

protected static final String SCHEMA_VALIDATION
Feature identifier: validation.

STANDARD_URI_CONFORMANT_FEATURE

protected static final String STANDARD_URI_CONFORMANT_FEATURE
Feature identifier: standard uri conformant feature.

SYMBOL_TABLE

public static final String SYMBOL_TABLE
Property identifier: symbol table.

UNPARSED_ENTITY_CHECKING

protected static final String UNPARSED_ENTITY_CHECKING
Feature identifier: whether to ignore unparsed entity errors

USE_GRAMMAR_POOL_ONLY

protected static final String USE_GRAMMAR_POOL_ONLY
Feature identifier: use grammar pool only

VALIDATE_ANNOTATIONS

protected static final String VALIDATE_ANNOTATIONS
Feature identifier: validate annotations.

VALIDATION

protected static final String VALIDATION
Feature identifier: validation.

VALIDATION_MANAGER

protected static final String VALIDATION_MANAGER

XMLGRAMMAR_POOL

public static final String XMLGRAMMAR_POOL
Property identifier: grammar pool.

fAugPSVI

protected boolean fAugPSVI

fAugmentations

protected final AugmentationsImpl fAugmentations

fCurrentPSVI

protected ElementPSVImpl fCurrentPSVI
current PSVI element info

fDefaultValue

protected org.apache.xerces.xni.XMLString fDefaultValue

fDoValidation

protected boolean fDoValidation

fDocumentHandler

protected org.apache.xerces.xni.XMLDocumentHandler fDocumentHandler
Document handler.

fDocumentSource

protected org.apache.xerces.xni.parser.XMLDocumentSource fDocumentSource

fDynamicValidation

protected boolean fDynamicValidation

fEntityRef

protected boolean fEntityRef

fEntityResolver

protected org.apache.xerces.xni.parser.XMLEntityResolver fEntityResolver
Entity resolver

fExternalNoNamespaceSchema

protected String fExternalNoNamespaceSchema

fExternalSchemas

protected String fExternalSchemas

fFullChecking

protected boolean fFullChecking

fGrammarPool

protected org.apache.xerces.xni.grammars.XMLGrammarPool fGrammarPool

fIdConstraint

protected boolean fIdConstraint

fInCDATA

protected boolean fInCDATA

fJaxpSchemaSource

protected Object fJaxpSchemaSource

fLocationPairs

protected final Hashtable fLocationPairs

fMatcherStack

protected XMLSchemaValidator.XPathMatcherStack fMatcherStack
Stack of active XPath matchers for identity constraints. All active XPath matchers are notified of startElement and endElement callbacks in order to perform their matches.

For each element with identity constraints, the selector of each identity constraint is activated. When the selector matches its XPath, then all the fields of the identity constraint are activated.

Note: Once the activation scope is left, the XPath matchers are automatically removed from the stack of active matchers and no longer receive callbacks.


fMayMatchFieldMap

protected final HashMap fMayMatchFieldMap
Map which is used to catch instance documents that try and match a field several times in the same scope.

fNormalizeData

protected boolean fNormalizeData

fSchemaDynamicValidation

protected boolean fSchemaDynamicValidation

fSchemaElementDefault

protected boolean fSchemaElementDefault

fSymbolTable

protected SymbolTable fSymbolTable
Symbol table.

fUseGrammarPoolOnly

protected boolean fUseGrammarPoolOnly

fValidationManager

protected ValidationManager fValidationManager

fValidationState

protected ConfigurableValidationState fValidationState

fValueStoreCache

protected XMLSchemaValidator.ValueStoreCache fValueStoreCache
Cache of value stores for identity constraint fields.

fXSDDescription

protected final XSDDescription fXSDDescription
Schema Grammar Description passed, to give a chance to application to supply the Grammar

fXSIErrorReporter

protected final XMLSchemaValidator.XSIErrorReporter fXSIErrorReporter
Error reporter.

Constructor Details

XMLSchemaValidator

public XMLSchemaValidator()
Default constructor.

Method Details

activateField

public XPathMatcher activateField(Field field,
                                  int initialDepth)
Request to activate the specified field. This method returns the matcher for the field.
Specified by:
activateField in interface FieldActivator
Parameters:
field - The field to activate.

characterData

public boolean characterData(String data,
                             org.apache.xerces.xni.Augmentations augs)
Specified by:
characterData in interface RevalidationHandler

characters

public void characters(org.apache.xerces.xni.XMLString text,
                       org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
Character content.
Specified by:
characters in interface org.apache.xerces.xni.XMLDocumentHandler
Parameters:
text - The content.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

comment

public void comment(org.apache.xerces.xni.XMLString text,
                    org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
A comment.
Specified by:
comment in interface org.apache.xerces.xni.XMLDocumentHandler
Parameters:
text - The text in the comment.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by application to signal an error.

doctypeDecl

public void doctypeDecl(String rootElement,
                        String publicId,
                        String systemId,
                        org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
Notifies of the presence of the DOCTYPE line in the document.
Specified by:
doctypeDecl in interface org.apache.xerces.xni.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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

elementDefault

public void elementDefault(String data)

emptyElement

public void emptyElement(org.apache.xerces.xni.QName element,
                         org.apache.xerces.xni.XMLAttributes attributes,
                         org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
An empty element.
Specified by:
emptyElement in interface org.apache.xerces.xni.XMLDocumentHandler
Parameters:
element - The name of the element.
attributes - The element attributes.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endCDATA

public void endCDATA(org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The end of a CDATA section.
Specified by:
endCDATA in interface org.apache.xerces.xni.XMLDocumentHandler
Parameters:
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endDocument

public void endDocument(org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The end of the document.
Specified by:
endDocument in interface org.apache.xerces.xni.XMLDocumentHandler
Parameters:
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endElement

public void endElement(org.apache.xerces.xni.QName element,
                       org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The end of an element.
Specified by:
endElement in interface org.apache.xerces.xni.XMLDocumentHandler
Parameters:
element - The name of the element.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endGeneralEntity

public void endGeneralEntity(String name,
                             org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
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 org.apache.xerces.xni.XMLDocumentHandler
Parameters:
name - The name of the entity.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endValueScopeFor

public void endValueScopeFor(IdentityConstraint identityConstraint,
                             int initialDepth)
Ends the value scope for the specified identity constraint.
Specified by:
endValueScopeFor in interface FieldActivator
Parameters:
identityConstraint - The identity constraint.

getDocumentHandler

public org.apache.xerces.xni.XMLDocumentHandler getDocumentHandler()
Returns the document handler
Specified by:
getDocumentHandler in interface org.apache.xerces.xni.parser.XMLDocumentSource

getDocumentSource

public org.apache.xerces.xni.parser.XMLDocumentSource getDocumentSource()
Returns the document source
Specified by:
getDocumentSource in interface org.apache.xerces.xni.XMLDocumentHandler

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 org.apache.xerces.xni.parser.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 org.apache.xerces.xni.parser.XMLComponent
Parameters:
propertyId - The property identifier.
Since:
Xerces 2.2.0

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 org.apache.xerces.xni.parser.XMLComponent

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 org.apache.xerces.xni.parser.XMLComponent

ignorableWhitespace

public void ignorableWhitespace(org.apache.xerces.xni.XMLString text,
                                org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
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 org.apache.xerces.xni.XMLDocumentHandler
Parameters:
text - The ignorable whitespace.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

mayMatch

public Boolean mayMatch(Field field)
Returns whether the given field is permitted to match a value.
Specified by:
mayMatch in interface FieldActivator
Parameters:
field - The field that may be permitted to be matched.
Returns:
Boolean indicating whether the field may be matched.

processingInstruction

public void processingInstruction(String target,
                                  org.apache.xerces.xni.XMLString data,
                                  org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
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 org.apache.xerces.xni.XMLDocumentHandler
Parameters:
target - The target.
data - The data or null if none specified.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

reset

public void reset(org.apache.xerces.xni.parser.XMLComponentManager componentManager)
            throws org.apache.xerces.xni.parser.XMLConfigurationException
Specified by:
reset in interface org.apache.xerces.xni.parser.XMLComponent

setDocumentHandler

public void setDocumentHandler(org.apache.xerces.xni.XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.
Specified by:
setDocumentHandler in interface org.apache.xerces.xni.parser.XMLDocumentSource

setDocumentSource

public void setDocumentSource(org.apache.xerces.xni.parser.XMLDocumentSource source)
Sets the document source
Specified by:
setDocumentSource in interface org.apache.xerces.xni.XMLDocumentHandler

setFeature

public void setFeature(String featureId,
                       boolean state)
            throws org.apache.xerces.xni.parser.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 org.apache.xerces.xni.parser.XMLComponent
Parameters:
featureId - The feature identifier.
state - The state of the feature.

setMayMatch

public void setMayMatch(Field field,
                        Boolean state)
Sets whether the given field is permitted to match a value. This should be used to catch instance documents that try and match a field several times in the same scope.
Specified by:
setMayMatch in interface FieldActivator
Parameters:
field - The field that may be permitted to be matched.
state - Boolean indiciating whether the field may be matched.

setProperty

public void setProperty(String propertyId,
                        Object value)
            throws org.apache.xerces.xni.parser.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 org.apache.xerces.xni.parser.XMLComponent
Parameters:
propertyId - The property identifier.
value - The value of the property.

startCDATA

public void startCDATA(org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The start of a CDATA section.
Specified by:
startCDATA in interface org.apache.xerces.xni.XMLDocumentHandler
Parameters:
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startDocument

public void startDocument(org.apache.xerces.xni.XMLLocator locator,
                          String encoding,
                          org.apache.xerces.xni.NamespaceContext namespaceContext,
                          org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The start of the document.
Specified by:
startDocument in interface org.apache.xerces.xni.XMLDocumentHandler
Parameters:
locator - The system identifier of the entity if the entity is external, null otherwise.
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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startElement

public void startElement(org.apache.xerces.xni.QName element,
                         org.apache.xerces.xni.XMLAttributes attributes,
                         org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The start of an element.
Specified by:
startElement in interface org.apache.xerces.xni.XMLDocumentHandler
Parameters:
element - The name of the element.
attributes - The element attributes.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startGeneralEntity

public void startGeneralEntity(String name,
                               org.apache.xerces.xni.XMLResourceIdentifier identifier,
                               String encoding,
                               org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
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 org.apache.xerces.xni.XMLDocumentHandler
Parameters:
name - The name of the general 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
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startValueScopeFor

public void startValueScopeFor(IdentityConstraint identityConstraint,
                               int initialDepth)
Start the value scope for the specified identity constraint. This method is called when the selector matches in order to initialize the value store.
Specified by:
startValueScopeFor in interface FieldActivator
Parameters:
identityConstraint - The identity constraint.

textDecl

public void textDecl(String version,
                     String encoding,
                     org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
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 org.apache.xerces.xni.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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

xmlDecl

public void xmlDecl(String version,
                    String encoding,
                    String standalone,
                    org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
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 org.apache.xerces.xni.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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

Copyright B) 1999-2006 The Apache Software Foundation. All Rights Reserved.