oracle.pg.rdbms.index.oratext

Class OracleTextIndexParameters

java.lang.Object

oracle.pg.text.OracleIndexParameters

oracle.pg.rdbms.index.oratext.OracleTextIndexParameters

public class OracleTextIndexParameters
extends OracleIndexParameters

This class manages relevant parameters for text indexing using Oracle Text.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATASTORE_PARAMETER This constant denotes a data store preference specifying the way text values are stored.
static java.lang.String	DOP_PARAMETER This constant denotes the degree of parallelism used for index creation
static java.lang.String	FILTER_PARAMETER This constant denotes a filter preference specifying how text is filtered for indexing
static java.lang.String	LEXER_LIST_PARAMETER This constant denotes the lexer preference specifying the language of the text to be indexed
static java.lang.Integer	MAX_DOP
static java.lang.String	OPTIONS_PARAMETER This constant denotes the additional settings used for index creation
static java.lang.Integer	ORA_TEXT_ENGINE This constant denotes the usage of a Oracle Text search engine
static java.lang.String	PREF_OWNER_PARAMETER This constant denotes the parameter for the owner of the preferences
static java.lang.String	STOP_LIST_PARAMETER This constant denotes the stop list preference specifying the list of words that are not meant to be indexed
static java.lang.String	STORAGE_PARAMETER This constant denotes a storage preference specifying the table space and creation parameters for tables associated with a text index
static java.lang.String	WORD_LIST_PARAMETER This constant denotes a word list preference specifying the enabled query options e.g.

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

Constructor Summary

Constructors

Constructor and Description
OracleTextIndexParameters() Creates a new OracleTextIndexParameters object.
OracleTextIndexParameters(java.util.List<Parameter> parameters) Creates a new OracleTextIndexParameters object from an initial set of parameters.
OracleTextIndexParameters(Parameter[] parameters) Creates a new OracleTexIndexParameters object from an initial set of parameters.

Method Summary

Modifier and Type	Method and Description
static OracleIndexParameters	buildDefaultOracleText() Creates a new OracleIndexParameters object from the set of default parameters used to configure a text index using Oracle Text.
static OracleIndexParameters	buildOracleText(java.lang.String prefOwner, java.lang.String datastore, java.lang.String filter, java.lang.String storage, java.lang.String wordlist, java.lang.String stoplist, java.lang.String lexer, int dop, java.lang.String options) Creates a new OracleIndexParameters object from the set of parameters used to configure a text index using Oracle Text.
java.util.List<Parameter>	defaultIndexParamsAsList() Gets Oracle's default list of parameters defined for a text index using Oracle Text The owner of the preferences will be set to "MDSYS", By default the data store, filter, storage, word list, and stop list preferences used will be the default preferences of CTXSYS user.
static OracleTextIndexParameters	getInstance(Parameter[] parameters) Creates a new OracleIndexParameters object from an initial set of parameters.

Methods inherited from class oracle.pg.text.OracleIndexParameters

addParameter, defaultIndexParams, getParameters, toString

Methods inherited from class java.lang.Object

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

Field Detail

DATASTORE_PARAMETER

public static final java.lang.String DATASTORE_PARAMETER

This constant denotes a data store preference specifying the way text values are stored.

See Also:

Constant Field Values

DOP_PARAMETER

public static final java.lang.String DOP_PARAMETER

This constant denotes the degree of parallelism used for index creation

See Also:

Constant Field Values

FILTER_PARAMETER

public static final java.lang.String FILTER_PARAMETER

This constant denotes a filter preference specifying how text is filtered for indexing

See Also:

Constant Field Values

LEXER_LIST_PARAMETER

public static final java.lang.String LEXER_LIST_PARAMETER

This constant denotes the lexer preference specifying the language of the text to be indexed

See Also:

Constant Field Values

MAX_DOP

public static final java.lang.Integer MAX_DOP

OPTIONS_PARAMETER

public static final java.lang.String OPTIONS_PARAMETER

This constant denotes the additional settings used for index creation

See Also:

Constant Field Values

ORA_TEXT_ENGINE

public static final java.lang.Integer ORA_TEXT_ENGINE

This constant denotes the usage of a Oracle Text search engine

PREF_OWNER_PARAMETER

public static final java.lang.String PREF_OWNER_PARAMETER

This constant denotes the parameter for the owner of the preferences

See Also:

Constant Field Values

STOP_LIST_PARAMETER

public static final java.lang.String STOP_LIST_PARAMETER

This constant denotes the stop list preference specifying the list of words that are not meant to be indexed

See Also:

Constant Field Values

STORAGE_PARAMETER

public static final java.lang.String STORAGE_PARAMETER

This constant denotes a storage preference specifying the table space and creation parameters for tables associated with a text index

See Also:

Constant Field Values

WORD_LIST_PARAMETER

public static final java.lang.String WORD_LIST_PARAMETER

This constant denotes a word list preference specifying the enabled query options e.g. stemming, fuzzy matching, etc.

See Also:

Constant Field Values

Constructor Detail

OracleTextIndexParameters

public OracleTextIndexParameters()

Creates a new OracleTextIndexParameters object.

OracleTextIndexParameters

public OracleTextIndexParameters(java.util.List<Parameter> parameters)

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

OracleTextIndexParameters

public OracleTextIndexParameters(Parameter[] parameters)

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

Method Detail

buildDefaultOracleText

public static OracleIndexParameters buildDefaultOracleText()

Creates a new OracleIndexParameters object from the set of default parameters used to configure a text index using Oracle Text. The owner of the preferences will be set to "MDSYS", By default the data store, filter, storage, word list, and stop list preferences used will be the default preferences of CTXSYS user. The default lexer preference used is OPG_AUTO_LEXER.

buildOracleText

public static OracleIndexParameters buildOracleText(java.lang.String prefOwner,
                                                    java.lang.String datastore,
                                                    java.lang.String filter,
                                                    java.lang.String storage,
                                                    java.lang.String wordlist,
                                                    java.lang.String stoplist,
                                                    java.lang.String lexer,
                                                    int dop,
                                                    java.lang.String options)

Creates a new OracleIndexParameters object from the set of parameters used to configure a text index using Oracle Text.

Parameters:

prefOwner - the owner of the preference.

datastore - the data store preference specifying how the text values are stored. If the value is set to NULL, then the index will be created with CTXSYS.DEFAULT_DATASORE.

filter - the filter preference determining how text is filtered for indexing. If the value is set to NULL, then the index will be created with CTXSYS.NULL_FILTER.

storage - the storage preference specifying table space and creation parameters for tables associated with a Text index. If the value is set to NULL, then the index will be created with CTXSYS.DEFAULT_STORAGE.

wordlist - the word list preference specifying the enabled query options. These query options may include stemming, fuzzy matching, substring and prefix indexing, etc. If the value is set to NULL, then the index will be created with CTXSYS.DEFAULT_WORDLIST.

stoplist - the stop list preference specifying the list of words that are not meant to be indexed. If the value is set to NULL, then the index will be created with CTXSYS.DEFAULT_STOPLIST.

lexer - the lexer preference specifying the language of the text to be indexed. If the value is set to NULL, then the index will be created with OPG_AUTO_LEXER.

dop - the degree of parallelism to use as a SQL hint for index creation

options - additional SQL options to optimize text index operations.

defaultIndexParamsAsList

public java.util.List<Parameter> defaultIndexParamsAsList()

Gets Oracle's default list of parameters defined for a text index using Oracle Text The owner of the preferences will be set to "MDSYS", By default the data store, filter, storage, word list, and stop list preferences used will be the default preferences of CTXSYS user. The default lexer preference used is OPG_AUTO_LEXER.

Overrides:

defaultIndexParamsAsList in class OracleIndexParameters

Returns:

a list of Parameter objects

getInstance

public static OracleTextIndexParameters getInstance(Parameter[] parameters)

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