oracle.pg.rdbms.index.jdbc.operators

Class RAMAndFileJdbcIndexOutput

java.lang.Object

org.apache.lucene.store.DataOutput

org.apache.lucene.store.IndexOutput

oracle.pg.rdbms.index.jdbc.operators.RAMAndFileJdbcIndexOutput

All Implemented Interfaces:

Closeable, AutoCloseable, JdbcIndexConfigurable

public class RAMAndFileJdbcIndexOutput
extends org.apache.lucene.store.IndexOutput
implements JdbcIndexConfigurable

An Oracle extension of Compass RAMAndFileJdbcIndexOutput class. This class implements an IndexOutput that stores all the data written to it in memory and/or temporary files, and flushes it to the database when the output is closed.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_THRESHOLD The default value for the threshold (in bytes).
static String	INDEX_OUTPUT_THRESHOLD_SETTING The threshold setting name.

Constructor Summary

Constructors

Constructor and Description
RAMAndFileJdbcIndexOutput()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this stream to further operations
void	configure(String name, OracleJdbcDirectory jdbcDirectory) Configures this object instance with the given name and OracleJdbcDirectory object.
void	flush() Forces any buffered output to be written
long	getChecksum() Returns the current checksum of bytes written so far
long	getFilePointer() Returns the current position in this file, where the next write will occur
long	length() Returns he number of bytes in the file
void	seek(long pos) Sets the current position in this file, where the next write will occur
void	writeByte(byte b) Writes a single byte.
void	writeBytes(byte[] b, int offset, int length) Writes an array of bytes.

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

setLength

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

copyBytes, writeBytes, writeInt, writeLong, writeShort, writeString, writeStringSet, writeStringStringMap, writeVInt, writeVLong

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_THRESHOLD

public static final long DEFAULT_THRESHOLD

The default value for the threshold (in bytes). Currently 16K.

See Also:

Constant Field Values

INDEX_OUTPUT_THRESHOLD_SETTING

public static final String INDEX_OUTPUT_THRESHOLD_SETTING

The threshold setting name. See JdbcFileEntrySettings.setLongSetting(String, long). Should be set in bytes.

See Also:

Constant Field Values

Constructor Detail

RAMAndFileJdbcIndexOutput

public RAMAndFileJdbcIndexOutput()

Method Detail

close

public void close()
           throws IOException

Closes this 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.IndexOutput

Throws:

IOException

configure

public void configure(String name,
             OracleJdbcDirectory jdbcDirectory)
               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

jdbcDirectory - the OracleJdbcDirectory where the index is stored.

Throws:

IOException

flush

public void flush()
           throws IOException

Forces any buffered output to be written

Specified by:

flush in class org.apache.lucene.store.IndexOutput

Throws:

IOException

getChecksum

public long getChecksum()

Returns the current checksum of bytes written so far

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.IndexOutput

length

public long length()
            throws IOException

Returns he number of bytes in the file

Specified by:

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

Returns:

the number of bytes in the file

Throws:

IOException

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.IndexOutput

Throws:

IOException

writeByte

public void writeByte(byte b)
               throws IOException

Writes a single byte. The most primitive data type is an eight-bit byte. Files are accessed as a sequence of bytes. All other data types are defined as sequence of bytes, so file formats are byte-order independent.

Specified by:

writeByte in class org.apache.lucene.store.DataOutput

Parameters:

b - a byte to write.

Throws:

IOException

writeBytes

public void writeBytes(byte[] b,
              int offset,
              int length)
                throws IOException

Writes an array of bytes.

Specified by:

writeBytes in class org.apache.lucene.store.DataOutput

Parameters:

b - the bytes to write

offset - the offset in the byte array

length - the number of bytes to write

Throws:

IOException