|
Xerces 1.3.1 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
This interface must be implemented by the users of the XMLDTDScanner class. These methods form the abstraction between the implementation semantics and the more generic task of scanning the DTD-specific XML grammar.
| Method Summary | |
int |
addAttDef(org.apache.xerces.utils.QName elementDecl,
org.apache.xerces.utils.QName attributeDecl,
int attType,
boolean attList,
int enumeration,
int attDefaultType,
int attDefaultValue,
boolean isExternal)
Add an attribute definition |
int |
addContentSpecNode(int nodeType,
int nodeValue)
Create an XMLContentSpec for a single non-leaf |
int |
addContentSpecNode(int nodeType,
int leftNodeIndex,
int rightNodeIndex)
Create an XMLContentSpec for a two child leaf |
int |
addElementDecl(org.apache.xerces.utils.QName elementDecl)
Add an element declaration (forward reference) |
int |
addElementDecl(org.apache.xerces.utils.QName elementDecl,
int contentSpecType,
int contentSpec,
boolean isExternal)
Add an element declaration |
int |
addExternalEntityDecl(int name,
int publicId,
int systemId)
Add a declaration for an entity |
int |
addExternalPEDecl(int name,
int publicId,
int systemId)
Add a declaration for an external parameter entity |
int |
addInternalEntityDecl(int name,
int value)
Add a declaration for an internal entity |
int |
addInternalPEDecl(int name,
int value)
Add a declaration for an internal parameter entity |
void |
addNameToEnumeration(int enumIndex,
int elementType,
int attrName,
int nameIndex,
boolean isNotationType)
Add a name to an enumeration |
int |
addNotationDecl(int notationName,
int publicId,
int systemId)
Add a declaration for a notation |
int |
addUniqueLeafNode(int nameIndex)
create an XMLContentSpec for a leaf |
int |
addUnparsedEntityDecl(int name,
int publicId,
int systemId,
int notationName)
Add a declaration for an unparsed entity |
void |
callComment(int data)
Called when a comment has been scanned |
void |
callEndDTD()
End of DTD. |
void |
callProcessingInstruction(int piTarget,
int piData)
Called when a processing instruction has been scanned |
void |
callStartDTD()
Start of DTD. |
void |
callTextDecl(int version,
int encoding)
Signal the Text declaration of an external entity. |
void |
doctypeDecl(org.apache.xerces.utils.QName rootElement,
int publicId,
int systemId)
Called when the doctype decl is scanned |
void |
endEntityDecl()
End the scope of an entity declaration. |
void |
endEnumeration(int enumIndex)
Finish processing an enumeration |
java.lang.String |
getContentSpecNodeAsString(int nodeIndex)
Create a string representation of an XMLContentSpec tree |
void |
internalSubset(int internalSubset)
Supports DOM Level 2 internalSubset additions. |
boolean |
startEntityDecl(boolean isPE,
int entityName)
Start the scope of an entity declaration. |
int |
startEnumeration()
Called when the scanner start scanning an enumeration |
void |
startReadingFromExternalSubset(int publicId,
int systemId)
Called when the DTDScanner starts reading from the external subset |
void |
stopReadingFromExternalSubset()
Called when the DTDScanner stop reading from the external subset |
| Method Detail |
public void callStartDTD()
throws java.lang.Exception
public void callEndDTD()
throws java.lang.Exception
public void callTextDecl(int version,
int encoding)
throws java.lang.Exception
version - the handle in the string pool for the version numberencoding - the handle in the string pool for the encoding
public void doctypeDecl(org.apache.xerces.utils.QName rootElement,
int publicId,
int systemId)
throws java.lang.Exception
rootElementType - handle of the rootElementpublicId - StringPool handle of the public idsystemId - StringPool handle of the system id
public void startReadingFromExternalSubset(int publicId,
int systemId)
throws java.lang.Exception
publicId - StringPool handle of the public idsystemId - StringPool handle of the system id
public void stopReadingFromExternalSubset()
throws java.lang.Exception
public int addElementDecl(org.apache.xerces.utils.QName elementDecl)
throws java.lang.Exception
handle - to the name of the element being declared
public int addElementDecl(org.apache.xerces.utils.QName elementDecl,
int contentSpecType,
int contentSpec,
boolean isExternal)
throws java.lang.Exception
handle - to the name of the element being declaredcontentSpecType - handle to the type name of the content specContentSpec - handle to the content spec node for the contentSpecType
public int addAttDef(org.apache.xerces.utils.QName elementDecl,
org.apache.xerces.utils.QName attributeDecl,
int attType,
boolean attList,
int enumeration,
int attDefaultType,
int attDefaultValue,
boolean isExternal)
throws java.lang.Exception
handle - to the element whose attribute is being declaredattName - StringPool handle to the attribute name being declaredattType - type of the attributeenumeration - StringPool handle of the attribute's enumeration list (if any)attDefaultType - an integer value denoting the DefaultDecl valueattDefaultValue - StringPool handle of this attribute's default value
public int addUniqueLeafNode(int nameIndex)
throws java.lang.Exception
nameIndex - StringPool handle to the name (Element) for the node
public int addContentSpecNode(int nodeType,
int nodeValue)
throws java.lang.Exception
nodeType - the type of XMLContentSpec to create - from XMLContentSpec.CONTENTSPECNODE_*nodeValue - handle to an XMLContentSpec
public int addContentSpecNode(int nodeType,
int leftNodeIndex,
int rightNodeIndex)
throws java.lang.Exception
nodeType - the type of XMLContentSpec to create - from XMLContentSpec.CONTENTSPECNODE_*leftNodeIndex - handle to an XMLContentSpecrightNodeIndex - handle to an XMLContentSpec
public java.lang.String getContentSpecNodeAsString(int nodeIndex)
throws java.lang.Exception
handle - to an XMLContentSpec
public boolean startEntityDecl(boolean isPE,
int entityName)
throws java.lang.Exception
true on success; otherwise
false if the entity declaration is recursive.
public void endEntityDecl()
throws java.lang.Exception
public int addInternalPEDecl(int name,
int value)
throws java.lang.Exception
name - StringPool handle of the parameter entity namevalue - StringPool handle of the parameter entity value
public int addExternalPEDecl(int name,
int publicId,
int systemId)
throws java.lang.Exception
name - StringPool handle of the parameter entity namepublicId - StringPool handle of the publicIdsystemId - StringPool handle of the systemId
public int addInternalEntityDecl(int name,
int value)
throws java.lang.Exception
name - StringPool handle of the entity namevalue - StringPool handle of the entity value
public int addExternalEntityDecl(int name,
int publicId,
int systemId)
throws java.lang.Exception
name - StringPool handle of the entity namepublicId - StringPool handle of the publicIdsystemId - StringPool handle of the systemId
public int addUnparsedEntityDecl(int name,
int publicId,
int systemId,
int notationName)
throws java.lang.Exception
name - StringPool handle of the entity namepublicId - StringPool handle of the publicIdsystemId - StringPool handle of the systemIdnotationName - StringPool handle of the notationName
public int startEnumeration()
throws java.lang.Exception
public void addNameToEnumeration(int enumIndex,
int elementType,
int attrName,
int nameIndex,
boolean isNotationType)
throws java.lang.Exception
enumIndex - StringPool handle to the string list for the enumerationelementType - handle to the element that owns the attribute with the enumerationattrName - StringPool handle to the name of the attribut with the enumerationnameIndex - StringPool handle to the name to be added to the enumerationisNotationType - true if the enumeration is an enumeration of NOTATION names
public void endEnumeration(int enumIndex)
throws java.lang.Exception
enumIndex - handle to the string list which holds the enumeration to be finshed.
public int addNotationDecl(int notationName,
int publicId,
int systemId)
throws java.lang.Exception
notationName - publicId - systemId -
public void callComment(int data)
throws java.lang.Exception
data - StringPool handle of the comment text
public void callProcessingInstruction(int piTarget,
int piData)
throws java.lang.Exception
piTarget - StringPool handle of the PI targetpiData - StringPool handle of the PI data
public void internalSubset(int internalSubset)
throws java.lang.Exception
|
Xerces 1.3.1 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||