LuceneIndexConstants (The Adobe AEM Quickstart and Web Application.)

All Superinterfaces:

org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants
```
public interface LuceneIndexConstants
extends org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants
```
Constants used internally in Lucene indexes.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants
  org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants.IndexingMode

Field Summary

Fields
Modifier and Type	Field and Description
`static org.apache.lucene.analysis.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`	`CODEC_NAME` Name of the codec to be used for indexing
`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_ORIGINAL_TERM` Boolean property indicating if in-built analyzer should preserve original term (i.e.
`static java.lang.String`	`INDEX_PATH` Deprecated. With OAK-4152 no need to explicitly define indexPath property
`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`	`MERGE_POLICY_NAME` Name of the merge policy to be used while indexing
`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_USE_IN_SIMILARITY` whether use this property values for similarity
`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`	`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_DATA_CHILD_NAME`
`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_MAPPED_TYPE` Property name within the mime type structure which defines a mime type mapping
`static java.lang.String`	`TIKA_MAX_EXTRACT_LENGTH`
`static java.lang.String`	`TIKA_MIME_TYPES` Config node under tika which defines mime type mappings
`static java.lang.String`	`TRASH_CHILD_NAME`
`static java.lang.String`	`TYPE_LUCENE`
`static org.apache.lucene.util.Version`	`VERSION`

Fields inherited from interface org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants
AGG_PATH, AGG_PRIMARY_TYPE, AGG_RECURSIVE_LIMIT, AGG_RELATIVE_NODE, AGGREGATES, BLOB_SIZE, COMPAT_MODE, COST_PER_ENTRY, COST_PER_EXECUTION, EVALUATE_PATH_RESTRICTION, EXCERPT_NODE_FIELD_NAME, EXCLUDE_PROPERTY_NAMES, EXPERIMENTAL_STORAGE, FACETS, FIELD_BOOST, FULL_TEXT_ENABLED, FUNC_NAME, INCLUDE_PROPERTY_NAMES, INCLUDE_PROPERTY_TYPES, INDEX_DATA_CHILD_NAME, INDEX_RULES, ORDERED_PROP_NAMES, PERSISTENCE_FILE, PERSISTENCE_NAME, PERSISTENCE_OAK, PERSISTENCE_PATH, PROP_ANALYZED, PROP_EXCLUDE_FROM_AGGREGATE, PROP_FACETS, PROP_FACETS_TOP_CHILDREN, PROP_FUNCTION, PROP_INCLUDED_TYPE, PROP_INDEX, PROP_INDEX_NODE_TYPE, PROP_IS_REGEX, PROP_NAME, PROP_NODE, PROP_NODE_SCOPE_INDEX, PROP_ORDERED, PROP_PROPERTY_INDEX, PROP_REFRESH_DEFN, PROP_SCORER_PROVIDER, PROP_SECURE_FACETS, PROP_SIMILARITY_RERANK, PROP_SYNC, PROP_TYPE, PROP_UNIQUE, PROP_USE_IN_EXCERPT, PROP_WEIGHT, REGEX_ALL_PROPS, RULE_INHERITED, SUGGEST_ANALYZED, USE_IF_EXISTS

- Field Detail
  - TYPE_LUCENE
```
static final java.lang.String TYPE_LUCENE
```
    See Also:
    
    Constant Field Values
  - SUGGEST_DATA_CHILD_NAME
```
static final java.lang.String SUGGEST_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 org.apache.lucene.util.Version VERSION
```
  - ANALYZER
```
static final org.apache.lucene.analysis.Analyzer ANALYZER
```
  - CODEC_NAME
```
static final java.lang.String CODEC_NAME
```
    Name of the codec to be used for indexing
    
    See Also:
    
    Constant Field Values
  - MERGE_POLICY_NAME
```
static final java.lang.String MERGE_POLICY_NAME
```
    Name of the merge policy to be used while indexing
    
    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
  - INDEX_ORIGINAL_TERM
```
static final java.lang.String INDEX_ORIGINAL_TERM
```
    Boolean property indicating if in-built analyzer should preserve original term (i.e. use WordDelimiterFilter.PRESERVE_ORIGINAL flag)
    
    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
```
    See Also:
    
    Constant Field Values
  - 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
  - TIKA_MIME_TYPES
```
static final java.lang.String TIKA_MIME_TYPES
```
    Config node under tika which defines mime type mappings
    
    See Also:
    
    Constant Field Values
  - TIKA_MAPPED_TYPE
```
static final java.lang.String TIKA_MAPPED_TYPE
```
    Property name within the mime type structure which defines a mime type mapping
    
    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_USE_IN_SIMILARITY
```
static final java.lang.String PROP_USE_IN_SIMILARITY
```
    whether use this property values for similarity
    
    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
```
@Deprecated
static final java.lang.String INDEX_PATH
```
    Deprecated. With OAK-4152 no need to explicitly define indexPath property
    
    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

Interface LuceneIndexConstants

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants

Field Detail

TYPE_LUCENE

SUGGEST_DATA_CHILD_NAME

TRASH_CHILD_NAME

VERSION

ANALYZER

CODEC_NAME

MERGE_POLICY_NAME

TEST_MODE

INDEX_ORIGINAL_TERM

ANALYZERS

ANL_DEFAULT

ANL_FILTERS

ANL_STOPWORDS

ANL_TOKENIZER

ANL_CHAR_FILTERS

ANL_CLASS

ANL_NAME

ANL_LUCENE_MATCH_VERSION

TIKA

TIKA_CONFIG

TIKA_MAX_EXTRACT_LENGTH

TIKA_MIME_TYPES

TIKA_MAPPED_TYPE

MAX_FIELD_LENGTH

PROP_USE_IN_SUGGEST

SUGGESTION_CONFIG

SUGGEST_UPDATE_FREQUENCY_MINUTES

PROP_USE_IN_SPELLCHECK

PROP_USE_IN_SIMILARITY

PROP_NULL_CHECK_ENABLED

PROP_NOT_NULL_CHECK_ENABLED

INDEX_NODE_NAME

PROPDEF_PROP_NODE_NAME

SAVE_DIR_LISTING

INDEX_PATH