File	Doc	Category	Size	Date	Package
AbstractXMLDocumentParser.java	API Doc	Java SE 5 API	33336	Fri Aug 26 14:55:54 BST 2005	com.sun.org.apache.xerces.internal.parsers

AbstractXMLDocumentParser

• java.lang.Object
  • com.sun.org.apache.xerces.internal.parsers.XMLParser

Fields Summary
protected boolean	fInDTD True if inside DTD.
protected XMLDocumentSource	fDocumentSource Document source
protected XMLDTDSource	fDTDSource DTD source
protected XMLDTDContentModelSource	fDTDContentModelSource DTD content model source

Constructors Summary
protected AbstractXMLDocumentParser(XMLParserConfiguration config) Constructs a document parser using the default symbol table and grammar pool. super(config); // set handlers config.setDocumentHandler(this); config.setDTDHandler(this); config.setDTDContentModelHandler(this);

Methods Summary
public void	any(com.sun.org.apache.xerces.internal.xni.Augmentations augs) A content model of ANY. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error. see #empty see #startGroup
public void	attributeDecl(java.lang.String elementName, java.lang.String attributeName, java.lang.String type, java.lang.String[] enumeration, java.lang.String defaultType, com.sun.org.apache.xerces.internal.xni.XMLString defaultValue, com.sun.org.apache.xerces.internal.xni.XMLString nonNormalizedDefaultValue, com.sun.org.apache.xerces.internal.xni.Augmentations augs) An attribute declaration. param elementName The name of the element that this attribute is associated with. param attributeName The name of the attribute. param type The attribute type. This value will be one of the following: "CDATA", "ENTITY", "ENTITIES", "ENUMERATION", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", or "NOTATION". param enumeration If the type has the value "ENUMERATION" or "NOTATION", this array holds the allowed attribute values; otherwise, this array is null. param defaultType The attribute default type. This value will be one of the following: "#FIXED", "#IMPLIED", "#REQUIRED", or null. param defaultValue The attribute default value, or null if no default value is specified. param nonNormalizedDefaultValue The attribute default value with no normalization performed, or null if no default value is specified. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	characters(com.sun.org.apache.xerces.internal.xni.XMLString text, com.sun.org.apache.xerces.internal.xni.Augmentations augs) Character content. param text The content. param augs Additional information that may include infoset augmentations throws XNIException Thrown by handler to signal an error.
public void	comment(com.sun.org.apache.xerces.internal.xni.XMLString text, com.sun.org.apache.xerces.internal.xni.Augmentations augs) A comment. param text The text in the comment. param augs Additional information that may include infoset augmentations exception XNIException Thrown by application to signal an error.
public void	doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.String systemId, com.sun.org.apache.xerces.internal.xni.Augmentations augs) Notifies of the presence of the DOCTYPE line in the document. param rootElement The name of the root element. param publicId The public identifier if an external DTD or null if the external DTD is specified using SYSTEM. param systemId The system identifier if an external DTD, null param augs Additional information that may include infoset augmentations otherwise. throws XNIException Thrown by handler to signal an error.
public void	element(java.lang.String elementName, com.sun.org.apache.xerces.internal.xni.Augmentations augs) A referenced element in a mixed or children content model. param elementName The name of the referenced element. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	elementDecl(java.lang.String name, java.lang.String contentModel, com.sun.org.apache.xerces.internal.xni.Augmentations augs) An element declaration. param name The name of the element. param contentModel The element content model. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	empty(com.sun.org.apache.xerces.internal.xni.Augmentations augs) A content model of EMPTY. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error. see #any see #startGroup
public void	emptyElement(com.sun.org.apache.xerces.internal.xni.QName element, com.sun.org.apache.xerces.internal.xni.XMLAttributes attributes, com.sun.org.apache.xerces.internal.xni.Augmentations augs) An empty element. param element The name of the element. param attributes The element attributes. param augs Additional information that may include infoset augmentations throws XNIException Thrown by handler to signal an error. startElement(element, attributes, augs); endElement(element, augs);
public void	endAttlist(com.sun.org.apache.xerces.internal.xni.Augmentations augs) The end of an attribute list. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	endCDATA(com.sun.org.apache.xerces.internal.xni.Augmentations augs) The end of a CDATA section. param augs Additional information that may include infoset augmentations throws XNIException Thrown by handler to signal an error.
public void	endConditional(com.sun.org.apache.xerces.internal.xni.Augmentations augs) The end of a conditional section. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	endContentModel(com.sun.org.apache.xerces.internal.xni.Augmentations augs) The end of a content model. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	endDTD(com.sun.org.apache.xerces.internal.xni.Augmentations augs) The end of the DTD. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error. fInDTD = false;
public void	endDocument(com.sun.org.apache.xerces.internal.xni.Augmentations augs) The end of the document. param augs Additional information that may include infoset augmentations throws XNIException Thrown by handler to signal an error.
public void	endElement(com.sun.org.apache.xerces.internal.xni.QName element, com.sun.org.apache.xerces.internal.xni.Augmentations augs) The end of an element. param element The name of the element. param augs Additional information that may include infoset augmentations throws XNIException Thrown by handler to signal an error.
public void	endExternalSubset(com.sun.org.apache.xerces.internal.xni.Augmentations augmentations) The end of the DTD external subset. param augmentations Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	endGeneralEntity(java.lang.String name, com.sun.org.apache.xerces.internal.xni.Augmentations augs) This method notifies the end of an entity. Note: This method is not called for entity references appearing as part of attribute values. param name The name of the entity. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	endGroup(com.sun.org.apache.xerces.internal.xni.Augmentations augs) The end of a group for mixed or children content models. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	endParameterEntity(java.lang.String name, com.sun.org.apache.xerces.internal.xni.Augmentations augs) This method notifies the end of an entity. Note: This method is not called for entity references appearing as part of attribute values. param name The name of the entity. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	externalEntityDecl(java.lang.String name, com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier identifier, com.sun.org.apache.xerces.internal.xni.Augmentations augs) An external entity declaration. param name The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name. param identifier An object containing all location information pertinent to this entity. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public com.sun.org.apache.xerces.internal.xni.parser.XMLDTDContentModelSource	getDTDContentModelSource() return fDTDContentModelSource;
public com.sun.org.apache.xerces.internal.xni.parser.XMLDTDSource	getDTDSource() return fDTDSource;
public com.sun.org.apache.xerces.internal.xni.parser.XMLDocumentSource	getDocumentSource() Returns the document source return fDocumentSource;
public void	ignorableWhitespace(com.sun.org.apache.xerces.internal.xni.XMLString text, com.sun.org.apache.xerces.internal.xni.Augmentations augs) 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. param text The ignorable whitespace. param augs Additional information that may include infoset augmentations throws XNIException Thrown by handler to signal an error.
public void	ignoredCharacters(com.sun.org.apache.xerces.internal.xni.XMLString text, com.sun.org.apache.xerces.internal.xni.Augmentations augs) Characters within an IGNORE conditional section. param text The ignored text. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	internalEntityDecl(java.lang.String name, com.sun.org.apache.xerces.internal.xni.XMLString text, com.sun.org.apache.xerces.internal.xni.XMLString nonNormalizedText, com.sun.org.apache.xerces.internal.xni.Augmentations augs) An internal entity declaration. param name The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name. param text The value of the entity. param nonNormalizedText The non-normalized value of the entity. This value contains the same sequence of characters that was in the internal entity declaration, without any entity references expanded. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	notationDecl(java.lang.String name, com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier identifier, com.sun.org.apache.xerces.internal.xni.Augmentations augs) A notation declaration param name The name of the notation. param identifier An object containing all location information pertinent to this notation. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	occurrence(short occurrence, com.sun.org.apache.xerces.internal.xni.Augmentations augs) The occurrence count for a child in a children content model or for the mixed content model group. param occurrence The occurrence count for the last element or group. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error. see #OCCURS_ZERO_OR_ONE see #OCCURS_ZERO_OR_MORE see #OCCURS_ONE_OR_MORE
public void	pcdata(com.sun.org.apache.xerces.internal.xni.Augmentations augs) The appearance of "#PCDATA" within a group signifying a mixed content model. This method will be the first called following the content model's startGroup(). param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error. see #startGroup
public void	processingInstruction(java.lang.String target, com.sun.org.apache.xerces.internal.xni.XMLString data, com.sun.org.apache.xerces.internal.xni.Augmentations augs) 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. param target The target. param data The data or null if none specified. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
protected void	reset() reset all components before parsing super.reset(); fInDTD = false;
public void	separator(short separator, com.sun.org.apache.xerces.internal.xni.Augmentations augs) The separator between choices or sequences of a mixed or children content model. param separator The type of children separator. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error. see #SEPARATOR_CHOICE see #SEPARATOR_SEQUENCE
public void	setDTDContentModelSource(com.sun.org.apache.xerces.internal.xni.parser.XMLDTDContentModelSource source) fDTDContentModelSource = source;
public void	setDTDSource(com.sun.org.apache.xerces.internal.xni.parser.XMLDTDSource source) fDTDSource = source;
public void	setDocumentSource(com.sun.org.apache.xerces.internal.xni.parser.XMLDocumentSource source) Sets the document source fDocumentSource = source;
public void	startAttlist(java.lang.String elementName, com.sun.org.apache.xerces.internal.xni.Augmentations augs) The start of an attribute list. param elementName The name of the element that this attribute list is associated with. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	startCDATA(com.sun.org.apache.xerces.internal.xni.Augmentations augs) The start of a CDATA section. param augs Additional information that may include infoset augmentations throws XNIException Thrown by handler to signal an error.
public void	startConditional(short type, com.sun.org.apache.xerces.internal.xni.Augmentations augs) The start of a conditional section. param type The type of the conditional section. This value will either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error. see #CONDITIONAL_INCLUDE see #CONDITIONAL_IGNORE
public void	startContentModel(java.lang.String elementName, com.sun.org.apache.xerces.internal.xni.Augmentations augs) The start of a content model. Depending on the type of the content model, specific methods may be called between the call to the startContentModel method and the call to the endContentModel method. param elementName The name of the element. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	startDTD(com.sun.org.apache.xerces.internal.xni.XMLLocator locator, com.sun.org.apache.xerces.internal.xni.Augmentations augs) The start of the DTD. param locator The document locator, or null if the document location cannot be reported during the parsing of the document DTD. However, it is strongly recommended that a locator be supplied that can at least report the base system identifier of the DTD. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error. fInDTD = true;
public void	startDocument(com.sun.org.apache.xerces.internal.xni.XMLLocator locator, java.lang.String encoding, com.sun.org.apache.xerces.internal.xni.NamespaceContext namespaceContext, com.sun.org.apache.xerces.internal.xni.Augmentations augs) The start of the document. param locator The system identifier of the entity if the entity is external, null otherwise. param 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). param 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. param augs Additional information that may include infoset augmentations throws XNIException Thrown by handler to signal an error.
public void	startElement(com.sun.org.apache.xerces.internal.xni.QName element, com.sun.org.apache.xerces.internal.xni.XMLAttributes attributes, com.sun.org.apache.xerces.internal.xni.Augmentations augs) The start of an element. If the document specifies the start element by using an empty tag, then the startElement method will immediately be followed by the endElement method, with no intervening methods. param element The name of the element. param attributes The element attributes. param augs Additional information that may include infoset augmentations throws XNIException Thrown by handler to signal an error.
public void	startExternalSubset(com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier identifier, com.sun.org.apache.xerces.internal.xni.Augmentations augmentations) The start of the DTD external subset. param augmentations Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	startGeneralEntity(java.lang.String name, com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier identifier, java.lang.String encoding, com.sun.org.apache.xerces.internal.xni.Augmentations augs) This method notifies the start of an entity. Note: This method is not called for entity references appearing as part of attribute values. param name The name of the entity. param identifier The resource identifier. param 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). param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	startGroup(com.sun.org.apache.xerces.internal.xni.Augmentations augs) A start of either a mixed or children content model. A mixed content model will immediately be followed by a call to the pcdata() method. A children content model will contain additional groups and/or elements. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error. see #any see #empty
public void	startParameterEntity(java.lang.String name, com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier identifier, java.lang.String encoding, com.sun.org.apache.xerces.internal.xni.Augmentations augs) This method notifies the start of an entity. Note: This method is not called for entity references appearing as part of attribute values. param name The name of the entity. param identifier The resource identifier. param 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). param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	textDecl(java.lang.String version, java.lang.String encoding, com.sun.org.apache.xerces.internal.xni.Augmentations augs) 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. param version The XML version, or null if not specified. param encoding The IANA encoding name of the entity. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	unparsedEntityDecl(java.lang.String name, com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier identifier, java.lang.String notation, com.sun.org.apache.xerces.internal.xni.Augmentations augs) An unparsed entity declaration. param name The name of the entity. param identifier An object containing all location information pertinent to this entity. param notation The name of the notation. param augs Additional information that may include infoset augmentations. throws XNIException Thrown by handler to signal an error.
public void	xmlDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone, com.sun.org.apache.xerces.internal.xni.Augmentations augs) Notifies of the presence of an XMLDecl line in the document. If present, this method will be called immediately following the startDocument call. param version The XML version. param encoding The IANA encoding name of the document, or null if not specified. param standalone The standalone value, or null if not specified. param augs Additional information that may include infoset augmentations throws XNIException Thrown by handler to signal an error.