Package org.apache.solr.schema

Class AbstractSpatialPrefixTreeFieldType<T extends org.apache.lucene.spatial.prefix.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

public abstract class AbstractSpatialPrefixTreeFieldType<T extends org.apache.lucene.spatial.prefix.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	Description
static final String	DEFAULT_FIELD_VALUES_ARRAY_LEN
static final Map<String,String>	FIELD_TYPE_INVARIANTS
protected org.apache.lucene.spatial.prefix.tree.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, AUTO_GENERATE_PHRASE_QUERIES, CHAR_FILTER, CHAR_FILTERS, CLASS_NAME, docValuesFormat, ENABLE_GRAPH_QUERIES, falseProperties, FILTER, FILTERS, INDEX, INDEX_ANALYZER, MULTI_TERM, MULTI_TERM_ANALYZER, POLY_FIELD_SEPARATOR, postingsFormat, properties, QUERY, QUERY_ANALYZER, similarity, SIMILARITY, similarityFactory, SYNONYM_QUERY_STYLE, TOKENIZER, trueProperties, TYPE, TYPE_NAME, typeName

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

BINARY, DOC_VALUES, INDEXED, LARGE_FIELD, 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, UNINVERTIBLE, USE_DOCVALUES_AS_STORED

Constructor Summary

Constructors

Constructor	Description
AbstractSpatialPrefixTreeFieldType()

Method Summary

Modifier and Type	Method	Description
void	checkSchemaField(SchemaField field)	Check's SchemaField instances constructed using this field type to ensure that they are valid.
org.apache.lucene.analysis.Analyzer	getIndexAnalyzer()	This analyzer is not actually used for indexing.
org.apache.lucene.analysis.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.
void	setArgs(IndexSchema schema, Map<String,String> args)	Initializes the field type.

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

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

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

checkSupportsDocValues, createField, enableDocValuesByDefault, getAnalyzerProperties, getClassArg, getDefaultMultiValueSelectorForSort, getDocValuesFormat, getExistenceQuery, getFieldTermQuery, getNamedPropertyValues, getNonFieldPropertyArgs, getNumberType, getNumericSort, getPostingsFormat, getPrefixQuery, getRangeQuery, getRewriteMethod, getSetQuery, getSimilarity, getSimilarityFactory, getSingleValueSource, getSortedNumericSortField, getSortedSetSortField, getSortField, getStringSort, getTypeName, hasProperty, indexedToReadable, indexedToReadable, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isPointField, isTokenized, isUtf8Field, marshalBase64SortValue, marshalSortValue, marshalStringSortValue, multiValuedFieldCache, readableToIndexed, readableToIndexed, restrictProps, setIndexAnalyzer, setIsExplicitAnalyzer, setIsExplicitQueryAnalyzer, setQueryAnalyzer, setSimilarity, storedToIndexed, storedToReadable, supportsAnalyzers, toExternal, toInternal, toNativeType, toObject, toObject, toString, treatUnboundedRangeAsExistence, unmarshalBase64SortValue, unmarshalSortValue, unmarshalStringSortValue, useDocValuesAsStored, write

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_FIELD_VALUES_ARRAY_LEN

public static final String DEFAULT_FIELD_VALUES_ARRAY_LEN

See Also:

• PrefixTreeStrategy.setDefaultFieldValuesArrayLen(int)
• Constant Field Values

FIELD_TYPE_INVARIANTS

public static final Map<String,String> FIELD_TYPE_INVARIANTS

grid

protected org.apache.lucene.spatial.prefix.tree.SpatialPrefixTree grid

Constructor Details

AbstractSpatialPrefixTreeFieldType

public AbstractSpatialPrefixTreeFieldType()

Method Details

setArgs

public void setArgs(IndexSchema schema,
 Map<String,String> args)

Description copied from class: FieldType

Initializes the field type. Subclasses should usually override FieldType.init(IndexSchema, Map) which is called by this method.

Overrides:

setArgs in class FieldType

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 org.apache.lucene.spatial.prefix.PrefixTreeStrategy>

checkSchemaField

public void checkSchemaField(SchemaField field)

Description copied from class: FieldType

Check's SchemaField instances constructed using this field type to ensure that they are valid.

This method is called by the SchemaField constructor to check that its initialization does not violate any fundamental requirements of the FieldType. Subclasses may choose to throw a SolrException if invariants are violated by the SchemaField.

Overrides:

checkSchemaField in class FieldType

See Also:

• FIELD_TYPE_INVARIANTS

getIndexAnalyzer

public org.apache.lucene.analysis.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 org.apache.lucene.analysis.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 org.apache.lucene.spatial.prefix.PrefixTreeStrategy>

newPrefixTreeStrategy

protected abstract T newPrefixTreeStrategy(String fieldName)