org.apache.xerces.readers
Interface XMLEntityReaderFactory

All Known Implementing Classes:

DefaultReaderFactory

public interface XMLEntityReaderFactory

This is the factory interface used to create readers.

Version:

Method Summary

void	addRecognizer(XMLDeclRecognizer recognizer) Adds a recognizer.
XMLEntityHandler.EntityReader	createCharReader(XMLEntityHandler entityHandler, XMLErrorReporter errorReporter, boolean sendCharDataAsCharArray, java.io.Reader reader, StringPool stringPool) Create an entity reader for a character stream.
XMLEntityHandler.EntityReader	createReader(XMLEntityHandler entityHandler, XMLErrorReporter errorReporter, InputSource source, java.lang.String systemId, boolean xmlDecl, StringPool stringPool) Create an entity reader for the source.
XMLEntityHandler.EntityReader	createStringReader(XMLEntityHandler entityHandler, XMLErrorReporter errorReporter, boolean sendCharDataAsCharArray, int lineNumber, int columnNumber, int stringHandle, StringPool stringPool, boolean addEnclosingSpaces) Create an entity reader for data from a String.
XMLEntityHandler.EntityReader	createUTF8Reader(XMLEntityHandler entityHandler, XMLErrorReporter errorReporter, boolean sendCharDataAsCharArray, java.io.InputStream data, StringPool stringPool) Create an entity reader for a byte stream encoded in UTF-8.
boolean	getAllowJavaEncodingName()
void	setAllowJavaEncodingName(boolean flag)
void	setSendCharDataAsCharArray(boolean flag) Set char data processing preference.

Method Detail

addRecognizer

public void addRecognizer(XMLDeclRecognizer recognizer)

Adds a recognizer.

Parameters:

recognizer - The XML recognizer to add.

setSendCharDataAsCharArray

public void setSendCharDataAsCharArray(boolean flag)

Set char data processing preference.

setAllowJavaEncodingName

public void setAllowJavaEncodingName(boolean flag)

getAllowJavaEncodingName

public boolean getAllowJavaEncodingName()

createReader

public XMLEntityHandler.EntityReader createReader(XMLEntityHandler entityHandler,
                                                  XMLErrorReporter errorReporter,
                                                  InputSource source,
                                                  java.lang.String systemId,
                                                  boolean xmlDecl,
                                                  StringPool stringPool)
                                           throws java.lang.Exception

Create an entity reader for the source.

Parameters:

source - The input source.

systemId - The system identifier for the input.

xmlDecl - true if an XMLDecl may be present; otherwise false if a TextDecl may be present.

stringPool - The string pool.

Returns:

The reader that will process the source.

Throws:

java.lang.Exception -

createCharReader

public XMLEntityHandler.EntityReader createCharReader(XMLEntityHandler entityHandler,
                                                      XMLErrorReporter errorReporter,
                                                      boolean sendCharDataAsCharArray,
                                                      java.io.Reader reader,
                                                      StringPool stringPool)
                                               throws java.lang.Exception

Create an entity reader for a character stream.

Parameters:

enityHandler - The entity handler.

errorReporter - The error reporter.

sendCharDataAsCharArray - true if char data should be reported using char arrays instead of string handles.

reader - The character stream.

stringPool - The string pool.

Returns:

The reader that will process the character data.

Throws:

java.lang.Exception -

createUTF8Reader

public XMLEntityHandler.EntityReader createUTF8Reader(XMLEntityHandler entityHandler,
                                                      XMLErrorReporter errorReporter,
                                                      boolean sendCharDataAsCharArray,
                                                      java.io.InputStream data,
                                                      StringPool stringPool)
                                               throws java.lang.Exception

Create an entity reader for a byte stream encoded in UTF-8.

Parameters:

enityHandler - The entity handler.

errorReporter - The error reporter.

sendCharDataAsCharArray - true if char data should be reported using char arrays instead of string handles.

data - The byte stream.

stringPool - The string pool.

Returns:

The reader that will process the UTF-8 data.

Throws:

java.lang.Exception -

createStringReader

public XMLEntityHandler.EntityReader createStringReader(XMLEntityHandler entityHandler,
                                                        XMLErrorReporter errorReporter,
                                                        boolean sendCharDataAsCharArray,
                                                        int lineNumber,
                                                        int columnNumber,
                                                        int stringHandle,
                                                        StringPool stringPool,
                                                        boolean addEnclosingSpaces)
                                                 throws java.lang.Exception

Create an entity reader for data from a String.

Parameters:

entityHandler - The current entity handler.

errorReporter - The current error reporter.

sendCharDataAsCharArray - true if char data should be reported using char arrays instead of string handles.

lineNumber - The line number to return as our position.

columnNumber - The column number to return as our position.

stringHandle - The StringPool handle for the data to process.

stringPool - The string pool.

addEnclosingSpaces - If true, treat the data to process as if there were a leading and trailing space character enclosing the string data.

Returns:

The reader that will process the string data.

Throws:

java.lang.Exception -