Package com.attivio.sdk.schema

Interface SchemaFieldProperties

  • All Known Implementing Classes:
    Schema, SchemaField
    public interface SchemaFieldProperties
    Contains all standard SchemaField properties and their defaults.

    • Field Detail

      • DEFAULT_CACHE_POLICY

        static final java.lang.String DEFAULT_CACHE_POLICY
        Default value for cachePolicy properties.
        See Also:
        Constant Field Values

      • CACHE_COMPRESSED

        static final java.lang.String CACHE_COMPRESSED
        Property specifying if caches for a field should be compressed in memory.
        See Also:
        Constant Field Values

      • FACET_CACHE_POLICY

        static final java.lang.String FACET_CACHE_POLICY
        Property specifying retention policy for facet cache. Valid values are: soft and static
        See Also:
        Constant Field Values

      • JOIN_CACHE_POLICY

        static final java.lang.String JOIN_CACHE_POLICY
        Property specifying retention policy for equi-join field cache. Valid values are: soft and static
        See Also:
        Constant Field Values

      • FACET_ENUM

        static final java.lang.String FACET_ENUM
        Property specifying if facet field is enum based.
        See Also:
        Constant Field Values

      • FACET_ENUM_FACTOR

        static final java.lang.String FACET_ENUM_FACTOR
        Property specifying if cutoff factor for using enumeration based facet. (0=disabled, max=200).
        See Also:
        Constant Field Values

      • FACET_ENUM_MAX_TERMS

        static final java.lang.String FACET_ENUM_MAX_TERMS
        Property specifying if maximum number of terms to support enum based faceting for.
        See Also:
        Constant Field Values

      • FACET_CACHED

        static final java.lang.String FACET_CACHED
        Property specifying if facet should be cached in memory.
        See Also:
        Constant Field Values

      • FACET_MAX_TERMS

        static final java.lang.String FACET_MAX_TERMS
        Property specifying the maximum number of facet terms allowed.
        See Also:
        Constant Field Values

      • FACET_OUTLIER_FACTOR

        static final java.lang.String FACET_OUTLIER_FACTOR
        Experimental: Property specifying the number of standard deviations away from average frequency that indicates an outlier.

        Set to 0.0 to disable outlier cutoff.

        See Also:
        Constant Field Values

      • FACET_MIN_CUTOFF

        static final java.lang.String FACET_MIN_CUTOFF
        Property name indicating the minimum count for returned facet buckets.

        A value of 0 will result in returning all buckets, even if they have a 0 count.

        See Also:
        Constant Field Values

      • FACET_DISTRIBUTED_MIN_CUTOFF

        static final java.lang.String FACET_DISTRIBUTED_MIN_CUTOFF
        Property name indicating the minimum count for facet buckets returned to the top level dispatcher.

        The value for this property should be less than or equal to the value for the FACET_MIN_CUTOFF property.

        See Also:
        Constant Field Values

      • FACET_MAX_NUM_BUCKETS

        static final java.lang.String FACET_MAX_NUM_BUCKETS
        Property name indicating the default maximum number of buckets returned for a facet.

        A value of -1 for this property will result in all possible buckets being returned.

        See Also:
        Constant Field Values

      • FACET_DISTRIBUTED_MAX_NUM_BUCKETS

        static final java.lang.String FACET_DISTRIBUTED_MAX_NUM_BUCKETS
        Property name indicating the default maximum number of buckets returned by sub dispatchers for a facet field.

        A value of -1 for this property will result in all buckets being returned to the top level dispatcher.

        See Also:
        Constant Field Values

      • INDEX_WILDCARDS

        static final java.lang.String INDEX_WILDCARDS
        Property name indicating if wildcards are legal by default for a field
        See Also:
        Constant Field Values

      • WILDCARD_MODE

        static final java.lang.String WILDCARD_MODE
        Property name indicating the indexing mode for wildcards
        See Also:
        Constant Field Values

      • WILDCARD_STEP

        static final java.lang.String WILDCARD_STEP
        Property name indicating the step value for indexing optimized prefix wildcard terms
        See Also:
        Constant Field Values

      • WILDCARD_MAX_LENGTH

        static final java.lang.String WILDCARD_MAX_LENGTH
        Property name indicating the max length to create optimiezed prefix wildcard terms for
        See Also:
        Constant Field Values

      • WILDCARD_MAX_TERMS

        static final java.lang.String WILDCARD_MAX_TERMS
        Property name indicating the maximum number of terms a wildcard query will expand to.
        See Also:
        Constant Field Values

      • WILDCARD_MAX_PHRASE_TERMS

        static final java.lang.String WILDCARD_MAX_PHRASE_TERMS
        Property name indicating the maximum number of terms a wildcard in a phrase query will expand to.
        See Also:
        Constant Field Values

      • INDEX_MAX_LENGTH

        static final java.lang.String INDEX_MAX_LENGTH
        Property name indicating the maximum length for a string field.
        See Also:
        Constant Field Values

      • INDEX_RELEVANCY

        static final java.lang.String INDEX_RELEVANCY
        Property name indicating if relevancy boosting will be supported for queries on a field
        See Also:
        Constant Field Values

      • INDEX_OMIT_NORMS

        static final java.lang.String INDEX_OMIT_NORMS
        Property name indicating norms should be omitted
        See Also:
        Constant Field Values

      • INDEX_MAX_TOKENS

        static final java.lang.String INDEX_MAX_TOKENS
        Property name indicating maximum number of tokens to tokenize
        See Also:
        Constant Field Values

      • DECIMAL_PRECISION

        static final java.lang.String DECIMAL_PRECISION
        Property name indicating the maximum precision supported for decimal type.
        See Also:
        Constant Field Values

      • DECIMAL_SCALE

        static final java.lang.String DECIMAL_SCALE
        Property name indicating the scale for decimal type.
        See Also:
        Constant Field Values

      • DECIMAL_PRECISION_STEP

        static final java.lang.String DECIMAL_PRECISION_STEP
        Property name indicating precision step for optimized range searching.
        See Also:
        Constant Field Values

      • STOPWORDS_MODE

        static final java.lang.String STOPWORDS_MODE
        Property name indicating the stopword mode
        See Also:
        Constant Field Values

      • SYNONYMS_MODE

        static final java.lang.String SYNONYMS_MODE
        Property name indicating the synonyms mode
        See Also:
        Constant Field Values

      • ACRONYMS_MODE

        static final java.lang.String ACRONYMS_MODE
        Property name indicating the acronyms mode
        See Also:
        Constant Field Values

      • INDEX_PRECISION_STEP

        static final java.lang.String INDEX_PRECISION_STEP
        Property name specifying the precision step for indexing numeric values.
        See Also:
        Constant Field Values

      • DATE_RESOLUTION

        static final java.lang.String DATE_RESOLUTION
        Property name indicating the resolution for a SchemaField.Type.DATE field (seconds, milliseconds, minutes, hours, days) [default = seconds] *
        See Also:
        Constant Field Values

      • INDEX_TOKENIZER

        static final java.lang.String INDEX_TOKENIZER
        Property name indicating the tokenizer to use for this field for indexing.
        See Also:
        Constant Field Values

      • INDEX_TERM_VECTOR

        static final java.lang.String INDEX_TERM_VECTOR
        Property name indicating if term vectors should be enabled for a field
        See Also:
        Constant Field Values

      • INDEX_TERM_VECTOR_POSITIONS

        static final java.lang.String INDEX_TERM_VECTOR_POSITIONS
        Property name indicating if term vector positions should be enabled for a field
        See Also:
        Constant Field Values

      • INDEX_TERM_VECTOR_OFFSETS

        static final java.lang.String INDEX_TERM_VECTOR_OFFSETS
        Property name indicating if term vector offsets should be enabled for a field
        See Also:
        Constant Field Values

      • HIGHLIGHT_METHOD

        static final java.lang.String HIGHLIGHT_METHOD
        Method for performing highlighting.

        Available values are:

        • document - perform query time highlighting.
        • index - prepare field for highlighting at index time.
        See Also:
        Constant Field Values

      • HIGHLIGHT_ENABLED

        static final java.lang.String HIGHLIGHT_ENABLED
        Property name indicating if response field should be highlighted
        See Also:
        Constant Field Values

      • HIGHLIGHT_FRAGMENT

        static final java.lang.String HIGHLIGHT_FRAGMENT
        Property name indicating if highlighted field should be fragmented
        See Also:
        Constant Field Values

      • HIGHLIGHT_MERGE_FRAGMENTS

        static final java.lang.String HIGHLIGHT_MERGE_FRAGMENTS
        Property name indicating if fragments should be merged during highlighting
        See Also:
        Constant Field Values

      • HIGHLIGHT_FRAGMENT_SCOPE

        static final java.lang.String HIGHLIGHT_FRAGMENT_SCOPE
        Property name indicating the scope to use for fragmenting
        See Also:
        Constant Field Values

      • HIGHLIGHT_FRAGMENT_SIZE

        static final java.lang.String HIGHLIGHT_FRAGMENT_SIZE
        Property name indicating size of fragments generated
        See Also:
        Constant Field Values

      • HIGHLIGHT_NUM_FRAGMENTS

        static final java.lang.String HIGHLIGHT_NUM_FRAGMENTS
        Property name indicating max number of fragments to generate
        See Also:
        Constant Field Values

      • HIGHLIGHT_SEPARATOR

        static final java.lang.String HIGHLIGHT_SEPARATOR
        Property name indicating the separator to use between fragments.
        See Also:
        Constant Field Values

      • HIGHLIGHT_WHITELIST

        static final java.lang.String HIGHLIGHT_WHITELIST
        Property name indicating a comma separated list of fields used to extract query terms for highlighting.
        See Also:
        Constant Field Values

      • HIGHLIGHT_FALLBACK_FIELD

        static final java.lang.String HIGHLIGHT_FALLBACK_FIELD
        Property name indicating the fallback field to use for a teaser if fragments are enabled and no fragments are returned
        See Also:
        Constant Field Values

      • SCOPE_XML_ATTRIBUTES

        static final java.lang.String SCOPE_XML_ATTRIBUTES
        Property name indicating if xml attributes should be extracted for this field.
        See Also:
        Constant Field Values

      • STORE_HIDDEN

        static final java.lang.String STORE_HIDDEN
        Property name indicating if a stored field is hidden (won't be returned with * fields)
        See Also:
        Constant Field Values

      • STORE_MAX_CHARS

        static final java.lang.String STORE_MAX_CHARS
        Property name indicating the maximum number of characters to store for a field value.
        See Also:
        Constant Field Values

      • SPELLCHECK_FIELD

        static final java.lang.String SPELLCHECK_FIELD
        Property name name indicating spell checking should use the the corrections for the specified, instead of its own. Skips extraction of the field into the spell check dictionary unless explicitly specified.
        See Also:
        Constant Field Values

      • NATURAL_LANGUAGE

        static final java.lang.String NATURAL_LANGUAGE
        Property name indicating if a field should be considered for natural language processing.
        See Also:
        Constant Field Values

      • COLLATION_LANGUAGE

        static final java.lang.String COLLATION_LANGUAGE
        Language code for performing language specific sorting.
        See Also:
        Constant Field Values

      • COLLATION_COUNTRY

        static final java.lang.String COLLATION_COUNTRY
        Country code for performing language specific sorting.
        See Also:
        Constant Field Values

      • COLLATION_VARIANT

        static final java.lang.String COLLATION_VARIANT
        Locale variant code for performing language specific sorting.
        See Also:
        Constant Field Values

      • COLLATION_STRENGTH

        static final java.lang.String COLLATION_STRENGTH
        Collation strength for performing language specific sorting.
        See Also:
        Constant Field Values

      • COLLATION_DECOMPOSITION

        static final java.lang.String COLLATION_DECOMPOSITION
        Collation decomposition for performing language specific sorting.
        See Also:
        Constant Field Values

      • FACET_MAX_DISCRETE_BUCKETS

        static final java.lang.String FACET_MAX_DISCRETE_BUCKETS
        The maximum number of discrete buckets to suggest for numeric facets
        See Also:
        Constant Field Values