oracle.pg.rdbms.index.jdbc.operators

Class FetchOnOpenJdbcIndexInput

java.lang.Object

org.apache.lucene.store.DataInput

org.apache.lucene.store.IndexInput

oracle.pg.rdbms.index.jdbc.operators.FetchOnOpenJdbcIndexInput

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, JdbcIndexConfigurable

public class FetchOnOpenJdbcIndexInput
extends org.apache.lucene.store.IndexInput
implements JdbcIndexConfigurable

An Oracle extension of Compass FetchOnOpenJdbcIndexInput class. This class perform will read all the relevant data from the database when created an will cache it until it is closed.

Constructor Summary

Constructors

Constructor and Description
FetchOnOpenJdbcIndexInput() Constructs a FetchOnOpenJdbcIndexInput object

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the stream to further operations.
void	configure(String name, OracleJdbcDirectory directory) Configures this object instance with the given name and OracleJdbcDirectory object.
long	getFilePointer() Returns the current position in this file, where the next write will occur
long	length() Returns the number of bytes in the file
byte	readByte() Reads and returns a single byte
void	readBytes(byte[] b, int offset, int len) Reads a specified number of bytes into an array at the speficied offset
void	seek(long pos) Sets the current position in this file, where the next write will occur
org.apache.lucene.store.IndexInput	slice(String sliceDescription, long offset, long length) Creates a slice of this index input, with the given description, offset, and length.

Methods inherited from class org.apache.lucene.store.IndexInput

clone, toString

Methods inherited from class org.apache.lucene.store.DataInput

readBytes, readInt, readLong, readShort, readString, readStringSet, readStringStringMap, readVInt, readVLong, readZInt, readZLong, skipBytes

Methods inherited from class java.lang.Object

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

Constructor Detail

FetchOnOpenJdbcIndexInput

public FetchOnOpenJdbcIndexInput()

Constructs a FetchOnOpenJdbcIndexInput object

Method Detail

close

public void close()
           throws IOException

Closes the stream to further operations.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class org.apache.lucene.store.IndexInput

Throws:

IOException

configure

public void configure(String name,
             OracleJdbcDirectory directory)
               throws IOException

Configures this object instance with the given name and OracleJdbcDirectory object.

Specified by:

configure in interface JdbcIndexConfigurable

Parameters:

name - the name of this IndexOutput object

directory - the OracleJdbcDirectory where the index is stored.

Throws:

IOException

getFilePointer

public long getFilePointer()

Returns the current position in this file, where the next write will occur

Specified by:

getFilePointer in class org.apache.lucene.store.IndexInput

length

public long length()

Returns the number of bytes in the file

Specified by:

length in class org.apache.lucene.store.IndexInput

Returns:

the number of bytes in the file

readByte

public byte readByte()
              throws IOException

Reads and returns a single byte

Specified by:

readByte in class org.apache.lucene.store.DataInput

Returns:

the byte read.

Throws:

IOException

See Also:

DataOutput.writeByte(byte)

readBytes

public void readBytes(byte[] b,
             int offset,
             int len)
               throws IOException

Reads a specified number of bytes into an array at the speficied offset

Specified by:

readBytes in class org.apache.lucene.store.DataInput

Parameters:

b - the array to read bytes into

offset - the offset in the array to start storing bytes

len - the number of bytes to read

Throws:

IOException

See Also:

DataOutput.writeBytes(byte[],int)

seek

public void seek(long pos)
          throws IOException

Sets the current position in this file, where the next write will occur

Specified by:

seek in class org.apache.lucene.store.IndexInput

Throws:

IOException

slice

public org.apache.lucene.store.IndexInput slice(String sliceDescription,
                                       long offset,
                                       long length)

Creates a slice of this index input, with the given description, offset, and length. The slice is seeked to the beginning.