com.bigdata.search
Interface FullTextIndex.Options

All Known Subinterfaces:

AbstractTripleStore.Options, BigdataSail.Options, LocalTripleStore.Options, TempTripleStore.Options

Enclosing class:

FullTextIndex<V extends Comparable<V>>

public static interface FullTextIndex.Options

Options understood by the FullTextIndex.

Author:

Bryan Thompson

Field Summary

static String	ANALYZER_FACTORY_CLASS The name of the IAnalyzerFactory class which will be used to obtain analyzers when tokenizing documents and queries (default ).
static String	DEFAULT_ANALYZER_FACTORY_CLASS
static String	DEFAULT_FIELDS_ENABLED
static String	DEFAULT_HIT_CACHE_SIZE
static String	DEFAULT_HIT_CACHE_TIMEOUT_MILLIS Default is 1 minute.
static String	DEFAULT_INDEXER_COLLATOR_STRENGTH
static String	DEFAULT_INDEXER_TIMEOUT
static String	DEFAULT_OVERWRITE
static String	FIELDS_ENABLED When true, the fieldId is stored as part of the key (default "false").
static String	HIT_CACHE_SIZE We keep a small hit cache based on search parameters: search string + prefixMatch + matchAllTerms.
static String	HIT_CACHE_TIMEOUT_MILLIS We keep a small hit cache based on search parameters: search string + prefixMatch + matchAllTerms.
static String	INDEXER_COLLATOR_STRENGTH Specify the collator strength for the full-text index (default ).
static String	INDEXER_TIMEOUT The maximum time in milliseconds that the search engine will await completion of the tasks reading on each of the query terms (default "0").
static String	OVERWRITE indexer.overwrite - boolean option (default true) controls the behavior when a write is requested on the index and the {term,doc,field} tuple which forms the key is already present in the index.

Field Detail

OVERWRITE

static final String OVERWRITE

indexer.overwrite - boolean option (default true) controls the behavior when a write is requested on the index and the {term,doc,field} tuple which forms the key is already present in the index. When true, the new value will be written on the index. When false, the existing value will be retained. This option is an optimization which makes sense when the corpus (a) only grows; and (b) the content of the documents in the corpus never changes. For example, this is true for an RDF database since the set of terms only grows and each term is immutable.

DEFAULT_OVERWRITE

static final String DEFAULT_OVERWRITE

See Also:

Constant Field Values

INDEXER_COLLATOR_STRENGTH

static final String INDEXER_COLLATOR_STRENGTH

Specify the collator strength for the full-text index (default ).

Note: StrengthEnum.Primary is generally what you want for a full text index as search will consider tokens which differ in case and other subtle features to be the same token (a 'match').

See Also:

KeyBuilder.Options#STRENGTH

DEFAULT_INDEXER_COLLATOR_STRENGTH

static final String DEFAULT_INDEXER_COLLATOR_STRENGTH

INDEXER_TIMEOUT

static final String INDEXER_TIMEOUT

The maximum time in milliseconds that the search engine will await completion of the tasks reading on each of the query terms (default "0"). A value of ZERO (0) means NO timeout and is equivalent to a value of Long.MAX_VALUE. If the timeout expires before all tasks complete then the search results will only reflect partial information.

DEFAULT_INDEXER_TIMEOUT

static final String DEFAULT_INDEXER_TIMEOUT

See Also:

Constant Field Values

FIELDS_ENABLED

static final String FIELDS_ENABLED

When true, the fieldId is stored as part of the key (default "false"). When false, each key will be four bytes shorter. Applications which do not use fieldId are should disable it when creating the FullTextIndex.

DEFAULT_FIELDS_ENABLED

static final String DEFAULT_FIELDS_ENABLED

See Also:

Constant Field Values

ANALYZER_FACTORY_CLASS

static final String ANALYZER_FACTORY_CLASS

The name of the IAnalyzerFactory class which will be used to obtain analyzers when tokenizing documents and queries (default ). The specified class MUST implement IAnalyzerFactory and MUST have a constructor with the following signature:

 public MyAnalyzerFactory(FullTextIndexer indexer)
 

DEFAULT_ANALYZER_FACTORY_CLASS

static final String DEFAULT_ANALYZER_FACTORY_CLASS

HIT_CACHE_SIZE

static final String HIT_CACHE_SIZE

We keep a small hit cache based on search parameters: search string + prefixMatch + matchAllTerms. This defines the size of that cache. The value should remain small.

DEFAULT_HIT_CACHE_SIZE

static final String DEFAULT_HIT_CACHE_SIZE

See Also:

Constant Field Values

HIT_CACHE_TIMEOUT_MILLIS

static final String HIT_CACHE_TIMEOUT_MILLIS

We keep a small hit cache based on search parameters: search string + prefixMatch + matchAllTerms. This defines the timeout for values in that cache (in milliseconds). The value should remain small.

DEFAULT_HIT_CACHE_TIMEOUT_MILLIS

static final String DEFAULT_HIT_CACHE_TIMEOUT_MILLIS

Default is 1 minute.