Package 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

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, FieldType.MultiValueSelector

Field Summary

Fields

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

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

Method Summary

Modifier and Type	Method	Description
protected void	createSuffixCache(int size)
org.apache.lucene.search.Query	getFieldQuery(QParser parser, SchemaField field, String externalVal)	Throws UnsupportedOperationException()
FieldType	getSubType()
void	inform(IndexSchema schema)	Registers the polyfield dynamic prototype for this field type: : "*___(field type name)"
protected void	init(IndexSchema schema, Map<String,String> args)	subclasses should initialize themselves with the args provided and remove valid arguments.
protected SchemaField	subField(SchemaField base, int i, IndexSchema schema)

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

checkSchemaField, checkSupportsDocValues, createField, createField, createFields, getAnalyzerProperties, getClassArg, getDefaultMultiValueSelectorForSort, getDocValuesFormat, getExistenceQuery, getFieldTermQuery, getIndexAnalyzer, getNamedPropertyValues, getNonFieldPropertyArgs, getNumberType, getNumericSort, getPostingsFormat, getPrefixQuery, getQueryAnalyzer, getRangeQuery, getRewriteMethod, getSetQuery, getSimilarity, getSimilarityFactory, getSingleValueSource, getSortedNumericSortField, getSortedSetSortField, getSortField, getSortField, getSpecializedExistenceQuery, getSpecializedRangeQuery, getStringSort, getTypeName, getUninversionType, getValueSource, hasProperty, indexedToReadable, indexedToReadable, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isPointField, isPolyField, 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, write

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 String SUB_FIELD_SUFFIX

See Also:

Constant Field Values

SUB_FIELD_TYPE

public static final String SUB_FIELD_TYPE

See Also:

Constant Field Values

suffix

protected String suffix

dynFieldProps

protected int dynFieldProps

suffixes

protected String[] suffixes

subFieldType

protected String subFieldType

subSuffix

protected String subSuffix

schema

protected IndexSchema schema

Constructor Detail

AbstractSubTypeFieldType

public AbstractSubTypeFieldType()

Method Detail

getSubType

public FieldType getSubType()

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 FieldType

inform

public void inform(IndexSchema schema)

Registers the polyfield dynamic prototype for this field type: : "*___(field type name)"

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,
                                                    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,
                               IndexSchema schema)