Top Description Methods
org.apache.xerces.xni.parser

public Interface XMLDTDScanner

extends XMLDTDSource, XMLDTDContentModelSource
Known Direct Implementers
org.apache.xerces.impl.XMLDTDScannerImpl
Imports
java.io.IOException, org.apache.xerces.xni.XNIException
This interface defines a generic DTD scanner. This interface allows a scanner to be used interchangably in existing parser configurations.

If the parser configuration uses a DTD scanner that implements this interface, components should be able to query the scanner instance from the component manager using the following property identifier:

"http://apache.org/xml/properties/internal/dtd-scanner"
Author
Andy Clark, IBM
Version
$Id: XMLDTDScanner.java 699892 2008-09-28 21:08:27Z mrglavas $

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

True if there is more to scan, false otherwise.
scanDTDExternalSubset(boolean
True if the scanner should scan the document completely, pushing all events to the registered document handler. A value of false indicates that that the scanner should only scan the next portion of the document and return. A scanner instance is permitted to completely scan a document if it does not support this "pull" scanning model.
complete)

Scans the external subset of the document.

public boolean

Returns:

True if there is more to scan, false otherwise.
scanDTDInternalSubset(boolean
True if the scanner should scan the document completely, pushing all events to the registered document handler. A value of false indicates that that the scanner should only scan the next portion of the document and return. A scanner instance is permitted to completely scan a document if it does not support this "pull" scanning model.
complete, boolean
True if the document was specified as standalone. This value is important for verifying certain well-formedness constraints.
standalone, boolean
True if the document has an external DTD. This allows the scanner to properly notify the handler of the end of the DTD in the absence of an external subset.
hasExternalSubset)

Scans the internal subset of the document.

public void
setInputSource(XMLInputSource
The input source or null.
inputSource)

Sets the input source.

Inherited from org.apache.xerces.xni.parser.XMLDTDContentModelSource:
getDTDContentModelHandlersetDTDContentModelHandler
Inherited from org.apache.xerces.xni.parser.XMLDTDSource:
getDTDHandlersetDTDHandler

Method Detail

scanDTDExternalSubsetback to summary
public boolean scanDTDExternalSubset(boolean complete) throws IOException, XNIException

Scans the external subset of the document.

Parameters
complete:boolean

True if the scanner should scan the document completely, pushing all events to the registered document handler. A value of false indicates that that the scanner should only scan the next portion of the document and return. A scanner instance is permitted to completely scan a document if it does not support this "pull" scanning model.

Returns:boolean

True if there is more to scan, false otherwise.

scanDTDInternalSubsetback to summary
public boolean scanDTDInternalSubset(boolean complete, boolean standalone, boolean hasExternalSubset) throws IOException, XNIException

Scans the internal subset of the document.

Parameters
complete:boolean

True if the scanner should scan the document completely, pushing all events to the registered document handler. A value of false indicates that that the scanner should only scan the next portion of the document and return. A scanner instance is permitted to completely scan a document if it does not support this "pull" scanning model.

standalone:boolean

True if the document was specified as standalone. This value is important for verifying certain well-formedness constraints.

hasExternalSubset:boolean

True if the document has an external DTD. This allows the scanner to properly notify the handler of the end of the DTD in the absence of an external subset.

Returns:boolean

True if there is more to scan, false otherwise.

setInputSourceback to summary
public void setInputSource(XMLInputSource inputSource) throws IOException

Sets the input source.

Parameters
inputSource:XMLInputSource

The input source or null.

Exceptions
IOException:
Thrown on i/o error.