|
| |
|
| org.apache.xerces.readers.XMLEntityHandler
All known Subclasses: org.apache.xerces.utils.ChunkyCharArray, org.apache.xerces.validators.common.XMLValidator, org.apache.xerces.readers.XMLEntityReader, org.apache.xerces.readers.DefaultEntityHandler,
| XMLEntityHandler | | public interface XMLEntityHandler extends Locator(Code) | | This is the interface used for entity management. This interface
is typically implemented by the "parser" class to provide entity
management services for the scanner classes.
version:
$Id: XMLEntityHandler.java,v 1.3 2000/05/17 18:32:44 jeffreyr Exp $ |
| Inner Class :public interface DTDHandler | |
| Inner Class :public interface CharBuffer | |
| Inner Class :public interface CharDataHandler | |
| Inner Class :public interface EntityReader | |
| Method Summary | |
| public EntityReader | changeReaders()
This method is called by the reader subclasses at the
end of input. | | public String | expandSystemId(String systemId)
Expand the system identifier relative to the entity that we are processing. | | public XMLEntityHandler.CharDataHandler | getCharDataHandler()
Get the character data handler. | | public EntityReader | getEntityReader()
Return the current reader. | | public int | getReaderDepth()
Return the depth set for the current reader. | | public int | getReaderId()
Return a unique identifier for the current reader. | | public void | setCharDataHandler(XMLEntityHandler.CharDataHandler charDataHandler)
Set the character data handler. | | public void | setReaderDepth(int depth)
Set the depth for the current reader. | | public boolean | startReadingFromDocument(InputSource source)
Start reading document from an InputSource.
Parameters:
source - The input source for the document to process. | | public boolean | startReadingFromEntity(int entityName, int readerDepth, int entityContext)
Start reading from this entity.
Note that the reader depth is not used by the reader, but is made
available so that it may be retrieved at end of input to test that
gramatical structures are properly nested within entities.
Parameters:
entityName - The entity name handle in the string pool.
Parameters:
readerDepth - The depth to associate with the reader for this entity.
Parameters:
context - The context of the entity reference; see ENTITYREF_IN_*. |
| ATTVALUE_RESULT_COMPLEXATTVALUE_RESULT_LESSTHANATTVALUE_RESULT_INVALID_CHAR | | final public static int ATTVALUE_RESULT_COMPLEXATTVALUE_RESULT_LESSTHANATTVALUE_RESULT_INVALID_CHAR(Code) | | Special return values for scanAttValue method. The normal return
value is a StringPool handle for a simple AttValue that was already
correctly normalized for CDATA in the original document. These
other return values either indicate an error or that the AttValue
needs further processing.
|
| CHARREF_RESULT_SEMICOLON_REQUIREDCHARREF_RESULT_INVALID_CHARCHARREF_RESULT_OUT_OF_RANGE | | final public static int CHARREF_RESULT_SEMICOLON_REQUIREDCHARREF_RESULT_INVALID_CHARCHARREF_RESULT_OUT_OF_RANGE(Code) | | Special return values for scanCharRef method. The normal return
value is a unicode character. These error conditions are defined
using invalid XML unicode code points.
|
| CONTENT_RESULT_START_OF_PICONTENT_RESULT_START_OF_COMMENTCONTENT_RESULT_START_OF_CDSECTCONTENT_RESULT_END_OF_CDSECTCONTENT_RESULT_START_OF_ETAGCONTENT_RESULT_MATCHING_ETAGCONTENT_RESULT_START_OF_ELEMENTCONTENT_RESULT_START_OF_CHARREFCONTENT_RESULT_START_OF_ENTITYREFCONTENT_RESULT_INVALID_CHARCONTENT_RESULT_MARKUP_NOT_RECOGNIZEDCONTENT_RESULT_MARKUP_END_OF_INPUTCONTENT_RESULT_REFERENCE_END_OF_INPUT | | final public static int CONTENT_RESULT_START_OF_PICONTENT_RESULT_START_OF_COMMENTCONTENT_RESULT_START_OF_CDSECTCONTENT_RESULT_END_OF_CDSECTCONTENT_RESULT_START_OF_ETAGCONTENT_RESULT_MATCHING_ETAGCONTENT_RESULT_START_OF_ELEMENTCONTENT_RESULT_START_OF_CHARREFCONTENT_RESULT_START_OF_ENTITYREFCONTENT_RESULT_INVALID_CHARCONTENT_RESULT_MARKUP_NOT_RECOGNIZEDCONTENT_RESULT_MARKUP_END_OF_INPUTCONTENT_RESULT_REFERENCE_END_OF_INPUT(Code) | | Return values for the scanContent method.
|
| ENTITYREF_IN_ATTVALUEENTITYREF_IN_DEFAULTATTVALUEENTITYREF_IN_CONTENTENTITYREF_IN_DTD_AS_MARKUPENTITYREF_IN_ENTITYVALUEENTITYREF_IN_DTD_WITHIN_MARKUPENTITYREF_DOCUMENTENTITYREF_EXTERNAL_SUBSET | | final public static int ENTITYREF_IN_ATTVALUEENTITYREF_IN_DEFAULTATTVALUEENTITYREF_IN_CONTENTENTITYREF_IN_DTD_AS_MARKUPENTITYREF_IN_ENTITYVALUEENTITYREF_IN_DTD_WITHIN_MARKUPENTITYREF_DOCUMENTENTITYREF_EXTERNAL_SUBSET(Code) | | This is an enumeration of all the defined contexts in which
an entity reference may appear. The order is important, as
all explicit general entity references must appear first and
the last of these must be ENTITYREF_IN_CONTENT. This permits
the test "(context <= ENTITYREF_IN_CONTENT)" to be used as a
quick check for a general entity reference.
See Also: XMLEntityHandler.startReadingFromEntity |
| ENTITYTYPE_INTERNAL_PEENTITYTYPE_EXTERNAL_PEENTITYTYPE_INTERNALENTITYTYPE_EXTERNALENTITYTYPE_UNPARSEDENTITYTYPE_DOCUMENTENTITYTYPE_EXTERNAL_SUBSET | | final public static int ENTITYTYPE_INTERNAL_PEENTITYTYPE_EXTERNAL_PEENTITYTYPE_INTERNALENTITYTYPE_EXTERNALENTITYTYPE_UNPARSEDENTITYTYPE_DOCUMENTENTITYTYPE_EXTERNAL_SUBSET(Code) | | This is an enumeration of all the defined entity types.
These are provided to communicate state information to
the clients of the parser.
|
| ENTITYVALUE_RESULT_FINISHEDENTITYVALUE_RESULT_REFERENCEENTITYVALUE_RESULT_PEREFENTITYVALUE_RESULT_INVALID_CHARENTITYVALUE_RESULT_END_OF_INPUT | | final public static int ENTITYVALUE_RESULT_FINISHEDENTITYVALUE_RESULT_REFERENCEENTITYVALUE_RESULT_PEREFENTITYVALUE_RESULT_INVALID_CHARENTITYVALUE_RESULT_END_OF_INPUT(Code) | | Special return values for scanEntityValue method. The normal return
value is a StringPool handle for a simple EntityValue that was entirely
contained within the original document. These other return values can
either indicate an error or that the EntityValue needs further processing.
|
| STRINGLIT_RESULT_QUOTE_REQUIREDSTRINGLIT_RESULT_INVALID_CHAR | | final public static int STRINGLIT_RESULT_QUOTE_REQUIREDSTRINGLIT_RESULT_INVALID_CHAR(Code) | | Special return values for scanStringLiteral method. The normal
return value is a StringPool handle. These error conditions are
defined using invalid indices.
|
| changeReaders | | public EntityReader changeReaders() throws Exception(Code) | | This method is called by the reader subclasses at the
end of input.
The reader to use next.
exception:
java.lang.Exception - |
| expandSystemId | | public String expandSystemId(String systemId)(Code) | | Expand the system identifier relative to the entity that we are processing.
The expanded system identifier. |
| getEntityReader | | public EntityReader getEntityReader()(Code) | | Return the current reader.
|
| getReaderDepth | | public int getReaderDepth()(Code) | | Return the depth set for the current reader.
|
| getReaderId | | public int getReaderId()(Code) | | Return a unique identifier for the current reader.
|
| setReaderDepth | | public void setReaderDepth(int depth)(Code) | | Set the depth for the current reader.
|
| startReadingFromDocument | | public boolean startReadingFromDocument(InputSource source) throws Exception(Code) | | Start reading document from an InputSource.
Parameters:
source - The input source for the document to process. true if we were able to open the document source;false otherwise.
exception:
java.lang.Exception - |
| startReadingFromEntity | | public boolean startReadingFromEntity(int entityName, int readerDepth, int entityContext) throws Exception(Code) | | Start reading from this entity.
Note that the reader depth is not used by the reader, but is made
available so that it may be retrieved at end of input to test that
gramatical structures are properly nested within entities.
Parameters:
entityName - The entity name handle in the string pool.
Parameters:
readerDepth - The depth to associate with the reader for this entity.
Parameters:
context - The context of the entity reference; see ENTITYREF_IN_*. true if the entity might start with a TextDecl;false otherwise.
exception:
java.lang.Exception - |
|
|
|