org.apache.jackrabbit.oak.plugins.index.lucene

Interface LuceneIndexConstants

public interface LuceneIndexConstants

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTIVE_DELETE Actively the data store files after this many hours.
static java.lang.String	AGG_PATH Name of property which stores the aggregate include pattern like jcr:content/metadata
static java.lang.String	AGG_PRIMARY_TYPE
static java.lang.String	AGG_RECURSIVE_LIMIT Limit for maximum number of reaggregates allowed.
static java.lang.String	AGG_RELATIVE_NODE Boolean property indicating that separate fulltext field should be created for node represented by this pattern
static java.lang.String	AGGREGATES Node name storing the aggregate rules
static Analyzer	ANALYZER
static java.lang.String	ANALYZERS Node name under which various analyzers are configured
static java.lang.String	ANL_CHAR_FILTERS
static java.lang.String	ANL_CLASS
static java.lang.String	ANL_DEFAULT Name of the default analyzer definition node under 'analyzers' node
static java.lang.String	ANL_FILTERS
static java.lang.String	ANL_LUCENE_MATCH_VERSION
static java.lang.String	ANL_NAME
static java.lang.String	ANL_STOPWORDS
static java.lang.String	ANL_TOKENIZER
static java.lang.String	BLOB_SIZE Size in bytes used for splitting the index files when storing them in NodeStore
static java.lang.String	CODEC_NAME Name of the codec to be used for indexing
static java.lang.String	COMPAT_MODE Integer property indicating that LuceneIndex should be used in compat mode to specific version
static java.lang.String	COST_PER_ENTRY
static java.lang.String	COST_PER_EXECUTION
static java.lang.String	EVALUATE_PATH_RESTRICTION
static java.lang.String	EXCLUDE_PROPERTY_NAMES exclude certain properties by name
static java.lang.String	EXPERIMENTAL_STORAGE Experimental flag to control storage behavior: 'null' or 'true' means the content is stored
static java.lang.String	FACETS Optional subnode holding configuration for facets.
static java.lang.String	FIELD_BOOST Field boost factor
static java.lang.String	FULL_TEXT_ENABLED Determines if full text indexing is enabled for this index definition.
static java.lang.String	FUNC_NAME Native function name associated with this index definition.
static java.lang.String	INCLUDE_PROPERTY_NAMES Only include properties with name in this set.
static java.lang.String	INCLUDE_PROPERTY_TYPES include only certain property types in the index
static java.lang.String	INDEX_DATA_CHILD_NAME
static java.lang.String	INDEX_DATA_CHILD_NAME_FS
static java.lang.String	INDEX_NODE_NAME IndexRule level config to indicate that Node name should also be index to support fn:name() queries
static java.lang.String	INDEX_PATH Optional Property to store the path of index in the repository.
static java.lang.String	INDEX_RULES
static java.lang.String	MAX_FIELD_LENGTH The maximum number of terms that will be indexed for a single field in a document.
static java.lang.String	ORDERED_PROP_NAMES Defines properties which would be used for ordering.
static java.lang.String	PERSISTENCE_FILE
static java.lang.String	PERSISTENCE_NAME
static java.lang.String	PERSISTENCE_OAK
static java.lang.String	PERSISTENCE_PATH
static java.lang.String	PROP_ANALYZED
static java.lang.String	PROP_EXCLUDE_FROM_AGGREGATE Boolean property indicate that property should not be included in aggregation
static java.lang.String	PROP_FACETS Optional (property definition) property indicating whether facets should be created for this property
static java.lang.String	PROP_INCLUDED_TYPE Experimental config to restrict which property type gets indexed at property definition level.
static java.lang.String	PROP_INDEX
static java.lang.String	PROP_IS_REGEX
static java.lang.String	PROP_NAME Property name defined explicitly.
static java.lang.String	PROP_NODE Child node name under which property details are provided
static java.lang.String	PROP_NODE_SCOPE_INDEX
static java.lang.String	PROP_NOT_NULL_CHECK_ENABLED Property definition config indicating that this property would be used with 'IS NOT NULL' constraint
static java.lang.String	PROP_NULL_CHECK_ENABLED Property definition config indicating that null check support should be enabled for this property
static java.lang.String	PROP_ORDERED
static java.lang.String	PROP_PROPERTY_INDEX
static java.lang.String	PROP_SCORER_PROVIDER
static java.lang.String	PROP_SECURE_FACETS Optional (index definition) property indicating whether facets should be ACL checked.
static java.lang.String	PROP_TYPE Type of the property being indexed defined as part of property definition under the given index definition.
static java.lang.String	PROP_USE_IN_EXCERPT
static java.lang.String	PROP_USE_IN_SPELLCHECK whether use this property values for spellchecking
static java.lang.String	PROP_USE_IN_SUGGEST whether use this property values for suggestions
static java.lang.String	PROPDEF_PROP_NODE_NAME Property definition name to indicate indexing node name Its value should match FieldNames.NODE_NAME
static java.lang.String	REGEX_ALL_PROPS Regex to allow inclusion of all immediate properties of the node
static java.lang.String	RULE_INHERITED
static java.lang.String	SAVE_DIR_LISTING Boolean property indicating that Lucene directory content should be saved as part of NodeState itself as a multi value property to allow faster reads (OAK-2809)
static java.lang.String	SUGGEST_ANALYZED Optional property to set the suggest field to be analyzed and therefore allow more fine grained and flexible suggestions.
static java.lang.String	SUGGEST_UPDATE_FREQUENCY_MINUTES update frequency of the suggester in minutes
static java.lang.String	SUGGESTION_CONFIG subnode holding configuration for suggestions
static java.lang.String	TEST_MODE Boolean property to indicate that LuceneIndex is being used in testMode and it should participate in every test
static java.lang.String	TIKA Config node which include Tika related configuration
static java.lang.String	TIKA_CONFIG nt:file node under 'tika' node which refers to the config xml file
static java.lang.String	TIKA_MAX_EXTRACT_LENGTH
static java.lang.String	TRASH_CHILD_NAME
static java.lang.String	TYPE_LUCENE
static Version	VERSION

Field Detail

TYPE_LUCENE

static final java.lang.String TYPE_LUCENE

See Also:

Constant Field Values

INDEX_DATA_CHILD_NAME

static final java.lang.String INDEX_DATA_CHILD_NAME

See Also:

Constant Field Values

TRASH_CHILD_NAME

static final java.lang.String TRASH_CHILD_NAME

See Also:

Constant Field Values

VERSION

static final Version VERSION

ANALYZER

static final Analyzer ANALYZER

INCLUDE_PROPERTY_TYPES

static final java.lang.String INCLUDE_PROPERTY_TYPES

include only certain property types in the index

See Also:

Constant Field Values

EXCLUDE_PROPERTY_NAMES

static final java.lang.String EXCLUDE_PROPERTY_NAMES

exclude certain properties by name

See Also:

Constant Field Values

PERSISTENCE_NAME

static final java.lang.String PERSISTENCE_NAME

See Also:

Constant Field Values

PERSISTENCE_OAK

static final java.lang.String PERSISTENCE_OAK

See Also:

Constant Field Values

PERSISTENCE_FILE

static final java.lang.String PERSISTENCE_FILE

See Also:

Constant Field Values

PERSISTENCE_PATH

static final java.lang.String PERSISTENCE_PATH

See Also:

Constant Field Values

INDEX_DATA_CHILD_NAME_FS

static final java.lang.String INDEX_DATA_CHILD_NAME_FS

See Also:

Constant Field Values

EXPERIMENTAL_STORAGE

static final java.lang.String EXPERIMENTAL_STORAGE

Experimental flag to control storage behavior: 'null' or 'true' means the content is stored

See Also:

Constant Field Values

FULL_TEXT_ENABLED

static final java.lang.String FULL_TEXT_ENABLED

Determines if full text indexing is enabled for this index definition. Default is true

See Also:

Constant Field Values

INCLUDE_PROPERTY_NAMES

static final java.lang.String INCLUDE_PROPERTY_NAMES

Only include properties with name in this set. If this property is defined then excludePropertyNames would be ignored

See Also:

Constant Field Values

PROP_TYPE

static final java.lang.String PROP_TYPE

Type of the property being indexed defined as part of property definition under the given index definition. Refer to javax.jcr.PropertyType contants for the possible values

See Also:

Constant Field Values

ORDERED_PROP_NAMES

static final java.lang.String ORDERED_PROP_NAMES

Defines properties which would be used for ordering. If range queries are to be performed with same property then it must be part of include list also

See Also:

Constant Field Values

ACTIVE_DELETE

static final java.lang.String ACTIVE_DELETE

Actively the data store files after this many hours.

See Also:

Constant Field Values

BLOB_SIZE

static final java.lang.String BLOB_SIZE

Size in bytes used for splitting the index files when storing them in NodeStore

See Also:

Constant Field Values

FUNC_NAME

static final java.lang.String FUNC_NAME

Native function name associated with this index definition. Any query can use this as the function name to ensure that this index gets used for invoking the index

See Also:

Constant Field Values

CODEC_NAME

static final java.lang.String CODEC_NAME

Name of the codec to be used for indexing

See Also:

Constant Field Values

PROP_NODE

static final java.lang.String PROP_NODE

Child node name under which property details are provided

See Also:

Constant Field Values

INDEX_RULES

static final java.lang.String INDEX_RULES

See Also:

Constant Field Values

FIELD_BOOST

static final java.lang.String FIELD_BOOST

Field boost factor

See Also:

Constant Field Values

PROP_NAME

static final java.lang.String PROP_NAME

Property name defined explicitly. Mostly used in case of relative property names

See Also:

Constant Field Values

PROP_IS_REGEX

static final java.lang.String PROP_IS_REGEX

See Also:

Constant Field Values

PROP_INDEX

static final java.lang.String PROP_INDEX

See Also:

Constant Field Values

PROP_USE_IN_EXCERPT

static final java.lang.String PROP_USE_IN_EXCERPT

See Also:

Constant Field Values

PROP_NODE_SCOPE_INDEX

static final java.lang.String PROP_NODE_SCOPE_INDEX

See Also:

Constant Field Values

PROP_PROPERTY_INDEX

static final java.lang.String PROP_PROPERTY_INDEX

See Also:

Constant Field Values

PROP_ANALYZED

static final java.lang.String PROP_ANALYZED

See Also:

Constant Field Values

RULE_INHERITED

static final java.lang.String RULE_INHERITED

See Also:

Constant Field Values

PROP_ORDERED

static final java.lang.String PROP_ORDERED

See Also:

Constant Field Values

PROP_SCORER_PROVIDER

static final java.lang.String PROP_SCORER_PROVIDER

See Also:

Constant Field Values

COMPAT_MODE

static final java.lang.String COMPAT_MODE

Integer property indicating that LuceneIndex should be used in compat mode to specific version

See Also:

Constant Field Values

TEST_MODE

static final java.lang.String TEST_MODE

Boolean property to indicate that LuceneIndex is being used in testMode and it should participate in every test

See Also:

Constant Field Values

EVALUATE_PATH_RESTRICTION

static final java.lang.String EVALUATE_PATH_RESTRICTION

See Also:

Constant Field Values

PROP_INCLUDED_TYPE

static final java.lang.String PROP_INCLUDED_TYPE

Experimental config to restrict which property type gets indexed at property definition level. Mostly index rule level #INCLUDE_PROPERTY_TYPES should be sufficient

See Also:

Constant Field Values

REGEX_ALL_PROPS

static final java.lang.String REGEX_ALL_PROPS

Regex to allow inclusion of all immediate properties of the node

See Also:

Constant Field Values

AGGREGATES

static final java.lang.String AGGREGATES

Node name storing the aggregate rules

See Also:

Constant Field Values

AGG_PRIMARY_TYPE

static final java.lang.String AGG_PRIMARY_TYPE

See Also:

Constant Field Values

AGG_PATH

static final java.lang.String AGG_PATH

Name of property which stores the aggregate include pattern like jcr:content/metadata

See Also:

Constant Field Values

AGG_RECURSIVE_LIMIT

static final java.lang.String AGG_RECURSIVE_LIMIT

Limit for maximum number of reaggregates allowed. For example if there is an aggregate of nt:folder and it also includes nt:folder then aggregation would traverse down untill this limit is hit

See Also:

Constant Field Values

AGG_RELATIVE_NODE

static final java.lang.String AGG_RELATIVE_NODE

Boolean property indicating that separate fulltext field should be created for node represented by this pattern

See Also:

Constant Field Values

COST_PER_ENTRY

static final java.lang.String COST_PER_ENTRY

See Also:

Constant Field Values

COST_PER_EXECUTION

static final java.lang.String COST_PER_EXECUTION

See Also:

Constant Field Values

ANALYZERS

static final java.lang.String ANALYZERS

Node name under which various analyzers are configured

See Also:

Constant Field Values

ANL_DEFAULT

static final java.lang.String ANL_DEFAULT

Name of the default analyzer definition node under 'analyzers' node

See Also:

Constant Field Values

ANL_FILTERS

static final java.lang.String ANL_FILTERS

See Also:

Constant Field Values

ANL_STOPWORDS

static final java.lang.String ANL_STOPWORDS

See Also:

Constant Field Values

ANL_TOKENIZER

static final java.lang.String ANL_TOKENIZER

See Also:

Constant Field Values

ANL_CHAR_FILTERS

static final java.lang.String ANL_CHAR_FILTERS

See Also:

Constant Field Values

ANL_CLASS

static final java.lang.String ANL_CLASS

See Also:

Constant Field Values

ANL_NAME

static final java.lang.String ANL_NAME

See Also:

Constant Field Values

ANL_LUCENE_MATCH_VERSION

static final java.lang.String ANL_LUCENE_MATCH_VERSION

TIKA

static final java.lang.String TIKA

Config node which include Tika related configuration

See Also:

Constant Field Values

TIKA_CONFIG

static final java.lang.String TIKA_CONFIG

nt:file node under 'tika' node which refers to the config xml file

See Also:

Constant Field Values

TIKA_MAX_EXTRACT_LENGTH

static final java.lang.String TIKA_MAX_EXTRACT_LENGTH

See Also:

Constant Field Values

MAX_FIELD_LENGTH

static final java.lang.String MAX_FIELD_LENGTH

The maximum number of terms that will be indexed for a single field in a document. This limits the amount of memory required for indexing, so that collections with very large files will not crash the indexing process by running out of memory.

Note that this effectively truncates large documents, excluding from the index terms that occur further in the document. If you know your source documents are large, be sure to set this value high enough to accommodate the expected size. If you set it to Integer.MAX_VALUE, then the only limit is your memory, but you should anticipate an OutOfMemoryError.

By default, no more than 10,000 terms will be indexed for a field.

See Also:

Constant Field Values

PROP_USE_IN_SUGGEST

static final java.lang.String PROP_USE_IN_SUGGEST

whether use this property values for suggestions

See Also:

Constant Field Values

SUGGESTION_CONFIG

static final java.lang.String SUGGESTION_CONFIG

subnode holding configuration for suggestions

See Also:

Constant Field Values

SUGGEST_UPDATE_FREQUENCY_MINUTES

static final java.lang.String SUGGEST_UPDATE_FREQUENCY_MINUTES

update frequency of the suggester in minutes

See Also:

Constant Field Values

PROP_USE_IN_SPELLCHECK

static final java.lang.String PROP_USE_IN_SPELLCHECK

whether use this property values for spellchecking

See Also:

Constant Field Values

PROP_NULL_CHECK_ENABLED

static final java.lang.String PROP_NULL_CHECK_ENABLED

Property definition config indicating that null check support should be enabled for this property

See Also:

Constant Field Values

PROP_NOT_NULL_CHECK_ENABLED

static final java.lang.String PROP_NOT_NULL_CHECK_ENABLED

Property definition config indicating that this property would be used with 'IS NOT NULL' constraint

See Also:

Constant Field Values

INDEX_NODE_NAME

static final java.lang.String INDEX_NODE_NAME

IndexRule level config to indicate that Node name should also be index to support fn:name() queries

See Also:

Constant Field Values

PROPDEF_PROP_NODE_NAME

static final java.lang.String PROPDEF_PROP_NODE_NAME

Property definition name to indicate indexing node name Its value should match FieldNames.NODE_NAME

See Also:

Constant Field Values

SAVE_DIR_LISTING

static final java.lang.String SAVE_DIR_LISTING

Boolean property indicating that Lucene directory content should be saved as part of NodeState itself as a multi value property to allow faster reads (OAK-2809)

See Also:

Constant Field Values

INDEX_PATH

static final java.lang.String INDEX_PATH

Optional Property to store the path of index in the repository. Path at which index definition is defined is not known to IndexEditor. To make use of CopyOnWrite feature its required to know the indexPath to optimize the lookup and read of existing index files

See Also:

Constant Field Values

FACETS

static final java.lang.String FACETS

Optional subnode holding configuration for facets.

See Also:

Constant Field Values

SUGGEST_ANALYZED

static final java.lang.String SUGGEST_ANALYZED

Optional property to set the suggest field to be analyzed and therefore allow more fine grained and flexible suggestions.

See Also:

Constant Field Values

PROP_SECURE_FACETS

static final java.lang.String PROP_SECURE_FACETS

Optional (index definition) property indicating whether facets should be ACL checked. Default is true

See Also:

Constant Field Values

PROP_FACETS

static final java.lang.String PROP_FACETS

Optional (property definition) property indicating whether facets should be created for this property

See Also:

Constant Field Values

PROP_EXCLUDE_FROM_AGGREGATE

static final java.lang.String PROP_EXCLUDE_FROM_AGGREGATE

Boolean property indicate that property should not be included in aggregation

See Also:

Constant Field Values