Xerces-J 2.0 Design

Classes and Interfaces

Xerces Native Interface (XNI)

interface XMLComponent
methods:
  • reset ( XMLComponentManager componentManager )
  • setFeature ( String featureId, boolean state )
  • setProperty ( String propertyId, Object value )
interface XMLComponentManager
methods:
  • getFeature ( String featureId ) : boolean
  • getProperty ( String propertyId ) : Object
interface XMLEntityHandler
methods:
  • startEntity ( String name, String publicId, String systemId, String encoding )
  • endEntity ( String name )
interface XMLDocumentSource
methods:
  • setDocumentHandler ( XMLDocumentHandler documentHandler )
interface XMLDocumentHandler
methods:
  • startDocument ( )
  • xmlDecl ( String version, String encoding, String standalone )
  • doctypeDecl ( String rootElement, String publicId, String systemId )
  • comment ( XMLString text )
  • processingInstruction ( String target, XMLString data )
  • startPrefixMapping ( String prefix, String uri )
  • startEntity ( String name, String publicId, String systemId, String encoding )
  • endEntity ( String name )
  • startElement ( QName element, XMLAttributes attributes )
  • characters ( XMLString text )
  • ignorableWhitespace ( XMLString text )
  • endElement ( QName element )
  • endPrefixMapping ( String prefix )
  • startCDATA ( )
  • endCDATA ( )
  • textDecl ( String version, String encoding )
  • endDocument ( )
interface XMLDocumentFilter
extends XMLDocumentHandler XMLDocumentSource
interface XMLDTDSource
methods:
  • setDTDHandler ( XMLDTDHandler dtdHandler )
interface XMLDTDHandler
constants:
  • short CONDITIONAL_INCLUDE
  • short CONDITIONAL_IGNORE
methods:
  • startDTD ( )
  • comment ( XMLString text )
  • processingInstruction ( String target, XMLString data )
  • startEntity ( String name, String publicId, String systemId, String encoding )
  • endEntity ( String name )
  • startExternalSubset ( )
  • endExternalSubset ( )
  • elementDecl ( String name, XMLString contentModel )
  • startAttlist ( String elementName )
  • attributeDecl ( String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue )
  • endAttlist ( )
  • internalEntityDecl ( String name, XMLString text )
  • externalEntityDecl ( String name, String publicId, String systemId )
  • unparsedEntityDecl ( String name, String publicId, String systemId, String notation )
  • notationDecl ( String name, String publicId, String systemId )
  • startConditional ( short type )
  • endConditional ( )
  • endDTD ( )
interface XMLDTDFilter
extends XMLDTDHandler XMLDTDSource
interface XMLDTDContentModelSource
methods:
  • setDTDContentModelHandler ( XMLDTDContentModelHandler dtdContentModelHandler )
interface XMLDTDContentModelHandler
constants:
  • short TYPE_EMPTY
  • short TYPE_ANY
  • short TYPE_MIXED
  • short TYPE_CHILDREN
  • short SEPARATOR_CHOICE
  • short SEPARATOR_SEQUENCE
  • short OCCURS_ZERO_OR_ONE
  • short OCCURS_ZERO_OR_MORE
  • short OCCURS_ONE_OR_MORE
methods:
  • startContentModel ( String elementName, short type )
  • mixedElement ( String elementName )
  • childrenStartGroup ( )
  • childrenElement ( String elementName )
  • childrenSeparator ( short separator )
  • childrenOccurrence ( short occurrence )
  • childrenEndGroup ( )
  • endContentModel ( )
interface XMLDTDContentModelFilter
extends XMLDTDContentModelHandler XMLDTDContentModelSource
class QName
fields:
  • String prefix
  • String localpart
  • String rawname
  • String uri
methods:
  • setValues ( String prefix, String localpart, String rawname, String uri )
  • clear ( )
class XMLString
fields:
  • char[] ch
  • int offset
  • int length
constructors:
  • XMLString ( )
  • XMLString ( char[] ch, int offset, int length )
methods:
  • setValues ( char[] ch, int offset, int length )
  • clear ( )
  • equals ( char[] ch, int offset, int length ) : boolean
  • equals ( String s ) : boolean
  • toString ( ) : String
class XMLAttributes
implements AttributeList, Attributes
fields:
  • boolean fNamespaces
constructors:
  • XMLAttributes ( )
methods:
  • setNamespaces ( boolean namespaces )
  • setAttribute ( QName name, String type, XMLString value ) : int
  • addAttributeEntity ( int index, String name, int offset, int length )
  • removeAttribute ( QName name )
  • clear ( )
  • getLength ( ) : int
  • setName ( int index, QName name )
  • getName ( int index, QName name )
  • setType ( int index, String type )
  • getType ( int index ) : String
  • setValue ( int index, String value )
  • setValue ( int index, XMLString value )
  • getValue ( int index, XMLString value )
  • getEntityCount ( int attrIndex ) : int
  • getEntityName ( int attrIndex, int entityIndex ) : String
  • getEntityOffset ( int attrIndex, int entityIndex ) : int
  • getEntityLength ( int attrIndex, int entityIndex ) : int

Implementation: Core Components

class XMLErrorReporter
implements XMLComponent
constants:
  • short SEVERITY_WARNING
  • short SEVERITY_ERROR
  • short SEVERITY_FATAL_ERROR
fields:
  • Locale fLocale
  • Hashtable < MessageFormatter > fMessageFormatters
  • ErrorHandler fErrorHandler
  • boolean fContinueAfterFatalError
constructors:
  • XMLErrorReporter ( )
methods:
  • setLocale ( Locale locale )
  • putMessageFormatter ( String domain, MessageFormatter messageFormatter )
  • getMessageFormatter ( String domain ) : MessageFormatter
  • removeMessageFormatter ( String domain ) : MessageFormatter
  • reportError ( String domain, String key, Object[] arguments, short severity )
class XMLDocumentScanner
implements XMLComponent, XMLDocumentSource, XMLEntityHandler
fields:
  • SymbolTable fSymbolTable
  • XMLErrorReporter fErrorReporter
  • XMLEntityManager fEntityManager
  • XMLDTDScanner fDTDScanner
  • boolean fNamespaces
  • XMLDocumentHandler fDocumentHandler
constructors:
  • XMLDocumentScanner ( )
methods:
  • scanDocument ( boolean complete ) : boolean
class XMLDTDScanner
implements XMLComponent, XMLDTDSource, XMLDTDContentModelSource, XMLEntityHandler
fields:
  • SymbolTable fSymbolTable
  • XMLErrorReporter fErrorReporter
  • XMLEntityManager fEntityManager
  • GrammarPool fGrammarPool
  • XMLDTDHandler fDTDHandler
  • XMLDTDContentModelHandler fDTDContentModelHandler
constructors:
  • XMLDTDScanner ( )
methods:
  • scanDTD ( boolean complete ) : boolean
  • scanDTDFragment ( boolean complete ) : boolean
  • scanDTDInternalSubset ( boolean complete ) : boolean
class XMLEntityManager
implements XMLComponent
fields:
  • EntityResolver fEntityResolver
  • XMLEntityScanner fEntityReader
  • XMLEntityHandler fEntityHandler
constructors:
  • XMLEntityManager ( )
methods:
  • setEntityHandler ( XMLEntityHandler entityHandler )
  • addGeneralEntity ( String name, String publicId, String systemId, String baseSystemId )
  • addGeneralEntity ( String name, String text )
  • addParameterEntity ( String name, String publicId, String systemId, String baseSystemId )
  • addParameterEntity ( String name, String text )
  • resolveEntity ( String publicId, String systemId, String baseSystemId ) : InputSource
  • startParameterEntity ( String entityName )
  • startGeneralEntity ( String entityName )
  • startDocumentEntity ( InputSource inputSource )
  • startDTDEntity ( InputSource inputSource )
  • getEntityScanner ( ) : XMLEntityScanner
class XMLEntityScanner
implements Locator
methods:
  • peekChar ( ) : int
  • scanChar ( ) : int
  • scanNmtoken ( ) : String
  • scanName ( ) : String
  • scanQName ( QName qname ) : boolean
  • scanContent ( XMLString content ) : int
  • scanAttContent ( int quote, XMLString content ) : int
  • scanData ( String delimiter, XMLString data ) : boolean
  • skipChar ( int c ) : boolean
  • skipSpaces ( ) : boolean
  • skipString ( String s ) : boolean
class XMLValidator
implements XMLComponent, XMLDocumentFilter
fields:
  • SymbolTable fSymbolTable
  • XMLErrorReporter fErrorReporter
  • GrammarPool fGrammarPool
  • boolean fNamespaces
  • boolean fValidation
  • boolean fDynamicValidation
  • XMLDocumentHandler fDocumentHandler
constructors:
  • XMLValidator ( )

Implementation: Validation

class GrammarPool
fields:
  • Hashtable < Grammar > fGrammars
constructors:
  • GrammarPool ( )
methods:
  • putGrammar ( String key, Grammar grammar )
  • getGrammar ( String key ) : Grammar
  • removeGrammar ( String key ) : Grammar
class Grammar
fields:
  • String fTargetNamespace
constructors:
  • Grammar ( )
methods:
  • getTargetNamespace ( ) : String
  • getFirstElementDeclIndex ( ) : int
  • getNextElementDeclIndex ( int elementDeclIndex ) : int
  • getElementDeclIndex ( String elementDeclName, int scope ) : int
  • getElementDecl ( int elementDeclIndex, XMLElementDecl elementDecl ) : boolean
  • getFirstAttributeDeclIndex ( int elementDeclIndex ) : int
  • getNextAttributeDeclIndex ( int attributeDeclIndex ) : int
  • getAttributeDeclIndex ( int elementDeclIndex, String attributeDeclName ) : int
  • getAttributeDecl ( int attributeDeclIndex, XMLAttributeDecl attributeDecl ) : boolean
  • getFirstEntityDeclIndex ( ) : int
  • getNextEntityDeclIndex ( int entityDeclIndex ) : int
  • getEntityDeclIndex ( String entityDeclName ) : int
  • getEntityDecl ( int entityDeclIndex, XMLEntityDecl entityDecl ) : boolean
  • getFirstNotationDeclIndex ( ) : int
  • getNextNotationDeclIndex ( int notationDeclIndex ) : int
  • getNotationDeclIndex ( String notationDeclName ) : int
  • getNotationDecl ( int notationDeclIndex, XMLNotationDecl notationDecl ) : boolean
class XMLElementDecl
constants:
  • short TYPE_ANY
  • short TYPE_EMPTY
  • short TYPE_MIXED
  • short TYPE_CHILDREN
  • short TYPE_SIMPLE
fields:
  • QName name
  • int scope
  • short type
  • ContentModelValidator contentModelValidator
  • XMLSimpleType simpleType
methods:
  • setValues ( QName name, int scope, short type, ContentModelValidator contentModelValidator, XMLSimpleType simpleType )
  • clear ( )
class XMLAttributeDecl
fields:
  • QName name
  • XMLSimpleType simpleType
  • boolean optional
methods:
  • setValues ( QName name, XMLSimpleType simpleType, boolean optional )
  • clear ( )
class XMLSimpleType
constants:
  • short TYPE_CDATA
  • short TYPE_ENTITY
  • short TYPE_ENUMERATION
  • short TYPE_ID
  • short TYPE_IDREF
  • short TYPE_NMTOKEN
  • short TYPE_NOTATION
  • short TYPE_NAMED
  • short DEFAULT_TYPE_DEFAULT
  • short DEFAULT_TYPE_FIXED
  • short DEFAULT_TYPE_IMPLIED
  • short DEFAULT_TYPE_REQUIRED
fields:
  • short type
  • String name
  • String[] enumeration
  • boolean list
  • short defaultType
  • String defaultValue
  • DatatypeValidator datatypeValidator
methods:
  • setValues ( short type, String name, String[] enumeration, boolean list, short defaultType, String defaultValue, DatatypeValidator datatypeValidator )
  • clear ( )
class XMLEntityDecl
fields:
  • String name
  • String publicId
  • String systemId
  • String baseSystemId
  • String notation
  • boolean isPE
methods:
  • setValues ( String name, String publicId, String systemId, String baseSystemId, String notation, boolean isPE )
  • clear ( )
class XMLNotationDecl
fields:
  • String name
  • String publicId
  • String systemId
methods:
  • setValues ( String name, String publicId, String systemId )
  • clear ( )
interface DatatypeValidatorFactory
methods:
  • createDatatypeValidator ( String name, DatatypeValidator base, Hashtable < String > facets, boolean list ) : DatatypeValidator
interface DatatypeValidator
methods:
  • getFacets ( ) : Hashtable < String >
  • validate ( String data, Object state )
  • compare ( String value1, String value2 ) : int
class InvalidDatatypeFacetException
extends SAXException
constructors:
  • InvalidDatatypeFacetException ( )
  • InvalidDatatypeFacetException ( String message )
  • InvalidDatatypeFacetException ( Exception exception )
  • InvalidDatatypeFacetException ( String message, Exception exception )
class InvalidDatatypeValueException
extends SAXException
constructors:
  • InvalidDatatypeValueException ( )
  • InvalidDatatypeValueException ( String message )
  • InvalidDatatypeValueException ( Exception exception )
  • InvalidDatatypeValueException ( String message, Exception exception )
interface ContentModelValidator
methods:
  • validate ( QName[] children, int offset, int length ) : int

Implementation: Validation Content Models

class SimpleContentModel
implements ContentModelValidator
constants:
  • short CHOICE
  • short SEQUENCE
fields:
  • short fOperator
  • QName fFirstChild
  • QName fSecondChild
constructors:
  • SimpleContentModel ( short operator, QName firstChild, QName secondChild )
class MixedContentModel
implements ContentModelValidator
fields:
  • int fCount
  • QName[] fChildren
  • boolean fOrdered
constructors:
  • MixedContentModel ( int count, QName[] children, boolean ordered )
class DFAContentModel
implements ContentModelValidator
constructors:
  • DFAContentModel ( )

Implementation: Validation Datatypes

class DatatypeValidatorFactoryImpl
implements DatatypeValidatorFactory
fields:
  • Hashtable < DatatypeValidator > fBaseTypes
class AbstractDatatypeValidator
implements DatatypeValidator
fields:
  • Hashtable < String > fFacets
constructors:
  • AbstractDatatypeValidator ( DatatypeValidator base, Hashtable < String > facets, boolean list )
class StringDatatypeValidator
extends AbstractDatatypeValidator
constructors:
  • StringDatatypeValidator ( DatatypeValidator base, Hashtable < String > facets, boolean list )

Implementation: Validation Grammars

class DTDGrammar
extends Grammar
implements XMLDTDSource, XMLDTDHandler, XMLDTDContentModelSource, XMLDTDContentModelHandler
fields:
  • XMLDTDHandler setDTDHandler
  • XMLDTDContentModelHandler setDTDContentModelHandler
constructors:
  • DTDGrammar ( )
  • DTDGrammar ( String targetNamespace )
class SchemaGrammar
extends Grammar
constructors:
  • SchemaGrammar ( )
  • SchemaGrammar ( Document grammarDocument )
  • SchemaGrammar ( Document grammarDocument, GrammarPool grammarPool )

Parsing

class CachingParserPool
fields:
  • SymbolTable fSymbolTable
  • GrammarPool fGrammarPool
constructors:
  • CachingParserPool ( )
  • CachingParserPool ( SymbolTable symbolTable )
  • CachingParserPool ( GrammarPool grammarPool )
  • CachingParserPool ( SymbolTable symbolTable, GrammarPool grammarPool )
methods:
  • getSymbolTable ( ) : SymbolTable
  • getGrammarPool ( ) : GrammarPool
  • createDOMParser ( ) : DOMParser
  • createSAXParser ( ) : SAXParser
  • createDTDParser ( ) : DTDParser
  • createSchemaParser ( ) : SchemaParser
class XMLParser
implements XMLComponentManager
fields:
  • SymbolTable fSymbolTable
  • XMLEntityManager fEntityManager
  • XMLErrorReporter fErrorReporter
  • boolean fNamespaces
  • boolean fValidation
  • boolean fDynamicValidation
  • boolean fContinueAfterFatalError
constructors:
  • XMLParser ( )
  • XMLParser ( SymbolTable symbolTable )
methods:
  • setFeature ( String featureId, boolean state )
  • getFeature ( String featureId ) : boolean
  • setProperty ( String propertyId, Object value )
  • getProperty ( String propertyId ) : Object
  • setEntityResolver ( EntityResolver entityResolver )
  • setErrorHandler ( ErrorHandler errorHandler )
  • parse ( String systemId )
  • parse ( InputSource inputSource )
class XMLDocumentParser
extends XMLParser
implements XMLDocumentHandler
fields:
  • XMLDocumentScanner fScanner
  • XMLDTDScanner fDTDScanner
  • XMLValidator fValidator
  • GrammarPool fGrammarPool
  • DatatypeValidatorFactory fDatatypeValidatorFactory
constructors:
  • XMLDocumentParser ( )
  • XMLDocumentParser ( SymbolTable symbolTable, GrammarPool grammarPool )
class DOMParser
extends XMLDocumentParser
constructors:
  • DOMParser ( )
  • DOMParser ( SymbolTable symbolTable, GrammarPool grammarPool )
methods:
  • getDocument ( ) : Document
class SAXParser
extends XMLDocumentParser
implements XMLDTDHandler, Parser, XMLReader
constructors:
  • SAXParser ( )
  • SAXParser ( SymbolTable symbolTable, GrammarPool grammarPool )
class XMLGrammarParser
extends XMLParser
implements XMLComponentManager
fields:
  • DatatypeValidatorFactory fDatatypeValidatorFactory
constructors:
  • XMLGrammarParser ( SymbolTable symbolTable )
class DTDParser
extends XMLGrammarParser
implements XMLDTDHandler, XMLDTDContentModelHandler
fields:
  • XMLDTDScanner fDTDScanner
constructors:
  • DTDParser ( SymbolTable symbolTable )
methods:
  • getDTDGrammar ( ) : DTDGrammar
class SchemaParser
extends XMLGrammarParser
fields:
  • DOMParser fDOMParser
  • GrammarPool fGrammarPool
constructors:
  • SchemaParser ( SymbolTable symbolTable, GrammarPool grammarPool )
methods:
  • getSchemaGrammar ( ) : SchemaGrammar

Utility Interfaces and Classes

class XMLChar
constants:
  • byte[] CHARS
  • byte MASK_VALID
  • byte MASK_SPACE
  • byte MASK_NAME_START
  • byte MASK_NAME
  • byte MASK_PUBID
methods:
  • isValid ( int c ) : boolean
  • isSpace ( char c ) : boolean
  • isNameStart ( char c ) : boolean
  • isName ( char c ) : boolean
  • isPubid ( char c ) : boolean
class EncodingMap
fields:
  • Hashtable < String > fIANA2JavaMap
  • Hashtable < String > fJava2IANAMap
constructors:
  • EncodingMap ( )
methods:
  • putIANA2JavaMapping ( String ianaEncoding, String javaEncoding )
  • getIANA2JavaMapping ( String ianaEncoding ) : String
  • removeIANA2JavaMapping ( String ianaEncoding ) : String
  • putJava2IANAMapping ( String javaEncoding, String ianaEncoding )
  • getJava2IANAMapping ( String javaEncoding ) : String
  • removeJava2IANAMapping ( String javaEncoding ) : String
class SymbolTable
constructors:
  • SymbolTable ( )
methods:
  • addSymbol ( String symbol ) : String
  • addSymbol ( char[] buffer, int offset, String length ) : String
  • hash ( String symbol ) : int
  • hash ( char[] buffer, int offset, int length ) : int
interface MessageFormatter
methods:
  • formatMessage ( Locale locale, String key, Object[] arguments ) : String
class XMLStringBuffer
extends XMLString
constants:
  • int DEFAULT_SIZE
constructors:
  • XMLStringBuffer ( )
  • XMLStringBuffer ( int size )
methods:
  • clear ( )
  • append ( char c )
  • append ( String s )
  • append ( char[] ch, int offset, int length )
  • append ( XMLString s )
Last modified: $Date$