oracle.pg.rdbms.index.jdbc.handler

Class OracleFileEntryHandler

java.lang.Object

oracle.pg.rdbms.index.jdbc.handler.OracleFileEntryHandler

All Implemented Interfaces:

FileEntryHandler

public class OracleFileEntryHandler
extends Object
implements FileEntryHandler

An Oracle implementation of Compass FileEntryHandler to support file level operations for the OracleJdbcDirectory directory under Lucene 4.5. A file entry handler acts as a delegate to the OracleJdbcDirectory for all "file" level operations. Allows the OracleJdbcDirectory to be abstracted from any specific implementation details regarding a file entry, and have several different file entries for different files or files groups. Removes file entries from the database by deleting the relevant rows from the database.

Constructor Summary

Constructors

Constructor and Description
OracleFileEntryHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the file entry handler.
void	configure(OracleJdbcDirectory directory) Called after the entry is created (during the OracleJdbcDirectory initialization process.
org.apache.lucene.store.IndexOutput	createOutput(String name, org.apache.lucene.store.IOContext context) Creates an IndexOutput in order to write the file contents.
void	deleteFile(String name) Deletes the given file name.
List<String>	deleteFiles(List<String> names) Deletes a list of files.
boolean	fileExists(String name) Checks if the file exists for the given file name.
long	fileLength(String name) Returns the length of the file (in bytes).
org.apache.lucene.store.IndexInput	openInput(String name, org.apache.lucene.store.IOContext context) Opens an IndexInput in order to read the file contents.

Methods inherited from class java.lang.Object

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

Constructor Detail

OracleFileEntryHandler

public OracleFileEntryHandler()

Method Detail

close

public void close()
           throws IOException

Closes the file entry handler.

Specified by:

close in interface FileEntryHandler

Throws:

IOException

configure

public void configure(OracleJdbcDirectory directory)

Called after the entry is created (during the OracleJdbcDirectory initialization process.

Specified by:

configure in interface FileEntryHandler

createOutput

public org.apache.lucene.store.IndexOutput createOutput(String name,
                                               org.apache.lucene.store.IOContext context)
                                                 throws IOException

Creates an IndexOutput in order to write the file contents.

Specified by:

createOutput in interface FileEntryHandler

Parameters:

name - The name of the file

Returns:

An IndexOutput to write the file contents

Throws:

IOException

deleteFile

public void deleteFile(String name)
                throws IOException

Deletes the given file name.

Specified by:

deleteFile in interface FileEntryHandler

Parameters:

name - The name of the file to delete

Throws:

IOException

deleteFiles

public List<String> deleteFiles(List<String> names)
                         throws IOException

Deletes a list of files. It must be verified by the caller that all files correlate to this file entry handler.

Specified by:

deleteFiles in interface FileEntryHandler

Parameters:

names - The list of file names to delete

Returns:

List of files that were not deleted (or null if all were deleted)

Throws:

IOException

fileExists

public boolean fileExists(String name)
                   throws IOException

Checks if the file exists for the given file name.

Specified by:

fileExists in interface FileEntryHandler

Parameters:

name - The name of the file

Returns:

true of the file exists, false if it does not.

Throws:

IOException

fileLength

public long fileLength(String name)
                throws IOException

Returns the length of the file (in bytes).

Specified by:

fileLength in interface FileEntryHandler

Parameters:

name - The name of the file

Returns:

The length of the file (in bytes)

Throws:

IOException

openInput

public org.apache.lucene.store.IndexInput openInput(String name,
                                           org.apache.lucene.store.IOContext context)
                                             throws IOException

Opens an IndexInput in order to read the file contents.

Specified by:

openInput in interface FileEntryHandler

Parameters:

name - The name of the file

Returns:

An IndexInput in order to read the file contents.

Throws:

IOException