oracle.pg.rdbms.index.jdbc.handler

Interface FileEntryHandler

All Known Implementing Classes:

NoOpFileEntryHandler, OracleFileEntryHandler

public interface FileEntryHandler

An Oracle modification 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.

Method Summary

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

Method Detail

close

void close()
    throws java.io.IOException

Closes the file entry handler.

Throws:

java.io.IOException

configure

void configure(OracleJdbcDirectory jdbcDirectory)

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

createOutput

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

Creates an IndexOutput in order to write the file contents.

Parameters:

name - The name of the file

Returns:

An IndexOutput to write the file contents

Throws:

java.io.IOException

deleteFile

void deleteFile(java.lang.String name)
         throws java.io.IOException

Deletes the given file name.

Parameters:

name - The name of the file to delete

Throws:

java.io.IOException

deleteFiles

java.util.List<java.lang.String> deleteFiles(java.util.List<java.lang.String> names)
                                      throws java.io.IOException

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

Parameters:

names - The list of file names to delete

Returns:

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

Throws:

java.io.IOException

fileExists

boolean fileExists(java.lang.String name)
            throws java.io.IOException

Checks if the file exists for the given file name.

Parameters:

name - The name of the file

Returns:

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

Throws:

java.io.IOException

fileLength

long fileLength(java.lang.String name)
         throws java.io.IOException

Returns the length of the file (in bytes).

Parameters:

name - The name of the file

Returns:

The length of the file (in bytes)

Throws:

java.io.IOException

openInput

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

Opens an IndexInput in order to read the file contents.

Parameters:

name - The name of the file

Returns:

An IndexInput in order to read the file contents.

Throws:

java.io.IOException