org.apache.xindice.xml
Class XMLCompressedInput

java.lang.Object
  java.io.InputStream
      java.io.FilterInputStream
          java.io.DataInputStream
              org.apache.xindice.xml.XMLCompressedInput

All Implemented Interfaces:

DataInput

public class XMLCompressedInput

extends DataInputStream

XMLCompressedInput is an InputStream extension that provides functions for reading type from a Xindice Compressed XML Stream.

Version:

$Revision: 541508 $, $Date: 2007-05-24 21:54:12 -0400 (Thu, 24 May 2007) $

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

XMLCompressedInput(InputStream is, SymbolTable st)

Method Summary

short	getNodeType() getNodeType resolves and returns the DOM Node type from the given Xindice compressed signature.
byte	getSignature() getSignature returns the most recently read signature byte from the input stream.
int	readAttributeCount() readAttributeCount reads the count of the upcoming Attributes from the Stream based on the object signature that is provided.
int	readContentSize() readContentSize reads the size of the upcoming content from the Stream, based on the object signature that is provided.
byte	readSignature() readSignature reads a Node signature byte from the input stream.

Methods inherited from class java.io.DataInputStream

read, read, readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, readUTF, skipBytes

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLCompressedInput

public XMLCompressedInput(InputStream is,
                          SymbolTable st)

Method Detail

readSignature

public final byte readSignature()
                         throws IOException

readSignature reads a Node signature byte from the input stream.

Returns:

The signature

Throws:

IOException - if an IOException occurs

getSignature

public final byte getSignature()

getSignature returns the most recently read signature byte from the input stream.

Returns:

The signature

getNodeType

public final short getNodeType()

getNodeType resolves and returns the DOM Node type from the given Xindice compressed signature.

Returns:

The DOM Node type

readContentSize

public final int readContentSize()
                          throws IOException

readContentSize reads the size of the upcoming content from the Stream, based on the object signature that is provided.

Returns:

The Content Size

Throws:

IOException - if an IOException occurs

readAttributeCount

public final int readAttributeCount()
                             throws IOException

readAttributeCount reads the count of the upcoming Attributes from the Stream based on the object signature that is provided.

Returns:

The Content Size

Throws:

IOException - if an IOException occurs