org.apache.solr.schema

## Class AbstractSpatialPrefixTreeFieldType<T extends PrefixTreeStrategy>

- java.lang.Object
- - org.apache.solr.schema.FieldProperties
  - - org.apache.solr.schema.FieldType
    - - org.apache.solr.schema.AbstractSpatialFieldType<T>
      - - org.apache.solr.schema.AbstractSpatialPrefixTreeFieldType<T>

- All Implemented Interfaces:
    SpatialQueryable
  Direct Known Subclasses:
    DateRangeField, SpatialRecursivePrefixTreeFieldType, SpatialTermQueryPrefixTreeFieldType

      public abstract class AbstractSpatialPrefixTreeFieldType<T extends PrefixTreeStrategy>
      extends AbstractSpatialFieldType<T>

  See Also:
    `PrefixTreeStrategy`
  WARNING: This API is experimental and might change in incompatible ways in the next release.

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class org.apache.solr.schema.FieldType

      `FieldType.DefaultAnalyzer, FieldType.MultiValueSelector`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `DEFAULT_FIELD_VALUES_ARRAY_LEN`
    `protected SpatialPrefixTree` | `grid`

    - ### Fields inherited from class org.apache.solr.schema.AbstractSpatialFieldType

      `argsParser, ctx, DISTANCE, distanceUnits, FILTER_PARAM, FORMAT, NONE, RECIP_DISTANCE, SCORE_PARAM, shapeReader, shapeWriter, supportedScoreModes`

    - ### Fields inherited from class org.apache.solr.schema.FieldType

      `ANALYZER, args, CHAR_FILTER, CHAR_FILTERS, CLASS_NAME, docValuesFormat, falseProperties, FILTER, FILTERS, INDEX, INDEX_ANALYZER, MULTI_TERM, MULTI_TERM_ANALYZER, POLY_FIELD_SEPARATOR, postingsFormat, properties, QUERY, QUERY_ANALYZER, similarity, SIMILARITY, similarityFactory, TOKENIZER, trueProperties, TYPE, TYPE_NAME, typeName`

    - ### Fields inherited from class org.apache.solr.schema.FieldProperties

      `BINARY, DOC_VALUES, INDEXED, MULTIVALUED, OMIT_NORMS, OMIT_POSITIONS, OMIT_TF_POSITIONS, REQUIRED, SORT_MISSING_FIRST, SORT_MISSING_LAST, STORE_OFFSETS, STORE_TERMOFFSETS, STORE_TERMPAYLOADS, STORE_TERMPOSITIONS, STORE_TERMVECTORS, STORED, TOKENIZED, USE_DOCVALUES_AS_STORED`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `AbstractSpatialPrefixTreeFieldType()`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `Analyzer` | `getIndexAnalyzer()` This analyzer is not actually used for indexing.
    `Analyzer` | `getQueryAnalyzer()` Returns the Analyzer to be used when searching fields of this type.
    `protected void` | `init(IndexSchema schema, Map<String,String> args)` subclasses should initialize themselves with the args provided and remove valid arguments.
    `protected abstract T` | `newPrefixTreeStrategy(String fieldName)`
    `protected T` | `newSpatialStrategy(String fieldName)` Called from `AbstractSpatialFieldType.getStrategy(String)` upon first use by fieldName.

    - ### Methods inherited from class org.apache.solr.schema.AbstractSpatialFieldType

      `createField, createFields, createSpatialQuery, getDistanceUnits, getFieldQuery, getQueryFromSpatialArgs, getRangeQuery, getSortField, getSpatialContext, getSphereRadius, getStoredValue, getStrategy, getSupportedScoreModes, getUninversionType, getValueSource, getValueSourceFromSpatialArgs, isPolyField, newSpatialArgsParser, parseDistanceUnits, parseShape, parseSpatialArgs, shapeToString, write`

    - ### Methods inherited from class org.apache.solr.schema.FieldType

      `checkSchemaField, createField, getAnalyzerProperties, getClassArg, getDocValuesFormat, getIndexOptions, getNamedPropertyValues, getNonFieldPropertyArgs, getNumericType, getPostingsFormat, getPrefixQuery, getRewriteMethod, getSimilarity, getSimilarityFactory, getSingleValueSource, getStringSort, getTypeName, hasProperty, indexedToReadable, indexedToReadable, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isTokenized, marshalBase64SortValue, marshalSortValue, marshalStringSortValue, multiValuedFieldCache, readableToIndexed, readableToIndexed, restrictProps, setArgs, setIndexAnalyzer, setIsExplicitAnalyzer, setIsExplicitQueryAnalyzer, setQueryAnalyzer, setSimilarity, storedToIndexed, storedToReadable, supportsAnalyzers, toExternal, toInternal, toNativeType, toObject, toObject, toString, unmarshalBase64SortValue, unmarshalSortValue, unmarshalStringSortValue, useDocValuesAsStored`

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### DEFAULT_FIELD_VALUES_ARRAY_LEN

          public static final String DEFAULT_FIELD_VALUES_ARRAY_LEN

      See Also:
        `PrefixTreeStrategy.setDefaultFieldValuesArrayLen(int)`, Constant Field Values

    - #### grid

          protected SpatialPrefixTree grid

  - ### Constructor Detail

    - #### AbstractSpatialPrefixTreeFieldType

          public AbstractSpatialPrefixTreeFieldType()

  - ### Method Detail

    - #### init

          protected void init(IndexSchema schema,
                              Map<String,String> args)

      Description copied from class: `FieldType`
      subclasses should initialize themselves with the args provided and remove valid arguments. leftover arguments will cause an exception. Common boolean properties have already been handled.
      Overrides:
        `init` in class `AbstractSpatialFieldType<T extends PrefixTreeStrategy>`

    - #### getIndexAnalyzer

          public Analyzer getIndexAnalyzer()

      This analyzer is not actually used for indexing. It is implemented here so that the analysis UI will show reasonable tokens.
      Overrides:
        `getIndexAnalyzer` in class `FieldType`
      See Also:
        `FieldType.getQueryAnalyzer()`

    - #### getQueryAnalyzer

          public Analyzer getQueryAnalyzer()

      Description copied from class: `FieldType`
      Returns the Analyzer to be used when searching fields of this type.

      This method may be called many times, at any time.

      Overrides:
        `getQueryAnalyzer` in class `FieldType`
      See Also:
        `FieldType.getIndexAnalyzer()`

    - #### newSpatialStrategy

          protected T newSpatialStrategy(String fieldName)

      Description copied from class: `AbstractSpatialFieldType`
      Called from `AbstractSpatialFieldType.getStrategy(String)` upon first use by fieldName. }
      Specified by:
        `newSpatialStrategy` in class `AbstractSpatialFieldType<T extends PrefixTreeStrategy>`

    - #### newPrefixTreeStrategy

          protected abstract T newPrefixTreeStrategy(String fieldName)

Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.