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

Interface LuceneIndexConstants

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
    Description
    static final Analyzer
    ANALYZER
     
    static final String
    ANL_LUCENE_MATCH_VERSION
     
    static final String
    CODEC_NAME
    Name of the codec to be used for indexing
    static final String
    INDEX_NODE_NAME
    IndexRule level config to indicate that Node name should also be index to support fn:name() queries
    static final String
    INDEX_PATH
    Deprecated.
    With OAK-4152 no need to explicitly define indexPath property
    static final String
    MAX_FIELD_LENGTH
    The maximum number of terms that will be indexed for a single field in a document.
    static final String
    MERGE_POLICY_NAME
    Name of the merge policy to be used while indexing
    static final String
    PROP_USE_IN_SIMILARITY
    whether use this property values for similarity
    static final String
    PROP_USE_IN_SPELLCHECK
    whether use this property values for spellchecking
    static final String
    PROP_USE_IN_SUGGEST
    whether use this property values for suggestions
    static final String
    PROPDEF_PROP_NODE_NAME
    Property definition name to indicate indexing node name Its value should match FieldNames.NODE_NAME
    static final 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 final String
    SUGGEST_DATA_CHILD_NAME
     
    static final String
    SUGGEST_UPDATE_FREQUENCY_MINUTES
    update frequency of the suggester in minutes
    static final String
    SUGGESTION_CONFIG
    subnode holding configuration for suggestions
    static final String
    TEST_MODE
    Boolean property to indicate that LuceneIndex is being used in testMode and it should participate in every test
    static final String
    TIKA
    Config node which include Tika related configuration
    static final String
    TIKA_CONFIG
    nt:file node under 'tika' node which refers to the config xml file
    static final String
    TIKA_MAPPED_TYPE
    Property name within the mime type structure which defines a mime type mapping
    static final String
    TIKA_MAX_EXTRACT_LENGTH
     
    static final String
    TIKA_MIME_TYPES
    Config node under tika which defines mime type mappings
    static final String
    TRASH_CHILD_NAME
     
    static final String
    TYPE_LUCENE
     
    static final 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, ANALYZERS, ANL_CHAR_FILTERS, ANL_CLASS, ANL_DEFAULT, ANL_FILTERS, ANL_NAME, ANL_STOPWORDS, ANL_TOKENIZER, BLOB_SIZE, COMPAT_MODE, COST_PER_ENTRY, COST_PER_EXECUTION, DYNAMIC_BOOST_WEIGHT, 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_ORIGINAL_TERM, INDEX_RULES, INDEX_SIMILARITY_BINARIES, INDEX_SIMILARITY_STRINGS, INDEX_VERSION_BY_TYPE, ORDERED_PROP_NAMES, PERSISTENCE_FILE, PERSISTENCE_NAME, PERSISTENCE_OAK, PERSISTENCE_PATH, PROP_ANALYZED, PROP_DYNAMIC_BOOST, 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_NOT_NULL_CHECK_ENABLED, PROP_NULL_CHECK_ENABLED, PROP_ORDERED, PROP_PROPERTY_INDEX, PROP_QUERY_FILTER_REGEX, PROP_RANDOM_SEED, PROP_REFRESH_DEFN, PROP_SCORER_PROVIDER, PROP_SECURE_FACETS, PROP_SECURE_FACETS_VALUE_INSECURE, PROP_SECURE_FACETS_VALUE_JVM_PARAM, PROP_SECURE_FACETS_VALUE_SECURE, PROP_SECURE_FACETS_VALUE_STATISTICAL, PROP_SIMILARITY_RERANK, PROP_SIMILARITY_SEARCH_DENSE_VECTOR_SIZE, PROP_SIMILARITY_TAGS, PROP_STATISTICAL_FACET_SAMPLE_SIZE, PROP_SYNC, PROP_TYPE, PROP_UNIQUE, PROP_USE_IN_EXCERPT, PROP_VALUE_REGEX, PROP_WEIGHT, REGEX_ALL_PROPS, RULE_INHERITED, STATISTICAL_FACET_SAMPLE_SIZE_DEFAULT, STATISTICAL_FACET_SAMPLE_SIZE_JVM_PARAM, SUGGEST_ANALYZED, USE_IF_EXISTS

  • Field Details

    • TYPE_LUCENE

      static final String TYPE_LUCENE
      See Also:

    • SUGGEST_DATA_CHILD_NAME

      static final String SUGGEST_DATA_CHILD_NAME
      See Also:

    • TRASH_CHILD_NAME

      static final String TRASH_CHILD_NAME
      See Also:

    • VERSION

      static final Version VERSION

    • ANALYZER

      static final Analyzer ANALYZER

    • CODEC_NAME

      static final String CODEC_NAME
      Name of the codec to be used for indexing
      See Also:

    • MERGE_POLICY_NAME

      static final String MERGE_POLICY_NAME
      Name of the merge policy to be used while indexing
      See Also:

    • TEST_MODE

      static final String TEST_MODE
      Boolean property to indicate that LuceneIndex is being used in testMode and it should participate in every test
      See Also:

    • ANL_LUCENE_MATCH_VERSION

      static final String ANL_LUCENE_MATCH_VERSION
      See Also:

    • TIKA

      static final String TIKA
      Config node which include Tika related configuration
      See Also:

    • TIKA_CONFIG

      static final String TIKA_CONFIG
      nt:file node under 'tika' node which refers to the config xml file
      See Also:

    • TIKA_MAX_EXTRACT_LENGTH

      static final String TIKA_MAX_EXTRACT_LENGTH
      See Also:

    • TIKA_MIME_TYPES

      static final String TIKA_MIME_TYPES
      Config node under tika which defines mime type mappings
      See Also:

    • TIKA_MAPPED_TYPE

      static final String TIKA_MAPPED_TYPE
      Property name within the mime type structure which defines a mime type mapping
      See Also:

    • MAX_FIELD_LENGTH

      static final 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:

    • PROP_USE_IN_SUGGEST

      static final String PROP_USE_IN_SUGGEST
      whether use this property values for suggestions
      See Also:

    • SUGGESTION_CONFIG

      static final String SUGGESTION_CONFIG
      subnode holding configuration for suggestions
      See Also:

    • SUGGEST_UPDATE_FREQUENCY_MINUTES

      static final String SUGGEST_UPDATE_FREQUENCY_MINUTES
      update frequency of the suggester in minutes
      See Also:

    • PROP_USE_IN_SPELLCHECK

      static final String PROP_USE_IN_SPELLCHECK
      whether use this property values for spellchecking
      See Also:

    • PROP_USE_IN_SIMILARITY

      static final String PROP_USE_IN_SIMILARITY
      whether use this property values for similarity
      See Also:

    • INDEX_NODE_NAME

      static final String INDEX_NODE_NAME
      IndexRule level config to indicate that Node name should also be index to support fn:name() queries
      See Also:

    • PROPDEF_PROP_NODE_NAME

      static final String PROPDEF_PROP_NODE_NAME
      Property definition name to indicate indexing node name Its value should match FieldNames.NODE_NAME
      See Also:

    • SAVE_DIR_LISTING

      static final 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:

    • INDEX_PATH

      @Deprecated static final 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: