com.sun.portal.search.soif
Class SOIFInputStream

java.lang.Object
  extended bycom.sun.portal.search.soif.SOIFInputStream

public class SOIFInputStream
extends java.lang.Object

SOIFInputStream class. Reads serialized SOIF objects from an input stream.


Field Summary
 boolean debug
          debug
 
Constructor Summary
SOIFInputStream(byte[] data)
          Creates a SOIFInputStream reading from a byte array.
SOIFInputStream(byte[] data, java.lang.String encoding)
          Creates a SOIFInputStream reading from a byte array.
SOIFInputStream(java.io.InputStream is)
          Creates a SOIFInputStream reading from an InputStream.
SOIFInputStream(java.io.InputStream is, java.lang.String encoding)
          Creates a SOIFInputStream reading from an InputStream.
SOIFInputStream(SOIFBuffer sb)
          Creates a SOIFInputStream reading from a SOIFBuffer.
SOIFInputStream(java.lang.String filename)
          Creates a SOIFInputStream reading from the named file.
SOIFInputStream(java.lang.String filename, java.lang.String encoding)
          Creates a SOIFInputStream reading from the named file.
 
Method Summary
 boolean close()
          Closes the stream.
 boolean isEOS()
           
 SOIF readSOIF()
          Reads a single SOIF from the underlying input stream.
 void setAllowed(java.util.Set attrs)
          Sets a SOIF attribute filter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

debug

public final boolean debug
debug

See Also:
Constant Field Values
Constructor Detail

SOIFInputStream

public SOIFInputStream(java.lang.String filename)
                throws java.io.FileNotFoundException
Creates a SOIFInputStream reading from the named file.

Parameters:
filename - the SOIF source file

SOIFInputStream

public SOIFInputStream(java.lang.String filename,
                       java.lang.String encoding)
                throws java.io.FileNotFoundException,
                       java.io.UnsupportedEncodingException
Creates a SOIFInputStream reading from the named file.

Parameters:
filename - the SOIF source file
encoding - the character encoding of the input SOIF

SOIFInputStream

public SOIFInputStream(byte[] data,
                       java.lang.String encoding)
                throws java.io.UnsupportedEncodingException
Creates a SOIFInputStream reading from a byte array.

Parameters:
data - the SOIF source byte array
encoding - the character encoding of the input SOIF

SOIFInputStream

public SOIFInputStream(byte[] data)
Creates a SOIFInputStream reading from a byte array.

Parameters:
data - the SOIF source byte array

SOIFInputStream

public SOIFInputStream(SOIFBuffer sb)
Creates a SOIFInputStream reading from a SOIFBuffer.


SOIFInputStream

public SOIFInputStream(java.io.InputStream is)
Creates a SOIFInputStream reading from an InputStream.


SOIFInputStream

public SOIFInputStream(java.io.InputStream is,
                       java.lang.String encoding)
                throws java.io.UnsupportedEncodingException
Creates a SOIFInputStream reading from an InputStream.

Parameters:
encoding - the character encoding of the input SOIF
Method Detail

setAllowed

public void setAllowed(java.util.Set attrs)
Sets a SOIF attribute filter. Only attributes in the allowed set will be read from the input stream.

Parameters:
attrs - the set of allowed attributes (use lower case)

readSOIF

public SOIF readSOIF()
              throws java.io.IOException
Reads a single SOIF from the underlying input stream.

Returns:
the next SOIF object from the input stream
Throws:
SOIFException - if error in SOIF
java.io.IOException - if an I/O error occurs
java.io.EOFException - if read past end of stream

isEOS

public boolean isEOS()
Returns:
true if stream is at EOS

close

public boolean close()
Closes the stream.

Returns:
false on I/O error