Package org.apache.solr.schema

Class BBoxField

java.lang.Object

org.apache.solr.schema.FieldProperties

org.apache.solr.schema.FieldType

org.apache.solr.schema.AbstractSpatialFieldType<BBoxStrategy>

org.apache.solr.schema.BBoxField

All Implemented Interfaces:

SchemaAware, SpatialQueryable

public class BBoxField
extends AbstractSpatialFieldType<BBoxStrategy>
implements SchemaAware

Nested Class Summary

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

FieldType.DefaultAnalyzer, FieldType.MultiValueSelector

Field Summary

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
BBoxField()

Method Summary

Modifier and Type	Method	Description
protected org.apache.lucene.search.DoubleValuesSource	getValueSourceFromSpatialArgs(QParser parser, SchemaField field, org.apache.lucene.spatial.query.SpatialArgs spatialArgs, String scoreParam, BBoxStrategy strategy)
void	inform(IndexSchema schema)	Informs the IndexSchema provided by the schema parameter of an event (e.g., a new FieldType was added, etc.
protected void	init(IndexSchema schema, Map<String,String> args)	subclasses should initialize themselves with the args provided and remove valid arguments.
protected BBoxStrategy	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, getSortField, getSpatialContext, getSpecializedExistenceQuery, getSpecializedRangeQuery, getSphereRadius, getStoredValue, getStrategy, getSupportedScoreModes, getUninversionType, getValueSource, isPolyField, newSpatialArgsParser, parseDistanceUnits, parseShape, parseSpatialArgs, shapeToString, write

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

checkSchemaField, checkSupportsDocValues, createField, getAnalyzerProperties, getClassArg, getDefaultMultiValueSelectorForSort, getDocValuesFormat, getExistenceQuery, getFieldTermQuery, getIndexAnalyzer, getNamedPropertyValues, getNonFieldPropertyArgs, getNumberType, getNumericSort, getPostingsFormat, getPrefixQuery, getQueryAnalyzer, 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, setArgs, 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

Constructor Detail

BBoxField

public BBoxField()

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<BBoxStrategy>

inform

public void inform(IndexSchema schema)

Description copied from interface: SchemaAware

Informs the IndexSchema provided by the schema parameter of an event (e.g., a new FieldType was added, etc.

Specified by:

inform in interface SchemaAware

Parameters:

schema - The IndexSchema instance that inform of the update to.

newSpatialStrategy

protected BBoxStrategy newSpatialStrategy(String fieldName)

Description copied from class: AbstractSpatialFieldType

Called from AbstractSpatialFieldType.getStrategy(String) upon first use by fieldName. }

Specified by:

newSpatialStrategy in class AbstractSpatialFieldType<BBoxStrategy>

getValueSourceFromSpatialArgs

protected org.apache.lucene.search.DoubleValuesSource getValueSourceFromSpatialArgs(QParser parser,
                                                                                    SchemaField field,
                                                                                    org.apache.lucene.spatial.query.SpatialArgs spatialArgs,
                                                                                    String scoreParam,
                                                                                    BBoxStrategy strategy)

Overrides:

getValueSourceFromSpatialArgs in class AbstractSpatialFieldType<BBoxStrategy>