org.apache.solr.schema

Class AbstractSubTypeFieldType

java.lang.Object

org.apache.solr.schema.FieldProperties

org.apache.solr.schema.FieldType

org.apache.solr.schema.AbstractSubTypeFieldType

All Implemented Interfaces:

SchemaAware

Direct Known Subclasses:

CoordinateFieldType, LatLonType

public abstract class AbstractSubTypeFieldType
extends FieldType
implements SchemaAware

An abstract base class for FieldTypes that delegate work to another FieldType. The sub type can be obtained by either specifying the subFieldType attribute or the subFieldSuffix. In the former case, a new dynamic field will be injected into the schema automatically with the name of FieldType.POLY_FIELD_SEPARATOR. In the latter case, it will use an existing dynamic field definition to get the type. See the example schema and the use of the PointType for more details.

Nested Class Summary

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

FieldType.DefaultAnalyzer

Field Summary

Fields

Modifier and Type	Field and Description
protected int	dynFieldProps
protected IndexSchema	schema
static java.lang.String	SUB_FIELD_SUFFIX
static java.lang.String	SUB_FIELD_TYPE
protected FieldType	subType
protected java.lang.String	suffix
protected java.lang.String[]	suffixes

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

analyzer, args, falseProperties, log, POLY_FIELD_SEPARATOR, properties, queryAnalyzer, trueProperties, typeName

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

BINARY, INDEXED, MULTIVALUED, OMIT_NORMS, OMIT_POSITIONS, OMIT_TF_POSITIONS, propertyMap, propertyNames, REQUIRED, SORT_MISSING_FIRST, SORT_MISSING_LAST, STORE_TERMOFFSETS, STORE_TERMPOSITIONS, STORE_TERMVECTORS, STORED, TOKENIZED

Constructor Summary

Constructors

Constructor and Description
AbstractSubTypeFieldType()

Method Summary

Modifier and Type	Method and Description
protected void	createSuffixCache(int size)
org.apache.lucene.search.Query	getFieldQuery(QParser parser, SchemaField field, java.lang.String externalVal) Throws UnsupportedOperationException()
FieldType	getSubType()
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, java.util.Map<java.lang.String,java.lang.String> args) subclasses should initialize themselves with the args provided and remove valid arguments.
(package private) static SchemaField	registerPolyFieldDynamicPrototype(IndexSchema schema, FieldType type) Helper method for creating a dynamic field SchemaField prototype.
protected SchemaField	subField(SchemaField base, int i)

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

createField, createField, createFields, getAnalyzer, getArg, getFieldIndex, getFieldStore, getFieldTermVec, getIndexOptions, getQueryAnalyzer, getRangeQuery, getSortField, getStringSort, getTypeName, getValueSource, getValueSource, hasProperty, indexedToReadable, isMultiValued, isPolyField, isTokenized, multiValuedFieldCache, readableToIndexed, restrictProps, setAnalyzer, setArgs, setQueryAnalyzer, setTypeName, storedToIndexed, storedToReadable, toExternal, toInternal, toObject, toString, write, write

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

getPropertyName, off, on, parseProperties, propertiesToString, propertyNameToInt

Methods inherited from class java.lang.Object

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

Field Detail

subType

protected FieldType subType

SUB_FIELD_SUFFIX

public static final java.lang.String SUB_FIELD_SUFFIX

See Also:

Constant Field Values

SUB_FIELD_TYPE

public static final java.lang.String SUB_FIELD_TYPE

See Also:

Constant Field Values

suffix

protected java.lang.String suffix

dynFieldProps

protected int dynFieldProps

suffixes

protected java.lang.String[] suffixes

schema

protected IndexSchema schema

Constructor Detail

AbstractSubTypeFieldType

public AbstractSubTypeFieldType()

Method Detail

getSubType

public FieldType getSubType()

init

protected void init(IndexSchema schema,
                    java.util.Map<java.lang.String,java.lang.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 FieldType

registerPolyFieldDynamicPrototype

static SchemaField registerPolyFieldDynamicPrototype(IndexSchema schema,
                                                     FieldType type)

Helper method for creating a dynamic field SchemaField prototype. Returns a SchemaField with the FieldType given and a name of "*" + FieldType.POLY_FIELD_SEPARATOR + FieldType.typeName and props of indexed=true, stored=false.

Parameters:

schema - the IndexSchema

type - The FieldType of the prototype.

Returns:

The SchemaField

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.

getFieldQuery

public org.apache.lucene.search.Query getFieldQuery(QParser parser,
                                                    SchemaField field,
                                                    java.lang.String externalVal)

Throws UnsupportedOperationException()

Overrides:

getFieldQuery in class FieldType

Parameters:

parser - The QParser calling the method

field - The SchemaField of the field to search

externalVal - The String representation of the value to search

Returns:

The Query instance. This implementation returns a TermQuery but overriding queries may not

createSuffixCache

protected void createSuffixCache(int size)

subField

protected SchemaField subField(SchemaField base,
                               int i)