design/design.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/WD-html-in-xml/DTD/xhtml1-strict.dtd"> <HTML> <HEAD> <TITLE>Xerces 2 | Design</TITLE> <LINK href="css/index.css" rel="stylesheet" type="text/css"> <LINK href="css/design.css" rel="stylesheet" type="text/css"> </HEAD> <BODY> <H1 align="center">Xerces-J 2.0 Design </H1> <H2>Classes and Interfaces</H2> <H3>Xerces Native Interface (XNI)</H3> <BLOCKQUOTE> <A name="XMLDocumentHandler"><DL class="interface"> <DT>interface XMLDocumentHandler <DD class="methods"> methods: <UL> <LI> startDocument ( String systemId, String encoding ) <LI> xmlDecl ( String version, String encoding, String standalone ) <LI> doctypeDecl ( String rootElement, String publicId, String systemId ) <LI> comment ( XMLString text ) <LI> processingInstruction ( String target, XMLString data ) <LI> startPrefixMapping ( String prefix, String uri ) <LI> startEntity ( String name, String publicId, String systemId, String baseSystemId, String encoding ) <LI> textDecl ( String version, String encoding ) <LI> endEntity ( String name ) <LI> startElement ( QName element, XMLAttributes attributes ) <LI> emptyElement ( QName element, XMLAttributes attributes ) <LI> characters ( XMLString text ) <LI> ignorableWhitespace ( XMLString text ) <LI> endElement ( QName element ) <LI> endPrefixMapping ( String prefix ) <LI> startCDATA ( ) <LI> endCDATA ( ) <LI> endDocument ( ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLDocumentFragmentHandler"><DL class="interface"> <DT>interface XMLDocumentFragmentHandler <DD class="methods"> methods: <UL> <LI> startDocumentFragment ( String baseSystemId, NamespaceContext namespaceContext ) <LI> comment ( XMLString text ) <LI> processingInstruction ( String target, XMLString data ) <LI> startPrefixMapping ( String prefix, String uri ) <LI> startEntity ( String name, String publicId, String systemId, String baseSystemId, String encoding ) <LI> endEntity ( String name ) <LI> startElement ( QName element, XMLAttributes attributes ) <LI> emptyElement ( QName element, XMLAttributes attributes ) <LI> characters ( XMLString text ) <LI> ignorableWhitespace ( XMLString text ) <LI> endElement ( QName element ) <LI> endPrefixMapping ( String prefix ) <LI> startCDATA ( ) <LI> endCDATA ( ) <LI> textDecl ( String version, String encoding ) <LI> endDocumentFragment ( ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="NamespaceContext"><DL class="interface"> <DT>interface NamespaceContext <DD class="constants"> constants: <UL> <LI> String XMLNS </UL> <DD class="methods"> methods: <UL> <LI> getParentContext ( ) : NamespaceContext <LI> getURI ( String prefix ) : String <LI> getDeclaredPrefixCount ( ) : int <LI> getDeclaredPrefixAt ( int index ) : String </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLDTDHandler"><DL class="interface"> <DT>interface XMLDTDHandler <DD class="constants"> constants: <UL> <LI>short CONDITIONAL_INCLUDE <LI>short CONDITIONAL_IGNORE </UL> <DD class="methods"> methods: <UL> <LI> startDTD ( ) <LI> comment ( XMLString text ) <LI> processingInstruction ( String target, XMLString data ) <LI> startEntity ( String name, String publicId, String systemId, String baseSystemId, String encoding ) <LI> textDecl ( String version, String encoding ) <LI> endEntity ( String name ) <LI> elementDecl ( String name, String contentModel ) <LI> startAttlist ( String elementName ) <LI> attributeDecl ( String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue ) <LI> endAttlist ( ) <LI> internalEntityDecl ( String name, XMLString text ) <LI> externalEntityDecl ( String name, String publicId, String systemId, String baseSystemId ) <LI> unparsedEntityDecl ( String name, String publicId, String systemId, String notation ) <LI> notationDecl ( String name, String publicId, String systemId ) <LI> startConditional ( short type ) <LI> endConditional ( ) <LI> endDTD ( ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLDTDContentModelHandler"><DL class="interface"> <DT>interface XMLDTDContentModelHandler <DD class="constants"> constants: <UL> <LI>short SEPARATOR_CHOICE <LI>short SEPARATOR_SEQUENCE <LI>short OCCURS_ZERO_OR_ONE <LI>short OCCURS_ZERO_OR_MORE <LI>short OCCURS_ONE_OR_MORE </UL> <DD class="methods"> methods: <UL> <LI> startContentModel ( String elementName ) <LI> any ( ) <LI> empty ( ) <LI> startGroup ( ) <LI> pcdata ( ) <LI> element ( String elementName ) <LI> separator ( short separator ) <LI> occurrence ( short occurrence ) <LI> endGroup ( ) <LI> endContentModel ( ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="QName"><DL class="class"> <DT>class QName <DD class="fields"> fields: <UL> <LI> String prefix <LI> String localpart <LI> String rawname <LI> String uri </UL> <DD class="methods"> methods: <UL> <LI> setValues ( String prefix, String localpart, String rawname, String uri ) <LI> clear ( ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLString"><DL class="class"> <DT>class XMLString <DD class="fields"> fields: <UL> <LI>char[] ch <LI>int offset <LI>int length </UL> <DD class="constructors"> constructors: <UL> <LI> XMLString ( ) <LI> XMLString ( char[] ch, int offset, int length ) </UL> <DD class="methods"> methods: <UL> <LI> setValues ( char[] ch, int offset, int length ) <LI> clear ( ) <LI> equals ( char[] ch, int offset, int length ) : boolean <LI> equals ( String s ) : boolean <LI> toString ( ) : String </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLAttributes"><DL class="interface"> <DT>interface XMLAttributes <DD class="extends"> extends AttributeList Attributes <DD class="methods"> methods: <UL> <LI> addAttribute ( QName name, String type, XMLString value ) : int <LI> removeAttributeAt ( int index ) <LI> removeAllAttributes ( ) <LI> removeAllEntitiesFor ( int attrIndex ) <LI> addAttributeEntity ( int index, String name, int offset, int length ) <LI> removeEntityAt ( int attrIndex, int entityIndex ) <LI> setName ( int index, QName name ) <LI> getName ( int index, QName name ) <LI> setType ( int index, String type ) <LI> getType ( int index ) : String <LI> setValue ( int index, String value ) <LI> setNonNormalizedValue ( int index, String value ) <LI> getNonNormalizedValue ( int index ) : String <LI> setSpecified ( int index, boolean specified ) <LI> isSpecified ( int index ) : boolean <LI> getEntityCount ( int attrIndex ) : int <LI> getEntityName ( int attrIndex, int entityIndex ) : String <LI> getEntityOffset ( int attrIndex, int entityIndex ) : int <LI> getEntityLength ( int attrIndex, int entityIndex ) : int </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XNIException"><DL class="class"> <DT>class XNIException <DD class="fields"> fields: <UL> <LI> String fException </UL> <DD class="constructors"> constructors: <UL> <LI> XNIException ( String message ) <LI> XNIException ( Exception exception ) <LI> XNIException ( Exception exception, String message ) </UL> <DD class="methods"> methods: <UL> <LI> getException ( ) : String </UL> </DL> </A></BLOCKQUOTE> <H3>XNI: Parser Pipeline</H3> <BLOCKQUOTE> <A name="XMLComponent"><DL class="interface"> <DT>interface XMLComponent <DD class="methods"> methods: <UL> <LI> reset ( XMLComponentManager componentManager ) <LI> getRecognizedFeatures ( String[] recognizedFeatures ) <LI> setFeature ( String featureId, boolean state ) <LI> getRecognizedProperties ( String[] recognizedProperties ) <LI> setProperty ( String propertyId, Object value ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLComponentManager"><DL class="interface"> <DT>interface XMLComponentManager <DD class="methods"> methods: <UL> <LI> getFeature ( String featureId ) : boolean <LI> getProperty ( String propertyId ) : Object </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLParserConfiguration"><DL class="interface"> <DT>interface XMLParserConfiguration <DD class="methods"> methods: <UL> <LI> addRecognizedFeatures ( String featureIds ) <LI> setFeature ( String featureId, boolean state ) <LI> getFeature ( String featureId ) : boolean <LI> addRecognizedProperties ( String propertyIds ) <LI> setProperty ( String propertyId, Object value ) <LI> getProperty ( String propertyId ) : Object <LI> setLocale ( Locale locale ) <LI> setDocumentHandler ( XMLDocumentHandler documentHandler ) <LI> setDTDHandler ( XMLDTDHandler dtdHandler ) <LI> setDTDContentModelHandler ( XMLDTDContentModelHandler dtdContentModelHandler ) <LI> parse ( InputSource inputSource ) </UL> </DL> </A></BLOCKQUOTE> <H3>Implementation: Core Components</H3> <BLOCKQUOTE> <A name="XMLErrorReporter"><DL class="class"> <DT>class XMLErrorReporter <DD class="implements"> implements XMLComponent <DD class="constants"> constants: <UL> <LI>short SEVERITY_WARNING <LI>short SEVERITY_ERROR <LI>short SEVERITY_FATAL_ERROR </UL> <DD class="fields"> fields: <UL> <LI> Locale fLocale <LI> Hashtable < MessageFormatter > fMessageFormatters <LI> ErrorHandler fErrorHandler <LI>boolean fContinueAfterFatalError </UL> <DD class="constructors"> constructors: <UL> <LI> XMLErrorReporter ( ) </UL> <DD class="methods"> methods: <UL> <LI> setLocale ( Locale locale ) <LI> putMessageFormatter ( String domain, MessageFormatter messageFormatter ) <LI> getMessageFormatter ( String domain ) : MessageFormatter <LI> removeMessageFormatter ( String domain ) : MessageFormatter <LI> reportError ( String domain, String key, Object[] arguments, short severity ) <LI> reportError ( Locator location, String domain, String key, Object[] arguments, short severity ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLDocumentScanner"><DL class="class"> <DT>class XMLDocumentScanner <DD class="implements"> implements XMLComponent, , XMLEntityHandler <DD class="fields"> fields: <UL> <LI> SymbolTable fSymbolTable <LI> XMLErrorReporter fErrorReporter <LI> XMLEntityManager fEntityManager <LI> XMLDTDScanner fDTDScanner <LI>boolean fNamespaces <LI> XMLDocumentHandler fDocumentHandler </UL> <DD class="constructors"> constructors: <UL> <LI> XMLDocumentScanner ( ) </UL> <DD class="methods"> methods: <UL> <LI> scanDocument ( boolean complete ) : boolean </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLDTDScanner"><DL class="class"> <DT>class XMLDTDScanner <DD class="implements"> implements XMLComponent, , , XMLEntityHandler <DD class="fields"> fields: <UL> <LI> SymbolTable fSymbolTable <LI> XMLErrorReporter fErrorReporter <LI> XMLEntityManager fEntityManager <LI> XMLDTDHandler fDTDHandler <LI> XMLDTDContentModelHandler fDTDContentModelHandler </UL> <DD class="constructors"> constructors: <UL> <LI> XMLDTDScanner ( ) </UL> <DD class="methods"> methods: <UL> <LI> scanDTD ( boolean complete ) : boolean <LI> scanDTDFragment ( boolean complete ) : boolean <LI> scanDTDInternalSubset ( boolean complete, boolean standalone, boolean hasExternalDTD ) : boolean </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLEntityManager"><DL class="class"> <DT>class XMLEntityManager <DD class="implements"> implements XMLComponent <DD class="fields"> fields: <UL> <LI> EntityResolver fEntityResolver <LI> XMLEntityScanner fEntityReader <LI> XMLEntityHandler fEntityHandler </UL> <DD class="constructors"> constructors: <UL> <LI> XMLEntityManager ( ) </UL> <DD class="methods"> methods: <UL> <LI> setEntityHandler ( XMLEntityHandler entityHandler ) <LI> addExternalEntity ( String name, String publicId, String systemId, String baseSystemId ) <LI> addInternalEntity ( String name, String text ) <LI> addUnparsedEntity ( String name, String publicId, String systemId, String notation ) <LI> isDeclaredEntity ( String name ) : boolean <LI> isExternalEntity ( String name ) : boolean <LI> isUnparsedEntity ( String name ) : boolean <LI> setStandalone ( boolean standalone ) <LI> isStandalone ( ) : boolean <LI> expandSystemId ( String systemId ) : String <LI> expandSystemId ( String systemId, String baseSystemId ) : String <LI> resolveEntity ( String publicId, String systemId, String baseSystemId ) : XMLInputSource <LI> startDocumentEntity ( XMLInputSource inputSource ) <LI> startDTDEntity ( XMLInputSource inputSource ) <LI> startEntity ( String name, XMLInputSource inputSource ) <LI> getEntityScanner ( ) : XMLEntityScanner </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLEntityHandler"><DL class="interface"> <DT>interface XMLEntityHandler <DD class="methods"> methods: <UL> <LI> startEntity ( String name, String publicId, String systemId, String baseSystemId, String encoding ) <LI> endEntity ( String name ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLInputSource"><DL class="class"> <DT>class XMLInputSource <DD class="extends"> extends InputSource <DD class="constructors"> constructors: <UL> <LI> XMLInputSource ( ) <LI> XMLInputSource ( InputSource inputSource ) <LI> XMLInputSource ( Inputstream inputStream ) <LI> XMLInputSource ( Reader reader ) <LI> XMLInputSource ( String systemId ) </UL> <DD class="methods"> methods: <UL> <LI> setBaseSystemId ( String baseSystemId ) <LI> getBaseSystemId ( ) : String <LI> setExpandedSystemId ( String expandedSystemId ) <LI> getExpandedSystemId ( ) : String </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLEntityScanner"><DL class="class"> <DT>class XMLEntityScanner <DD class="implements"> implements Locator <DD class="methods"> methods: <UL> <LI> getBaseSystemId ( ) : String <LI> setEncoding ( String encoding ) <LI> isExternal ( ) : boolean <LI> peekChar ( ) : int <LI> scanChar ( ) : int <LI> scanNmtoken ( ) : String <LI> scanName ( ) : String <LI> scanQName ( QName qname ) : boolean <LI> scanContent ( XMLString content ) : int <LI> scanLiteral ( int quote, XMLString content ) : int <LI> scanData ( String delimiter, XMLString data ) : boolean <LI> skipChar ( int c ) : boolean <LI> skipSpaces ( ) : boolean <LI> skipString ( String s ) : boolean </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLValidator"><DL class="class"> <DT>class XMLValidator <DD class="implements"> implements XMLComponent, <DD class="fields"> fields: <UL> <LI> SymbolTable fSymbolTable <LI> XMLErrorReporter fErrorReporter <LI> GrammarPool fGrammarPool <LI>boolean fNamespaces <LI>boolean fValidation <LI>boolean fDynamicValidation <LI> XMLDocumentHandler fDocumentHandler </UL> <DD class="constructors"> constructors: <UL> <LI> XMLValidator ( ) </UL> </DL> </A></BLOCKQUOTE> <H3>Implementation: Validation</H3> <BLOCKQUOTE> <A name="GrammarPool"><DL class="class"> <DT>class GrammarPool <DD class="fields"> fields: <UL> <LI> Hashtable < Grammar > fGrammars <LI> Hashtable < Grammar > fGrammarsNS </UL> <DD class="constructors"> constructors: <UL> <LI> GrammarPool ( ) </UL> <DD class="methods"> methods: <UL> <LI> putGrammar ( String rootElement, Grammar grammar ) <LI> putGrammarNS ( String targetNamespace, Grammar grammar ) <LI> getGrammar ( String rootElement ) : Grammar <LI> getGrammarNS ( String targetNamespace ) : Grammar <LI> removeGrammar ( String rootElement ) : Grammar <LI> removeGrammarNS ( String targetNamespace ) : Grammar </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="Grammar"><DL class="class"> <DT>class Grammar <DD class="constants"> constants: <UL> <LI>int TOP_LEVEL_SCOPE </UL> <DD class="fields"> fields: <UL> <LI> String fTargetNamespace </UL> <DD class="constructors"> constructors: <UL> <LI> Grammar ( ) </UL> <DD class="methods"> methods: <UL> <LI> isNamespaceAware ( ) : boolean <LI> getTargetNamespace ( ) : String <LI> getElementDeclCount ( ) : int <LI> getElementDeclIndex ( QName elementDeclName, int scope ) : int <LI> getElementDeclAt ( int elementDeclIndex, XMLElementDecl elementDecl ) : boolean <LI> getAttributeDeclCount ( int elementDeclIndex ) : int <LI> getAttributeDeclIndex ( int elementDeclIndex, QName attributeDeclName ) : int <LI> getAttributeDeclAt ( int attributeDeclIndex, XMLAttributeDecl attributeDecl ) : boolean <LI> getEntityDeclCount ( ) : int <LI> getEntityDeclIndex ( String entityDeclName ) : int <LI> getEntityDeclAt ( int entityDeclIndex, XMLEntityDecl entityDecl ) : boolean <LI> getNotationDeclCount ( ) : int <LI> getNotationDeclIndex ( String notationDeclName ) : int <LI> getNotationDeclAt ( int notationDeclIndex, XMLNotationDecl notationDecl ) : boolean </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLElementDecl"><DL class="class"> <DT>class XMLElementDecl <DD class="constants"> constants: <UL> <LI>short TYPE_ANY <LI>short TYPE_EMPTY <LI>short TYPE_MIXED <LI>short TYPE_CHILDREN <LI>short TYPE_SIMPLE </UL> <DD class="fields"> fields: <UL> <LI> QName name <LI>int scope <LI>short type <LI> XMLSimpleType simpleType </UL> <DD class="methods"> methods: <UL> <LI> setValues ( QName name, int scope, short type, XMLSimpleType simpleType ) <LI> setValues ( XMLElementDecl elementDecl ) <LI> clear ( ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLAttributeDecl"><DL class="class"> <DT>class XMLAttributeDecl <DD class="fields"> fields: <UL> <LI> QName name <LI> XMLSimpleType simpleType <LI>boolean optional </UL> <DD class="methods"> methods: <UL> <LI> setValues ( QName name, XMLSimpleType simpleType, boolean optional ) <LI> setValues ( XMLAttributeDecl attributeDecl ) <LI> clear ( ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLSimpleType"><DL class="class"> <DT>class XMLSimpleType <DD class="constants"> constants: <UL> <LI>short TYPE_CDATA <LI>short TYPE_ENTITY <LI>short TYPE_ENUMERATION <LI>short TYPE_ID <LI>short TYPE_IDREF <LI>short TYPE_NMTOKEN <LI>short TYPE_NOTATION <LI>short TYPE_NAMED <LI>short DEFAULT_TYPE_DEFAULT <LI>short DEFAULT_TYPE_FIXED <LI>short DEFAULT_TYPE_IMPLIED <LI>short DEFAULT_TYPE_REQUIRED </UL> <DD class="fields"> fields: <UL> <LI>short type <LI> String name <LI> String[] enumeration <LI>boolean list <LI>short defaultType <LI> String defaultValue <LI> DatatypeValidator datatypeValidator </UL> <DD class="methods"> methods: <UL> <LI> setValues ( short type, String name, String[] enumeration, boolean list, short defaultType, String defaultValue, DatatypeValidator datatypeValidator ) <LI> setValues ( XMLSimpleType simpleType ) <LI> clear ( ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLEntityDecl"><DL class="class"> <DT>class XMLEntityDecl <DD class="fields"> fields: <UL> <LI> String name <LI> String publicId <LI> String systemId <LI> String baseSystemId <LI> String notation <LI>boolean isPE </UL> <DD class="methods"> methods: <UL> <LI> setValues ( String name, String publicId, String systemId, String baseSystemId, String notation, boolean isPE ) <LI> setValues ( XMLEntityDecl entityDecl ) <LI> clear ( ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLNotationDecl"><DL class="class"> <DT>class XMLNotationDecl <DD class="fields"> fields: <UL> <LI> String name <LI> String publicId <LI> String systemId </UL> <DD class="methods"> methods: <UL> <LI> setValues ( String name, String publicId, String systemId ) <LI> notationDecl ( XMLNotationDecl notationDecl ) <LI> clear ( ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="DatatypeValidatorFactory"><DL class="interface"> <DT>interface DatatypeValidatorFactory <DD class="methods"> methods: <UL> <LI> createDatatypeValidator ( String name, DatatypeValidator base, Hashtable < String > facets, boolean list ) : DatatypeValidator </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="DatatypeValidator"><DL class="interface"> <DT>interface DatatypeValidator <DD class="methods"> methods: <UL> <LI> getFacets ( ) : Hashtable < String > <LI> validate ( String data, Object state ) <LI> compare ( String value1, String value2 ) : int </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="InvalidDatatypeFacetException"><DL class="class"> <DT>class InvalidDatatypeFacetException <DD class="extends"> extends SAXException <DD class="constructors"> constructors: <UL> <LI> InvalidDatatypeFacetException ( ) <LI> InvalidDatatypeFacetException ( String message ) <LI> InvalidDatatypeFacetException ( Exception exception ) <LI> InvalidDatatypeFacetException ( String message, Exception exception ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="InvalidDatatypeValueException"><DL class="class"> <DT>class InvalidDatatypeValueException <DD class="extends"> extends SAXException <DD class="constructors"> constructors: <UL> <LI> InvalidDatatypeValueException ( ) <LI> InvalidDatatypeValueException ( String message ) <LI> InvalidDatatypeValueException ( Exception exception ) <LI> InvalidDatatypeValueException ( String message, Exception exception ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="ContentModelValidator"><DL class="interface"> <DT>interface ContentModelValidator <DD class="methods"> methods: <UL> <LI> validate ( QName[] children, int offset, int length ) : int </UL> </DL> </A></BLOCKQUOTE> <H3>Implementation: Validation Content Models</H3> <BLOCKQUOTE> <A name="SimpleContentModel"><DL class="class"> <DT>class SimpleContentModel <DD class="implements"> implements ContentModelValidator <DD class="constants"> constants: <UL> <LI>short CHOICE <LI>short SEQUENCE </UL> <DD class="fields"> fields: <UL> <LI>short fOperator <LI> QName fFirstChild <LI> QName fSecondChild </UL> <DD class="constructors"> constructors: <UL> <LI> SimpleContentModel ( short operator, QName firstChild, QName secondChild ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="MixedContentModel"><DL class="class"> <DT>class MixedContentModel <DD class="implements"> implements ContentModelValidator <DD class="fields"> fields: <UL> <LI>int fCount <LI> QName[] fChildren <LI>boolean fOrdered </UL> <DD class="constructors"> constructors: <UL> <LI> MixedContentModel ( int count, QName[] children, boolean ordered ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="DFAContentModel"><DL class="class"> <DT>class DFAContentModel <DD class="implements"> implements ContentModelValidator <DD class="constructors"> constructors: <UL> <LI> DFAContentModel ( ) </UL> </DL> </A></BLOCKQUOTE> <H3>Implementation: Validation Datatypes</H3> <BLOCKQUOTE> <A name="DatatypeValidatorFactoryImpl"><DL class="class"> <DT>class DatatypeValidatorFactoryImpl <DD class="implements"> implements DatatypeValidatorFactory <DD class="fields"> fields: <UL> <LI> Hashtable < DatatypeValidator > fBaseTypes </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="AbstractDatatypeValidator"><DL class="class"> <DT>class AbstractDatatypeValidator <DD class="implements"> implements DatatypeValidator <DD class="fields"> fields: <UL> <LI> Hashtable < String > fFacets </UL> <DD class="constructors"> constructors: <UL> <LI> AbstractDatatypeValidator ( DatatypeValidator base, Hashtable < String > facets, boolean list ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="StringDatatypeValidator"><DL class="class"> <DT>class StringDatatypeValidator <DD class="extends"> extends AbstractDatatypeValidator <DD class="constructors"> constructors: <UL> <LI> StringDatatypeValidator ( DatatypeValidator base, Hashtable < String > facets, boolean list ) </UL> </DL> </A></BLOCKQUOTE> <H3>Implementation: Validation Grammars</H3> <BLOCKQUOTE> <A name="DTDGrammar"><DL class="class"> <DT>class DTDGrammar <DD class="extends"> extends Grammar <DD class="implements"> implements , <DD class="fields"> fields: <UL> <LI> XMLDTDHandler fDTDHandler <LI> XMLDTDContentModelHandler fDTDContentModelHandler </UL> <DD class="constructors"> constructors: <UL> <LI> DTDGrammar ( ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="SchemaGrammar"><DL class="class"> <DT>class SchemaGrammar <DD class="extends"> extends Grammar <DD class="constructors"> constructors: <UL> <LI> SchemaGrammar ( ) <LI> SchemaGrammar ( Document grammarDocument ) <LI> SchemaGrammar ( Document grammarDocument, GrammarPool grammarPool ) </UL> </DL> </A></BLOCKQUOTE> <H3>Validation: XPath</H3> <BLOCKQUOTE> <A name="XPath"><DL class="class"> <DT>class XPath <DD class="constructors"> constructors: <UL> <LI> XPath ( String xpath ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XPathException"><DL class="class"> <DT>class XPathException <DD class="constructors"> constructors: <UL> <LI> XPathException ( ) <LI> XPathException ( String message ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XPathMatcher"><DL class="class"> <DT>class XPathMatcher <DD class="implements"> implements XMLDocumentFragmentHandler <DD class="fields"> fields: <UL> <LI>boolean fShouldBufferContent </UL> <DD class="constructors"> constructors: <UL> <LI> XPathMatcher ( XPath xpath ) <LI> XPathMatcher ( XPath xpath, boolean shouldBufferContent ) </UL> <DD class="methods"> methods: <UL> <LI> isMatched ( ) : boolean <LI> getMatchedString ( ) : String <LI> matched ( String content ) </UL> </DL> </A></BLOCKQUOTE> <H3>Validation: Identity Constraints</H3> <BLOCKQUOTE> <A name="IdentityConstraint"><DL class="class"> <DT>class IdentityConstraint <DD class="constants"> constants: <UL> <LI>short UNIQUE <LI>short KEY <LI>short KEYREF </UL> <DD class="fields"> fields: <UL> <LI> String fElementName <LI> Selector fSelector <LI> Hashtable < Field > fFields </UL> <DD class="constructors"> constructors: <UL> <LI> IdentityConstraint ( String elementName ) </UL> <DD class="methods"> methods: <UL> <LI> getType ( ) : short <LI> getElementName ( ) : String <LI> setSelector ( Selector selector ) <LI> getSelector ( ) : Selector <LI> addField ( Field field ) <LI> getFieldCount ( ) : int <LI> getFieldAt ( int index ) : Field </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="Unique"><DL class="class"> <DT>class Unique <DD class="constructors"> constructors: <UL> <LI> Unique ( String elementName ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="Key"><DL class="class"> <DT>class Key <DD class="fields"> fields: <UL> <LI> String fKeyName </UL> <DD class="constructors"> constructors: <UL> <LI> Key ( String elementName, String keyName ) </UL> <DD class="methods"> methods: <UL> <LI> getKeyName ( ) : String </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="KeyRef"><DL class="class"> <DT>class KeyRef <DD class="fields"> fields: <UL> <LI> String fKeyName </UL> <DD class="constructors"> constructors: <UL> <LI> KeyRef ( String elementName, String keyName ) </UL> <DD class="methods"> methods: <UL> <LI> getKeyName ( ) : String </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="Selector"><DL class="class"> <DT>class Selector <DD class="fields"> fields: <UL> <LI> XPath fXPath <LI> IdentityConstraint fIdentityConstraint </UL> <DD class="constructors"> constructors: <UL> <LI> Selector ( XPath xpath, IdentityConstraint identityConstraint ) </UL> <DD class="methods"> methods: <UL> <LI> getXPath ( ) : XPath <LI> getIdentityConstraint ( ) : IdentityConstraint <LI> createMatcher ( FieldActivator fieldActivator ) : XPathMatcher </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="FieldActivator"><DL class="interface"> <DT>interface FieldActivator <DD class="methods"> methods: <UL> <LI> startValueScopeFor ( IdentityConstraint identityConstraint ) <LI> activateField ( Field field ) <LI> endValueScopeFor ( IdentityConstraint identityConstraint ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="Field"><DL class="class"> <DT>class Field <DD class="fields"> fields: <UL> <LI> XPath fXPath <LI> IdentityConstraint fIdentityConstraint <LI> DatatypeValidator fDatatypeValidator </UL> <DD class="constructors"> constructors: <UL> <LI> Field ( XPath xpath, IdentityConstraint identityConstraint, DatatypeValidator datatypeValidator ) </UL> <DD class="methods"> methods: <UL> <LI> getXPath ( ) : XPath <LI> getIdentityConstraint ( ) : IdentityConstraint <LI> getDatatypeValidator ( ) : DatatypeValidator <LI> createMatcher ( ValueStore valueStore ) : XPathMatcher </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="ValueStore"><DL class="interface"> <DT>interface ValueStore <DD class="methods"> methods: <UL> <LI> addValue ( Field field, String value ) </UL> </DL> </A></BLOCKQUOTE> <H3>Parsing</H3> <BLOCKQUOTE> <A name="CachingParserPool"><DL class="class"> <DT>class CachingParserPool <DD class="fields"> fields: <UL> <LI> SymbolTable fSymbolTable <LI> GrammarPool fGrammarPool </UL> <DD class="constructors"> constructors: <UL> <LI> CachingParserPool ( ) <LI> CachingParserPool ( SymbolTable symbolTable, GrammarPool grammarPool ) </UL> <DD class="methods"> methods: <UL> <LI> getSymbolTable ( ) : SymbolTable <LI> getGrammarPool ( ) : GrammarPool <LI> createDOMParser ( ) : DOMParser <LI> createSAXParser ( ) : SAXParser </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLParser"><DL class="class"> <DT>class XMLParser <DD class="implements"> implements XMLComponentManager <DD class="fields"> fields: <UL> <LI> SymbolTable fSymbolTable <LI> XMLEntityManager fEntityManager <LI> XMLErrorReporter fErrorReporter <LI>boolean fNamespaces <LI>boolean fValidation <LI>boolean fDynamicValidation <LI>boolean fContinueAfterFatalError </UL> <DD class="constructors"> constructors: <UL> <LI> XMLParser ( ) <LI> XMLParser ( SymbolTable symbolTable ) </UL> <DD class="methods"> methods: <UL> <LI> setFeature ( String featureId, boolean state ) <LI> getFeature ( String featureId ) : boolean <LI> setProperty ( String propertyId, Object value ) <LI> getProperty ( String propertyId ) : Object <LI> setEntityResolver ( EntityResolver entityResolver ) <LI> setErrorHandler ( ErrorHandler errorHandler ) <LI> parse ( String systemId ) <LI> parse ( InputSource inputSource ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLDocumentParser"><DL class="class"> <DT>class XMLDocumentParser <DD class="extends"> extends XMLParser <DD class="implements"> implements XMLDocumentHandler, XMLDTDHandler, XMLDTDContentModelHandler <DD class="fields"> fields: <UL> <LI> XMLDocumentScanner fScanner <LI> XMLDTDScanner fDTDScanner <LI> XMLValidator fValidator <LI> GrammarPool fGrammarPool <LI> DatatypeValidatorFactory fDatatypeValidatorFactory </UL> <DD class="constructors"> constructors: <UL> <LI> XMLDocumentParser ( ) <LI> XMLDocumentParser ( SymbolTable symbolTable, GrammarPool grammarPool ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="DOMParser"><DL class="class"> <DT>class DOMParser <DD class="extends"> extends XMLDocumentParser <DD class="constructors"> constructors: <UL> <LI> DOMParser ( ) <LI> DOMParser ( SymbolTable symbolTable, GrammarPool grammarPool ) </UL> <DD class="methods"> methods: <UL> <LI> getDocument ( ) : Document </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="SAXParser"><DL class="class"> <DT>class SAXParser <DD class="extends"> extends XMLDocumentParser <DD class="implements"> implements Parser, XMLReader <DD class="constructors"> constructors: <UL> <LI> SAXParser ( ) <LI> SAXParser ( SymbolTable symbolTable, GrammarPool grammarPool ) </UL> </DL> </A></BLOCKQUOTE> <H3>Utility Interfaces and Classes</H3> <BLOCKQUOTE> <A name="XMLChar"><DL class="class"> <DT>class XMLChar <DD class="constants"> constants: <UL> <LI>byte[] CHARS <LI>byte MASK_VALID <LI>byte MASK_SPACE <LI>byte MASK_NAME_START <LI>byte MASK_NAME <LI>byte MASK_PUBID <LI>byte MASK_CONTENT </UL> <DD class="methods"> methods: <UL> <LI> isValid ( int c ) : boolean <LI> isInvalid ( int c ) : boolean <LI> isSpace ( int c ) : boolean <LI> isNameStart ( int c ) : boolean <LI> isName ( int c ) : boolean <LI> isPubid ( int c ) : boolean <LI> isContent ( int c ) : boolean <LI> isMarkup ( int c ) : boolean <LI> isHighSurrogate ( int c ) : boolean <LI> isLowSurrogate ( int c ) : boolean <LI> isSupplemental ( int c ) : boolean <LI> highSurrogate ( int c ) : char <LI> lowSurrogate ( int c ) : char <LI> supplemental ( int highSurrogate, int lowSurrogate ) : int <LI> isValidName ( String name ) : boolean <LI> isValidIANAEncoding ( String encoding ) : boolean <LI> isValidJavaEncoding ( String encoding ) : boolean </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="EncodingMap"><DL class="class"> <DT>class EncodingMap <DD class="fields"> fields: <UL> <LI> Hashtable < String > fIANA2JavaMap <LI> Hashtable < String > fJava2IANAMap </UL> <DD class="constructors"> constructors: <UL> <LI> EncodingMap ( ) </UL> <DD class="methods"> methods: <UL> <LI> putIANA2JavaMapping ( String ianaEncoding, String javaEncoding ) <LI> getIANA2JavaMapping ( String ianaEncoding ) : String <LI> removeIANA2JavaMapping ( String ianaEncoding ) : String <LI> putJava2IANAMapping ( String javaEncoding, String ianaEncoding ) <LI> getJava2IANAMapping ( String javaEncoding ) : String <LI> removeJava2IANAMapping ( String javaEncoding ) : String </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="SymbolTable"><DL class="class"> <DT>class SymbolTable <DD class="constructors"> constructors: <UL> <LI> SymbolTable ( ) </UL> <DD class="methods"> methods: <UL> <LI> addSymbol ( String symbol ) : String <LI> addSymbol ( char[] buffer, int offset, String length ) : String <LI> containsSymbol ( String symbol ) : boolean <LI> containsSymbol ( char[] buffer, int offset, String length ) : boolean <LI> hash ( String symbol ) : int <LI> hash ( char[] buffer, int offset, int length ) : int </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="MessageFormatter"><DL class="interface"> <DT>interface MessageFormatter <DD class="methods"> methods: <UL> <LI> formatMessage ( Locale locale, String key, Object[] arguments ) : String </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLStringBuffer"><DL class="class"> <DT>class XMLStringBuffer <DD class="extends"> extends XMLString <DD class="constants"> constants: <UL> <LI>int DEFAULT_SIZE </UL> <DD class="constructors"> constructors: <UL> <LI> XMLStringBuffer ( ) <LI> XMLStringBuffer ( int size ) </UL> <DD class="methods"> methods: <UL> <LI> clear ( ) <LI> append ( char c ) <LI> append ( String s ) <LI> append ( char[] ch, int offset, int length ) <LI> append ( XMLString s ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="XMLAttributesImpl"><DL class="class"> <DT>class XMLAttributesImpl <DD class="implements"> implements XMLAttributes <DD class="fields"> fields: <UL> <LI>boolean fNamespaces </UL> <DD class="constructors"> constructors: <UL> <LI> XMLAttributesImpl ( ) </UL> <DD class="methods"> methods: <UL> <LI> setNamespaces ( boolean namespaces ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="NamespaceSupport"><DL class="class"> <DT>class NamespaceSupport <DD class="implements"> implements NamespaceContext <DD class="constructors"> constructors: <UL> <LI> NamespaceSupport ( ) <LI> NamespaceSupport ( NamespaceContext context ) </UL> <DD class="methods"> methods: <UL> <LI> pushContext ( ) <LI> declarePrefix ( String prefix, String uri ) <LI> popContext ( ) </UL> </DL> </A></BLOCKQUOTE> <BLOCKQUOTE> <A name="DefaultErrorHandler"><DL class="class"> <DT>class DefaultErrorHandler <DD class="implements"> implements ErrorHandler <DD class="constructors"> constructors: <UL> <LI> DefaultErrorHandler ( ) </UL> </DL> </A></BLOCKQUOTE> Last modified: $Date$</BODY> </HTML>

design/design.html (2,368 lines of code) (raw):