org.apache.derby.impl.store.raw.data
Class OverflowInputStream

java.lang.Object
  extended byjava.io.InputStream
      extended byorg.apache.derby.impl.store.raw.data.ByteHolderInputStream
          extended byorg.apache.derby.impl.store.raw.data.BufferedByteHolderInputStream
              extended byorg.apache.derby.impl.store.raw.data.OverflowInputStream
All Implemented Interfaces:
Resetable

public class OverflowInputStream
extends BufferedByteHolderInputStream
implements Resetable

A OverflowInputStream is used by store to turn a long column into an InputStream.


Field Summary
protected  int firstOverflowId
           
protected  long firstOverflowPage
           
protected  int overflowId
           
protected  long overflowPage
           
protected  BaseContainerHandle owner
           
protected  RecordHandle recordToLock
           
 
Fields inherited from class org.apache.derby.impl.store.raw.data.ByteHolderInputStream
bh
 
Fields inherited from class java.io.InputStream
 
Constructor Summary
OverflowInputStream(ByteHolder bh, BaseContainerHandle owner, long overflowPage, int overflowId, RecordHandle recordToLock)
           
 
Method Summary
 void closeStream()
          Close.
 void fillByteHolder()
           
 int getOverflowId()
           
 long getOverflowPage()
           
 void initStream()
          Initialize.
 void resetStream()
          Reset the stream to the beginning.
 void setOverflowId(int overflowId)
           
 void setOverflowPage(long overflowPage)
           
 
Methods inherited from class org.apache.derby.impl.store.raw.data.BufferedByteHolderInputStream
available, read, read, skip
 
Methods inherited from class org.apache.derby.impl.store.raw.data.ByteHolderInputStream
getByteHolder, setByteHolder
 
Methods inherited from class java.io.InputStream
close, mark, markSupported, read, reset
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

owner

protected BaseContainerHandle owner

overflowPage

protected long overflowPage

overflowId

protected int overflowId

firstOverflowPage

protected long firstOverflowPage

firstOverflowId

protected int firstOverflowId

recordToLock

protected RecordHandle recordToLock
Constructor Detail

OverflowInputStream

public OverflowInputStream(ByteHolder bh,
                           BaseContainerHandle owner,
                           long overflowPage,
                           int overflowId,
                           RecordHandle recordToLock)
                    throws java.io.IOException,
                           StandardException
Method Detail

fillByteHolder

public void fillByteHolder()
                    throws java.io.IOException
Specified by:
fillByteHolder in class BufferedByteHolderInputStream
Throws:
java.io.IOException

getOverflowPage

public long getOverflowPage()

getOverflowId

public int getOverflowId()

setOverflowPage

public void setOverflowPage(long overflowPage)

setOverflowId

public void setOverflowId(int overflowId)

resetStream

public void resetStream()
                 throws java.io.IOException,
                        StandardException
Description copied from interface: Resetable
Reset the stream to the beginning.

Specified by:
resetStream in interface Resetable
Throws:
java.io.IOException
StandardException

initStream

public void initStream()
                throws StandardException
Description copied from interface: Resetable
Initialize. Needs to be called first, before a resetable stream can be used.

Specified by:
initStream in interface Resetable
Throws:
StandardException

closeStream

public void closeStream()
Description copied from interface: Resetable
Close. Free resources (such as open containers and locks) associated with the stream.

Specified by:
closeStream in interface Resetable

Built on Tue 2006-10-10 19:23:47+0200, from revision exported

Apache Derby V10.1 Engine Documentation - Copyright © 1997,2005 The Apache Software Foundation or its licensors, as applicable.