com.complexible.stardog.search

Class SearchOptions

java.lang.Object

com.complexible.stardog.search.SearchOptions

All Implemented Interfaces:

MetaPropertyProvider

public final class SearchOptions
extends Object
implements MetaPropertyProvider

Database options for the waldo search index.

Since:

1.2

Version:

6.0

Author:

Michael Grove

Field Summary

Fields

Modifier and Type	Field and Description
static String	FTS_CATEGORY
static ConfigProperty<Boolean>	INDEX_COMPUTE_NORM
static ConfigProperty<Collection<IRI>>	INDEX_DATATYPES Option to specify the datatypes for which to index literals.
static ConfigProperty<Collection<IRI>>	INDEX_PROPERTIES_EXCLUDED Option to specify the properties to be excluded for literals to be indexed.
static ConfigProperty<Collection<IRI>>	INDEX_PROPERTIES_INCLUDED Option to specify the only properties for literals to be indexed.
static ConfigProperty<Collection<String>>	INDEX_STOPWORDS Option to specify the stopwords for which to filter terms while indexing terms.
static ConfigProperty<Boolean>	LEADING_WILDCARD_SEARCH_ENABLED Option to enable the Lucene query parser's support of leading wildcards in queries as shown here.
static ConfigProperty<Boolean>	OPTIMIZE
static String	PROPERTY_DEFAULT_QUERY_OPERATOR
static String	PROPERTY_INDEX_COMPUTE_NORM
static String	PROPERTY_INDEX_DATATYPE
static String	PROPERTY_INDEX_PROPERTIES_EXCLUDED
static String	PROPERTY_INDEX_PROPERTIES_INCLUDED
static String	PROPERTY_INDEX_STOPWORDS
static String	PROPERTY_LEADING_WILDCARD_SEARCH_ENABLED
static String	PROPERTY_OPTIMIZE
static String	PROPERTY_REINDEX_CACHE_SIZE
static String	PROPERTY_SEARCH_CONTEXTS_EXCLUDED
static String	PROPERTY_SEARCH_CONTEXTS_FILTER
static String	PROPERTY_SEARCH_INDEX_STATE
static String	PROPERTY_SEARCH_PAGE_SIZE
static String	PROPERTY_USE_VACUUMING
static String	PROPERTY_WORD_BREAK_CHARS
static ConfigProperty<Integer>	REINDEX_CACHE_SIZE Option to specify the cache size of literals that is used for seeing if a literal is reindexed before.
static ConfigProperty<Boolean>	SEARCH_CONTEXTS_EXCLUDED Option to specify if SEARCH_CONTEXTS_FILTER, the collection of contexts in named graphs, is going to be leveraged as either excluded or included for literals to be indexed.
static ConfigProperty<Collection<IRI>>	SEARCH_CONTEXTS_FILTER Option to specify the collection of contexts in named graphs to be excluded or included for literals to be indexed depending on SEARCH_CONTEXTS_EXCLUDED option: By default SEARCH_CONTEXTS_EXCLUDED is set to true, meaning this set is to be leveraged as an exclusion list.
static ConfigProperty<Integer>	SEARCH_DEFAULT_LIMIT Deprecated.
static ConfigProperty<String>	SEARCH_DEFAULT_QUERY_OPERATOR
static ConfigProperty<Boolean>	SEARCH_INDEX_DIRTY Deprecated.
static ConfigProperty<com.complexible.stardog.search.SearchIndexState>	SEARCH_INDEX_STATE State of the search index, see SearchIndexState
static ConfigProperty<Integer>	SEARCH_PAGE_SIZE Specify the page size used for iteration over results from the full-text index.
static ConfigProperty<Boolean>	SEARCH_REINDEX_IN_TX Flag to indicate if the search index should be updated as part of update transactions.
static ConfigProperty<Boolean>	SEARCHABLE Option for whether or not full-text search via Waldo is enabled for the database
static ConfigProperty<Boolean>	USE_VACUUMING
static ConfigProperty<String>	WORD_BREAK_CHARS

Constructor Summary

Constructors

Constructor and Description
SearchOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_SEARCH_INDEX_STATE

public static final String PROPERTY_SEARCH_INDEX_STATE

See Also:

Constant Field Values

PROPERTY_LEADING_WILDCARD_SEARCH_ENABLED

public static final String PROPERTY_LEADING_WILDCARD_SEARCH_ENABLED

See Also:

Constant Field Values

PROPERTY_SEARCH_PAGE_SIZE

public static final String PROPERTY_SEARCH_PAGE_SIZE

See Also:

Constant Field Values

PROPERTY_DEFAULT_QUERY_OPERATOR

public static final String PROPERTY_DEFAULT_QUERY_OPERATOR

See Also:

Constant Field Values

PROPERTY_INDEX_DATATYPE

public static final String PROPERTY_INDEX_DATATYPE

See Also:

Constant Field Values

PROPERTY_WORD_BREAK_CHARS

public static final String PROPERTY_WORD_BREAK_CHARS

See Also:

Constant Field Values

PROPERTY_INDEX_STOPWORDS

public static final String PROPERTY_INDEX_STOPWORDS

See Also:

Constant Field Values

PROPERTY_INDEX_PROPERTIES_EXCLUDED

public static final String PROPERTY_INDEX_PROPERTIES_EXCLUDED

See Also:

Constant Field Values

PROPERTY_SEARCH_CONTEXTS_FILTER

public static final String PROPERTY_SEARCH_CONTEXTS_FILTER

See Also:

Constant Field Values

PROPERTY_SEARCH_CONTEXTS_EXCLUDED

public static final String PROPERTY_SEARCH_CONTEXTS_EXCLUDED

See Also:

Constant Field Values

PROPERTY_INDEX_PROPERTIES_INCLUDED

public static final String PROPERTY_INDEX_PROPERTIES_INCLUDED

See Also:

Constant Field Values

PROPERTY_INDEX_COMPUTE_NORM

public static final String PROPERTY_INDEX_COMPUTE_NORM

See Also:

Constant Field Values

PROPERTY_OPTIMIZE

public static final String PROPERTY_OPTIMIZE

See Also:

Constant Field Values

PROPERTY_USE_VACUUMING

public static final String PROPERTY_USE_VACUUMING

See Also:

Constant Field Values

PROPERTY_REINDEX_CACHE_SIZE

public static final String PROPERTY_REINDEX_CACHE_SIZE

See Also:

Constant Field Values

FTS_CATEGORY

public static final String FTS_CATEGORY

See Also:

Constant Field Values

SEARCH_INDEX_DIRTY

@Deprecated
public static final ConfigProperty<Boolean> SEARCH_INDEX_DIRTY

Deprecated.

SEARCH_INDEX_STATE

public static final ConfigProperty<com.complexible.stardog.search.SearchIndexState> SEARCH_INDEX_STATE

State of the search index, see SearchIndexState

Full name: search.index.state
Default value: SearchIndexState.Dirty

SEARCH_REINDEX_IN_TX

public static final ConfigProperty<Boolean> SEARCH_REINDEX_IN_TX

Flag to indicate if the search index should be updated as part of update transactions. If this flag is set to false and search queries will return incomplete results until search index is rebuilt.

Full name: search.reindex.tx
Default value: true

SEARCHABLE

public static final ConfigProperty<Boolean> SEARCHABLE

Option for whether or not full-text search via Waldo is enabled for the database

LEADING_WILDCARD_SEARCH_ENABLED

public static final ConfigProperty<Boolean> LEADING_WILDCARD_SEARCH_ENABLED

Option to enable the Lucene query parser's support of leading wildcards in queries as shown here. This option should be used with care because leading wildcard searches are not very efficient.

Full name: leading.wildcard.search.enabled
Default value: false

SEARCH_PAGE_SIZE

public static final ConfigProperty<Integer> SEARCH_PAGE_SIZE

Specify the page size used for iteration over results from the full-text index. A page is held in memory, so this count should NOT be large.

Full name: search.page.size
Default value: 100

SEARCH_DEFAULT_LIMIT

@Deprecated
public static final ConfigProperty<Integer> SEARCH_DEFAULT_LIMIT

Deprecated.

Default max number of results from a lucene search, can be overridden in the search

Full name: search.default.limit
Default value: -1 (all results)

SEARCH_DEFAULT_QUERY_OPERATOR

public static final ConfigProperty<String> SEARCH_DEFAULT_QUERY_OPERATOR

INDEX_PROPERTIES_EXCLUDED

public static final ConfigProperty<Collection<IRI>> INDEX_PROPERTIES_EXCLUDED

Option to specify the properties to be excluded for literals to be indexed. Default value is an empty HashSet, could be populated with IRIs using the same constructor. Full name: "search.index.properties.excluded"

INDEX_PROPERTIES_INCLUDED

public static final ConfigProperty<Collection<IRI>> INDEX_PROPERTIES_INCLUDED

Option to specify the only properties for literals to be indexed. Default value is an empty HashSet, could be populated with IRIs using the same constructor. Please note that if INDEX_PROPERTIES_EXCLUDED option is set, this option will have no effect. Full name: "search.index.properties.included"

SEARCH_CONTEXTS_FILTER

public static final ConfigProperty<Collection<IRI>> SEARCH_CONTEXTS_FILTER

Option to specify the collection of contexts in named graphs to be excluded or included for literals to be indexed depending on SEARCH_CONTEXTS_EXCLUDED option: By default SEARCH_CONTEXTS_EXCLUDED is set to true, meaning this set is to be leveraged as an exclusion list. Otherwise, which is the case that option is set to false, the set is to be an inclusive one. Default value is an empty collection, could be populated with IRIs using the same constructor. Full name: "search.index.contexts.filter"

SEARCH_CONTEXTS_EXCLUDED

public static final ConfigProperty<Boolean> SEARCH_CONTEXTS_EXCLUDED

Option to specify if SEARCH_CONTEXTS_FILTER, the collection of contexts in named graphs, is going to be leveraged as either excluded or included for literals to be indexed. Default value: true Full name: "search.index.contexts.excluded"

INDEX_DATATYPES

public static final ConfigProperty<Collection<IRI>> INDEX_DATATYPES

Option to specify the datatypes for which to index literals.

INDEX_COMPUTE_NORM

public static final ConfigProperty<Boolean> INDEX_COMPUTE_NORM

OPTIMIZE

public static final ConfigProperty<Boolean> OPTIMIZE

USE_VACUUMING

public static final ConfigProperty<Boolean> USE_VACUUMING

WORD_BREAK_CHARS

public static final ConfigProperty<String> WORD_BREAK_CHARS

INDEX_STOPWORDS

public static final ConfigProperty<Collection<String>> INDEX_STOPWORDS

Option to specify the stopwords for which to filter terms while indexing terms. The default value is null, which is leveraged as Lucene's ENGLISH_STOP_WORDS_SET For customization, a list of string should be assigned, e.g. Arrays.asList("a", "an")

REINDEX_CACHE_SIZE

public static final ConfigProperty<Integer> REINDEX_CACHE_SIZE

Option to specify the cache size of literals that is used for seeing if a literal is reindexed before. Full name: "search.reindex.cache.size"

Constructor Detail

SearchOptions

public SearchOptions()