|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.solr.schema.FieldProperties
org.apache.solr.schema.FieldType
org.apache.solr.schema.AbstractSpatialFieldType<T>
public abstract class AbstractSpatialFieldType<T extends SpatialStrategy>
Abstract base class for Solr FieldTypes based on a Lucene 4 SpatialStrategy.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.solr.schema.FieldType |
|---|
FieldType.DefaultAnalyzer |
| Field Summary | |
|---|---|
protected SpatialArgsParser |
argsParser
|
protected com.spatial4j.core.context.SpatialContext |
ctx
|
protected org.slf4j.Logger |
log
|
static String |
SCORE_PARAM
A local-param with one of "none" (default), "distance", or "recipDistance". |
| Fields inherited from class org.apache.solr.schema.FieldType |
|---|
analyzer, args, falseProperties, POLY_FIELD_SEPARATOR, postingsFormat, queryAnalyzer, similarity, trueProperties, typeName |
| Fields inherited from class org.apache.solr.schema.FieldProperties |
|---|
BINARY, INDEXED, MULTIVALUED, OMIT_NORMS, OMIT_POSITIONS, OMIT_TF_POSITIONS, REQUIRED, SORT_MISSING_FIRST, SORT_MISSING_LAST, STORE_TERMOFFSETS, STORE_TERMPOSITIONS, STORE_TERMVECTORS, STORED, TOKENIZED |
| Constructor Summary | |
|---|---|
AbstractSpatialFieldType()
|
|
| Method Summary | |
|---|---|
Field |
createField(SchemaField field,
Object val,
float boost)
Used for adding a document when a field needs to be created from a type and a string. |
Field[] |
createFields(SchemaField field,
Object val,
float boost)
Given a SchemaField, create one or more IndexableField instances |
Query |
getFieldQuery(QParser parser,
SchemaField field,
String externalVal)
Returns a Query instance for doing searches against a field. |
Query |
getRangeQuery(QParser parser,
SchemaField field,
String part1,
String part2,
boolean minInclusive,
boolean maxInclusive)
Returns a Query instance for doing range searches on this field type. |
SortField |
getSortField(SchemaField field,
boolean top)
Returns the SortField instance that should be used to sort fields of this type. |
T |
getStrategy(String fieldName)
Gets the cached strategy for this field, creating it if necessary via newSpatialStrategy(String). |
ValueSource |
getValueSource(SchemaField field,
QParser parser)
called to get the default value source (normally, from the Lucene FieldCache.) |
protected void |
init(IndexSchema schema,
Map<String,String> args)
subclasses should initialize themselves with the args provided and remove valid arguments. |
boolean |
isPolyField()
A "polyField" is a FieldType that can produce more than one IndexableField instance for a single value, via the FieldType.createFields(org.apache.solr.schema.SchemaField, Object, float) method. |
protected abstract T |
newSpatialStrategy(String fieldName)
Called from getStrategy(String) upon first use by fieldName. |
protected String |
shapeToString(com.spatial4j.core.shape.Shape shape)
|
void |
write(TextResponseWriter writer,
String name,
IndexableField f)
calls back to TextResponseWriter to write the field value |
| Methods inherited from class org.apache.solr.schema.FieldType |
|---|
checkSchemaField, createField, getAnalyzer, getArg, getIndexOptions, getPostingsFormat, getQueryAnalyzer, getSimilarity, getStringSort, getTypeName, hasProperty, indexedToReadable, indexedToReadable, isMultiValued, isTokenized, multiValuedFieldCache, readableToIndexed, readableToIndexed, restrictProps, setAnalyzer, setQueryAnalyzer, setSimilarity, storedToIndexed, storedToReadable, toExternal, toInternal, toObject, toObject, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final String SCORE_PARAM
protected final org.slf4j.Logger log
protected com.spatial4j.core.context.SpatialContext ctx
protected SpatialArgsParser argsParser
| Constructor Detail |
|---|
public AbstractSpatialFieldType()
| Method Detail |
|---|
protected void init(IndexSchema schema,
Map<String,String> args)
FieldType
init in class FieldType
public final Field createField(SchemaField field,
Object val,
float boost)
FieldTypeBy default, the indexed value is the same as the stored value (taken from toInternal()). Having a different representation for external, internal, and indexed would present quite a few problems given the current Lucene architecture. An analyzer for adding docs would need to translate internal->indexed while an analyzer for querying would need to translate external->indexed.
The only other alternative to having internal==indexed would be to have internal==external. In this case, toInternal should convert to the indexed representation, toExternal() should do nothing, and createField() should *not* call toInternal, but use the external value and set tokenized=true to get Lucene to convert to the internal(indexed) form.
:TODO: clean up and clarify this explanation.
createField in class FieldTypeFieldType.toInternal(java.lang.String)
public final Field[] createFields(SchemaField field,
Object val,
float boost)
FieldTypeSchemaField, create one or more IndexableField instances
createFields in class FieldTypefield - the SchemaFieldval - The value to add to the fieldboost - The boost to apply
IndexableFieldFieldType.createField(SchemaField, Object, float),
FieldType.isPolyField()protected String shapeToString(com.spatial4j.core.shape.Shape shape)
protected abstract T newSpatialStrategy(String fieldName)
getStrategy(String) upon first use by fieldName. }
public final boolean isPolyField()
FieldTypeFieldType.createFields(org.apache.solr.schema.SchemaField, Object, float) method. This is useful
when hiding the implementation details of a field from the Solr end user. For instance, a spatial point may be represented by multiple different fields.
isPolyField in class FieldTypeFieldType.createFields(org.apache.solr.schema.SchemaField, Object, float) method may return more than one field
public Query getRangeQuery(QParser parser,
SchemaField field,
String part1,
String part2,
boolean minInclusive,
boolean maxInclusive)
FieldTypeSolrQueryParser
currently passes part1 and part2 as null if they are '*' respectively. minInclusive and maxInclusive are both true
currently by SolrQueryParser but that may change in the future. Also, other QueryParser implementations may have
different semantics.
Sub-classes should override this method to provide their own range query implementation. They should strive to
handle nulls in part1 and/or part2 as well as unequal minInclusive and maxInclusive parameters gracefully.
getRangeQuery in class FieldTypefield - the schema fieldpart1 - the lower boundary of the range, nulls are allowed.part2 - the upper boundary of the range, nulls are allowedminInclusive - whether the minimum of the range is inclusive or notmaxInclusive - whether the maximum of the range is inclusive or not
public ValueSource getValueSource(SchemaField field,
QParser parser)
FieldType
getValueSource in class FieldType
public Query getFieldQuery(QParser parser,
SchemaField field,
String externalVal)
FieldType
getFieldQuery in class FieldTypeparser - The QParser calling the methodfield - The SchemaField of the field to searchexternalVal - The String representation of the value to search
Query instance. This implementation returns a TermQuery but overriding queries may notpublic T getStrategy(String fieldName)
newSpatialStrategy(String).
fieldName - Mandatory reference to the field name
public void write(TextResponseWriter writer,
String name,
IndexableField f)
throws IOException
FieldType
write in class FieldTypeIOException
public SortField getSortField(SchemaField field,
boolean top)
FieldType
getSortField in class FieldTypeSchemaField.checkSortability()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||