Xerces-J API: Class StreamingCharReader

Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.xerces.readers
Class StreamingCharReader

java.lang.Object
  |
  +--org.apache.xerces.readers.XMLEntityReader
        |
        +--org.apache.xerces.readers.StreamingCharReader

All Implemented Interfaces:: XMLEntityHandler.EntityReader

public class StreamingCharReader
extends org.apache.xerces.readers.XMLEntityReader

An reader class for applications that need to process input data as it arrives on the stream.

Version:: $Id: StreamingCharReader.java 316852 2001-02-01 09:58:44Z andyc $

Field Summary

protected boolean fCalledCharPropInit


protected int fCarriageReturnCounter


protected int fCharacterCounter


protected java.io.Reader fCharacterStream


protected XMLEntityHandler.CharDataHandler fCharDataHandler


protected CharDataChunk fCurrentChunk


protected int fCurrentIndex


protected int fCurrentOffset


protected XMLEntityHandler fEntityHandler


protected XMLErrorReporter fErrorReporter


protected int fFillIndex


protected boolean fInCDSect


protected int fLength


protected int fLinefeedCounter


protected int fMostRecentChar


protected char[] fMostRecentData


protected boolean fSendCharDataAsCharArray


Constructor Summary

StreamingCharReader(XMLEntityHandler entityHandler, XMLErrorReporter errorReporter, boolean sendCharDataAsCharArray, java.io.Reader reader, StringPool stringPool)
          Constructor

Method Summary

int addString(int offset, int length)
          Add a string to the StringPool from the characters scanned using this reader as described by offset and length.

int addSymbol(int offset, int length)
          Add a symbol to the StringPool from the characters scanned using this reader as described by offset and length.

void append(XMLEntityHandler.CharBuffer charBuffer, int offset, int length)
          Append the characters processed by this reader associated with offset and length to the CharBuffer.

protected XMLEntityHandler.EntityReader changeReaders()
          Change readers at end of input.

int currentOffset()
          Return the current offset within this reader.

protected void deferException(int errorCode, java.lang.Object[] args, int offset)
          Delay reporting an error message.

int getColumnNumber()
          Return the column number of the current position within the document that we are processing.

boolean getInCDSect()
          This method is provided for scanner implementations.

int getLineNumber()
          Return the line number of the current position within the document that we are processing.

protected void init(XMLEntityHandler entityHandler, XMLErrorReporter errorReporter, boolean sendCharDataAsCharArray, int lineNumber, int columnNumber)


boolean lookingAtChar(char chr, boolean skipPastChar)
          Test that the current character is a ch character.

boolean lookingAtSpace(boolean skipPastChar)
          Test that the current character is a whitespace character.

boolean lookingAtValidChar(boolean skipPastChar)
          Test that the current character is valid.

int scanAttValue(char qchar, boolean asSymbol)
          Scan an attribute value.

int scanCharRef(boolean hex)
          Scan a character reference.

int scanContent(QName element)
          Skip through the input while we are looking at character data.

int scanEntityValue(int qchar, boolean createString)
          Scan an entity value.

boolean scanExpectedName(char fastcheck, StringPool.CharArrayRange expectedName)
          Scan the name that is expected at the current position in the document.

int scanInvalidChar()
          Scan an invalid character.

int scanName(char fastcheck)
          Add a sequence of characters that match the XML definition of a Name to the StringPool.

void scanQName(char fastcheck, QName qname)
          Add a sequence of characters that match the XML Namespaces definition of a QName to the StringPool.

int scanStringLiteral()
          Scan a string literal.

void setInCDSect(boolean inCDSect)
          This method is provided for scanner implementations.

void skipPastName(char fastcheck)
          Skip past a sequence of characters that match the XML definition of a Name.

void skipPastNmtoken(char fastcheck)
          Skip past a sequence of characters that match the XML definition of an Nmtoken.

void skipPastSpaces()
          Skip past whitespace characters starting at the current position.

boolean skippedString(char[] s)
          Skip past a sequence of characters that matches the specified character array.

void skipToChar(char chr)
          Advance through the input data up to the next ch character.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Summary
`protected boolean`	`fCalledCharPropInit`
`protected int`	`fCarriageReturnCounter`
`protected int`	`fCharacterCounter`
`protected java.io.Reader`	`fCharacterStream`
`protected XMLEntityHandler.CharDataHandler`	`fCharDataHandler`
`protected CharDataChunk`	`fCurrentChunk`
`protected int`	`fCurrentIndex`
`protected int`	`fCurrentOffset`
`protected XMLEntityHandler`	`fEntityHandler`
`protected XMLErrorReporter`	`fErrorReporter`
`protected int`	`fFillIndex`
`protected boolean`	`fInCDSect`
`protected int`	`fLength`
`protected int`	`fLinefeedCounter`
`protected int`	`fMostRecentChar`
`protected char[]`	`fMostRecentData`
`protected boolean`	`fSendCharDataAsCharArray`

Constructor Summary
`StreamingCharReader(XMLEntityHandler entityHandler, XMLErrorReporter errorReporter, boolean sendCharDataAsCharArray, java.io.Reader reader, StringPool stringPool)` Constructor

Method Summary
`int`	`addString(int offset, int length)` Add a string to the `StringPool` from the characters scanned using this reader as described by `offset` and `length`.
`int`	`addSymbol(int offset, int length)` Add a symbol to the `StringPool` from the characters scanned using this reader as described by `offset` and `length`.
`void`	`append(XMLEntityHandler.CharBuffer charBuffer, int offset, int length)` Append the characters processed by this reader associated with `offset` and `length` to the `CharBuffer`.
`protected XMLEntityHandler.EntityReader`	`changeReaders()` Change readers at end of input.
`int`	`currentOffset()` Return the current offset within this reader.
`protected void`	`deferException(int errorCode, java.lang.Object[] args, int offset)` Delay reporting an error message.
`int`	`getColumnNumber()` Return the column number of the current position within the document that we are processing.
`boolean`	`getInCDSect()` This method is provided for scanner implementations.
`int`	`getLineNumber()` Return the line number of the current position within the document that we are processing.
`protected void`	`init(XMLEntityHandler entityHandler, XMLErrorReporter errorReporter, boolean sendCharDataAsCharArray, int lineNumber, int columnNumber)`
`boolean`	`lookingAtChar(char chr, boolean skipPastChar)` Test that the current character is a `ch` character.
`boolean`	`lookingAtSpace(boolean skipPastChar)` Test that the current character is a whitespace character.
`boolean`	`lookingAtValidChar(boolean skipPastChar)` Test that the current character is valid.
`int`	`scanAttValue(char qchar, boolean asSymbol)` Scan an attribute value.
`int`	`scanCharRef(boolean hex)` Scan a character reference.
`int`	`scanContent(QName element)` Skip through the input while we are looking at character data.
`int`	`scanEntityValue(int qchar, boolean createString)` Scan an entity value.
`boolean`	`scanExpectedName(char fastcheck, StringPool.CharArrayRange expectedName)` Scan the name that is expected at the current position in the document.
`int`	`scanInvalidChar()` Scan an invalid character.
`int`	`scanName(char fastcheck)` Add a sequence of characters that match the XML definition of a Name to the `StringPool`.
`void`	`scanQName(char fastcheck, QName qname)` Add a sequence of characters that match the XML Namespaces definition of a QName to the `StringPool`.
`int`	`scanStringLiteral()` Scan a string literal.
`void`	`setInCDSect(boolean inCDSect)` This method is provided for scanner implementations.
`void`	`skipPastName(char fastcheck)` Skip past a sequence of characters that match the XML definition of a Name.
`void`	`skipPastNmtoken(char fastcheck)` Skip past a sequence of characters that match the XML definition of an Nmtoken.
`void`	`skipPastSpaces()` Skip past whitespace characters starting at the current position.
`boolean`	`skippedString(char[] s)` Skip past a sequence of characters that matches the specified character array.
`void`	`skipToChar(char chr)` Advance through the input data up to the next `ch` character.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

fCharacterStream

protected java.io.Reader fCharacterStream

fCurrentChunk

protected CharDataChunk fCurrentChunk

fCurrentIndex

protected int fCurrentIndex

fFillIndex

protected int fFillIndex

fMostRecentData

protected char[] fMostRecentData

fMostRecentChar

protected int fMostRecentChar

fLength

protected int fLength

fCalledCharPropInit

protected boolean fCalledCharPropInit

fEntityHandler

protected XMLEntityHandler fEntityHandler

fErrorReporter

protected XMLErrorReporter fErrorReporter

fSendCharDataAsCharArray

protected boolean fSendCharDataAsCharArray

fCharDataHandler

protected XMLEntityHandler.CharDataHandler fCharDataHandler

fInCDSect

protected boolean fInCDSect

fCarriageReturnCounter

protected int fCarriageReturnCounter

fLinefeedCounter

protected int fLinefeedCounter

fCharacterCounter

protected int fCharacterCounter

fCurrentOffset

protected int fCurrentOffset

Constructor Detail

StreamingCharReader

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

Constructor

Parameters:: entityHandler - The entity handler.; errorReporter - The error reporter.; sendCharDataAsCharArray - true if char data should be reported using char arrays instead of string handles.; stringPool - The string pool.

Method Detail

deferException

protected void deferException(int errorCode,
                              java.lang.Object[] args,
                              int offset)

Delay reporting an error message. If there is an error detected in the underlying input stream during the fillCurrentChunk method, the error is described here and will be reported when we reach that offset during normal processing. The subclass should place a character with a value of zero at that offset, which will be detected here as an invalid character. When the invalid character is scanned, we will generate the deferred exception.

Parameters:: errorCode - the errorCode to report; args - an array of arguments needed to generate a good error message; offset - the position in the reader where the error occured

changeReaders

protected XMLEntityHandler.EntityReader changeReaders()
                                               throws java.lang.Exception

Change readers at end of input. We override our superclass method to release the final chunk of the input data before handing off to the next reader.

Overrides:: changeReaders in class org.apache.xerces.readers.XMLEntityReader

Returns:: The next reader used to continue processing the document.

append

public void append(XMLEntityHandler.CharBuffer charBuffer,
                   int offset,
                   int length)

Append the characters processed by this reader associated with offset and length to the CharBuffer.

Parameters:: charBuffer - The CharBuffer to append the characters to.; offset - The offset within this reader where the copy should start.; length - The length within this reader where the copy should stop.

addString

public int addString(int offset,
                     int length)

Add a string to the StringPool from the characters scanned using this reader as described by offset and length.

Parameters:: offset - The offset within this reader where the characters start.; length - The length within this reader where the characters end.
Returns:: The StringPool handle for the string.

addSymbol

public int addSymbol(int offset,
                     int length)

Add a symbol to the StringPool from the characters scanned using this reader as described by offset and length.

Parameters:: offset - The offset within this reader where the characters start.; length - The length within this reader where the characters end.
Returns:: The StringPool handle for the symbol.