org.openexi.proc.io
Class Scanner

java.lang.Object
  org.openexi.proc.grammars.Apparatus
      org.openexi.proc.io.Scanner

public abstract class Scanner
extends org.openexi.proc.grammars.Apparatus

The Scanner class provides methods for scanning events in the body of an EXI stream.

Field Summary

Fields inherited from class org.openexi.proc.grammars.Apparatus

CODEC_BASE64BINARY, CODEC_BOOLEAN, CODEC_DATE, CODEC_DATETIME, CODEC_DECIMAL, CODEC_DOUBLE, CODEC_ENUMERATION, CODEC_GDAY, CODEC_GMONTH, CODEC_GMONTHDAY, CODEC_GYEAR, CODEC_GYEARMONTH, CODEC_HEXBINARY, CODEC_INTEGER, CODEC_LEXICAL, CODEC_LIST, CODEC_STRING, CODEC_TIME, currentState, eventTypesWorkSpace, schema, stringTable

Method Summary

void	closeInputStream() Close the input stream.
EXIOptions	getHeaderOptions() Returns the EXI Header options from the header of the EXI stream, if present.
abstract EventDescription	nextEvent() Gets the next event from the EXI stream.
abstract void	setBinaryChunkSize(int chunkSize) Binary values are read in chunks of the specified size when the use of binary data is enabled.
void	setSchema(EXISchema schema, QName[] dtrm, int n_bindings)

Methods inherited from class org.openexi.proc.grammars.Apparatus

attribute, characters, endDocument, endElement, getAlignmentType, getNextEventCodes, getNextEventTypes, getPreserveLexicalValues, miscContent, nillify, reset, setPreserveLexicalValues, setStringTable, startDocument, startElement, startWildcardElement, undeclaredCharacters, wildcardAttribute, xsitp

Methods inherited from class java.lang.Object

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

Method Detail

setSchema

public void setSchema(EXISchema schema,
                      QName[] dtrm,
                      int n_bindings)

Overrides:

setSchema in class org.openexi.proc.grammars.Apparatus

nextEvent

public abstract EventDescription nextEvent()
                                    throws java.io.IOException

Gets the next event from the EXI stream.

Returns:

EXIEvent

Throws:

java.io.IOException

closeInputStream

public void closeInputStream()
                      throws java.io.IOException

Close the input stream.

Throws:

java.io.IOException

getHeaderOptions

public final EXIOptions getHeaderOptions()

Returns the EXI Header options from the header of the EXI stream, if present. Otherwise, returns null.

Returns:

EXIOptions or null if no header options are set.

setBinaryChunkSize

public abstract void setBinaryChunkSize(int chunkSize)

Binary values are read in chunks of the specified size when the use of binary data is enabled.

Parameters:

chunkSize -