oracle.pg.text.lucene

Class LuceneIndexParameters

java.lang.Object

oracle.pg.text.OracleIndexParameters

oracle.pg.text.lucene.LuceneIndexParameters

Direct Known Subclasses:

RDBMSLuceneIndexParameters

public class LuceneIndexParameters
extends OracleIndexParameters

This class manages relevant parameters for text indexing. Such parameters include the type of Lucene Directory used, location, and degree of parallelism (DOP).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANALYZER_PARAMETER This constant denotes the parameter for the analyzer object used in an Apache Lucene index
static java.lang.String	DATATYPES_PARAMETER This constant denotes the parameter for the way values are stored in an Apache Lucene index, if true, all values will be stored as strings, else all values will be stored using their datatypes
static java.lang.String	LOCATION_PARAMETER This constant denotes the parameter for the locations where an Apache Lucene index will reside using a FS Directory
static java.lang.String	LUCENE_DIRECTORY_TYPE_PARAMETER This constant denotes the parameter for the directory type to use in an Apache Lucene index e.g.
static int	MAX_NUM_SUBDIRS This constant denotes the parameter for the maximum number of subdirectories allowed per text index
static java.lang.String	NUM_SUBDIRS_PARAMETER This constant denotes the parameter for the number of sub-directories used in an Apache Lucene index
static java.lang.String	POOL_PARAMETER This constant denotes the parameter for the oracle pool used in an Apache Lucene index with a JDBC directory
static java.lang.String	VERSION_PARAMETER This constant denotes the parameter for the Apache Lucene version

Fields inherited from class oracle.pg.text.OracleIndexParameters

BATCH_SIZE_PARAMETER, COMMIT_BATCH_SIZE_PARAMETER, LUCENE_ENGINE, MAX_BATCH, MAX_COMMIT, MAX_COMMIT_BATCH, MAX_CONNS, MAX_WAIT_TIMEOUT, REINDEX_NUM_CONNS_PARAMETER, SEARCH_ENGINE_PARAMETER, SOLR_ENGINE, WRITE_TIMEOUT_PARAMETER

Method Summary

Modifier and Type	Method and Description
static LuceneIndexParameters	createInstance(int numSubDirs, int reindexNumConns, int batchSize, int commitBatchSize, boolean differentiateDatatypes, java.lang.String dirname) Creates a new OracleIndexParams object from the set of parameters.
static LuceneIndexParameters	createInstance(int numSubDirs, int reindexNumConns, int batchSize, int commitBatchSize, boolean differentiateDatatypes, java.lang.String[] dirnames) Creates a new OracleIndexParams object from the set of parameters.
static java.util.List<com.tinkerpop.blueprints.Parameter>	defaultIndexParamsAsList() Gets Oracle's default list of parameters defined for an index.
static LuceneIndexParameters	getInstance(com.tinkerpop.blueprints.Parameter[] parameters) Creates a new OracleIndexParameters object from an initial set of parameters.

Methods inherited from class oracle.pg.text.OracleIndexParameters

addParameter, buildFS, buildFS, buildSolr, defaultIndexParams, getParameters, toString

Methods inherited from class java.lang.Object

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

Field Detail

ANALYZER_PARAMETER

public static final java.lang.String ANALYZER_PARAMETER

This constant denotes the parameter for the analyzer object used in an Apache Lucene index

See Also:

Constant Field Values

DATATYPES_PARAMETER

public static final java.lang.String DATATYPES_PARAMETER

This constant denotes the parameter for the way values are stored in an Apache Lucene index, if true, all values will be stored as strings, else all values will be stored using their datatypes

See Also:

Constant Field Values

LOCATION_PARAMETER

public static final java.lang.String LOCATION_PARAMETER

This constant denotes the parameter for the locations where an Apache Lucene index will reside using a FS Directory

See Also:

Constant Field Values

LUCENE_DIRECTORY_TYPE_PARAMETER

public static final java.lang.String LUCENE_DIRECTORY_TYPE_PARAMETER

This constant denotes the parameter for the directory type to use in an Apache Lucene index e.g. FS Directory, JDBC Directory

See Also:

Constant Field Values

MAX_NUM_SUBDIRS

public static final int MAX_NUM_SUBDIRS

This constant denotes the parameter for the maximum number of subdirectories allowed per text index

See Also:

Constant Field Values

NUM_SUBDIRS_PARAMETER

public static final java.lang.String NUM_SUBDIRS_PARAMETER

This constant denotes the parameter for the number of sub-directories used in an Apache Lucene index

See Also:

Constant Field Values

POOL_PARAMETER

public static final java.lang.String POOL_PARAMETER

This constant denotes the parameter for the oracle pool used in an Apache Lucene index with a JDBC directory

See Also:

Constant Field Values

VERSION_PARAMETER

public static final java.lang.String VERSION_PARAMETER

This constant denotes the parameter for the Apache Lucene version

See Also:

Constant Field Values

Method Detail

createInstance

public static LuceneIndexParameters createInstance(int numSubDirs,
                                                   int reindexNumConns,
                                                   int batchSize,
                                                   int commitBatchSize,
                                                   boolean differentiateDatatypes,
                                                   java.lang.String dirname)

Creates a new OracleIndexParams object from the set of parameters.

Parameters:

numSubDirs - the number of sub-directories to store the index

reindexNumConns - the number of connections to use when dealing with re-indexing operations

batchSize - the batch size to use when indexing data. This reduce the round trip operations over the Lucene index

commitBatchSize - the commit batch size to use when indexing data. This reduce the number of commit operations over the Lucene index

differentiateDatatypes - if true, data types will be used when indexing data into the Lucene index

dirname - the directory name where the Lucene index is stored. All sub-directories will be stored under this file-path.

createInstance

public static LuceneIndexParameters createInstance(int numSubDirs,
                                                   int reindexNumConns,
                                                   int batchSize,
                                                   int commitBatchSize,
                                                   boolean differentiateDatatypes,
                                                   java.lang.String[] dirnames)

Creates a new OracleIndexParams object from the set of parameters.

Parameters:

numSubDirs - the number of sub-directories to store the index

reindexNumConns - the number of connections to use when dealing with re-indexing operations

batchSize - the batch size to use when indexing data. This reduce the round trip operations over the Lucene index

commitBatchSize - the commit batch size to use when indexing data. This reduce the number of commit operations over the Lucene index

differentiateDatatypes - if true, data types will be used when indexing data into the Lucene index

dirnames - an array of directory names where the Lucene index will be stored. Sub-directories will be distributed among these file-paths.

defaultIndexParamsAsList

public static java.util.List<com.tinkerpop.blueprints.Parameter> defaultIndexParamsAsList()

Gets Oracle's default list of parameters defined for an index.

Returns:

a list of Parameter objects

getInstance

public static LuceneIndexParameters getInstance(com.tinkerpop.blueprints.Parameter[] parameters)

Creates a new OracleIndexParameters object from an initial set of parameters.