Package org.apache.solr.schema

Class AbstractEnumField

java.lang.Object

org.apache.solr.schema.FieldProperties

org.apache.solr.schema.FieldType

org.apache.solr.schema.PrimitiveFieldType

org.apache.solr.schema.AbstractEnumField

Direct Known Subclasses:

EnumField, EnumFieldType

public abstract class AbstractEnumField
extends PrimitiveFieldType

Abstract Field type for support of string values with custom sort order.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AbstractEnumField.EnumMapping	Models all the info contained in an enums config XML file

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

FieldType.DefaultAnalyzer, FieldType.MultiValueSelector

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractEnumField.EnumMapping	enumMapping

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

Method Summary

Modifier and Type	Method	Description
AbstractEnumField.EnumMapping	getEnumMapping()
NumberType	getNumberType()	Return the numeric type of this field, or null if this field is not a numeric field.
org.apache.lucene.search.SortField	getSortField(SchemaField field, boolean top)	Returns the SortField instance that should be used to sort fields of this type.
org.apache.lucene.queries.function.ValueSource	getValueSource(SchemaField field, QParser qparser)	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	isTokenized()	Returns true if fields of this type should be tokenized
String	readableToIndexed(String val)	Given the readable value, return the term value that will match it.
String	toExternal(org.apache.lucene.index.IndexableField f)	Convert the stored-field format to an external (string, human readable) value
String	toInternal(String val)	Convert an external value (from XML update command or from query string) into the internal format for both storing and indexing (which can be modified by any analyzers).
Object	toNativeType(Object val)	Converts any Object to a java Object native to this field type
org.apache.solr.common.EnumFieldValue	toObject(org.apache.lucene.index.IndexableField f)	Convert the stored-field format to an external object.
void	write(TextResponseWriter writer, String name, org.apache.lucene.index.IndexableField f)	calls back to TextResponseWriter to write the field value

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

checkSupportsDocValues, enableDocValuesByDefault, getDefaultMultiValueSelectorForSort

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

checkSchemaField, createField, createField, createFields, createFieldsFromAllValues, getAnalyzerProperties, getClassArg, getDocValuesFormat, getExistenceQuery, getFieldQuery, getFieldTermQuery, getIndexAnalyzer, getNamedPropertyValues, getNonFieldPropertyArgs, getNumericSort, getPostingsFormat, getPrefixQuery, getQueryAnalyzer, getRangeQuery, getRewriteMethod, getSetQuery, getSimilarity, getSimilarityFactory, getSingleValueSource, getSortedNumericSortField, getSortedSetSortField, getSortField, getSpecializedExistenceQuery, getSpecializedRangeQuery, getStringSort, getTypeName, getUninversionType, hasProperty, indexedToReadable, indexedToReadable, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isPointField, isPolyField, isUtf8Field, marshalBase64SortValue, marshalSortValue, marshalStringSortValue, multiValuedFieldCache, readableToIndexed, restrictProps, setArgs, setIndexAnalyzer, setIsExplicitAnalyzer, setIsExplicitQueryAnalyzer, setQueryAnalyzer, setSimilarity, shouldCreateFieldsFromAllValues, storedToIndexed, storedToReadable, supportsAnalyzers, 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

enumMapping

protected AbstractEnumField.EnumMapping enumMapping

Constructor Details

AbstractEnumField

public AbstractEnumField()

Method Details

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 PrimitiveFieldType

getEnumMapping

public AbstractEnumField.EnumMapping getEnumMapping()

toObject

public org.apache.solr.common.EnumFieldValue toObject(org.apache.lucene.index.IndexableField f)

Description copied from class: FieldType

Convert the stored-field format to an external object.

Overrides:

toObject in class FieldType

See Also:

• FieldType.toInternal(java.lang.String)

getSortField

public org.apache.lucene.search.SortField getSortField(SchemaField field,
 boolean top)

Description copied from class: FieldType

Returns the SortField instance that should be used to sort fields of this type.

Specified by:

getSortField in class FieldType

See Also:

• SchemaField.checkSortability()
• FieldType.getStringSort(org.apache.solr.schema.SchemaField, boolean)
• FieldType.getNumericSort(org.apache.solr.schema.SchemaField, org.apache.solr.schema.NumberType, boolean)

getValueSource

public org.apache.lucene.queries.function.ValueSource getValueSource(SchemaField field,
 QParser qparser)

Description copied from class: FieldType

called to get the default value source (normally, from the Lucene FieldCache.)

Overrides:

getValueSource in class FieldType

write

public void write(TextResponseWriter writer,
 String name,
 org.apache.lucene.index.IndexableField f)
           throws IOException

Description copied from class: FieldType

calls back to TextResponseWriter to write the field value

Sub-classes should prefer using FieldType.toExternal(IndexableField) or FieldType.toObject(IndexableField) to get the writeable external value of f instead of directly using f.stringValue() or f.binaryValue()

Specified by:

write in class FieldType

Throws:

IOException

isTokenized

public boolean isTokenized()

Description copied from class: FieldType

Returns true if fields of this type should be tokenized

Overrides:

isTokenized in class FieldType

getNumberType

public NumberType getNumberType()

Description copied from class: FieldType

Return the numeric type of this field, or null if this field is not a numeric field.

Overrides:

getNumberType in class FieldType

readableToIndexed

public String readableToIndexed(String val)

Description copied from class: FieldType

Given the readable value, return the term value that will match it.

Overrides:

readableToIndexed in class FieldType

toInternal

public String toInternal(String val)

Description copied from class: FieldType

Convert an external value (from XML update command or from query string) into the internal format for both storing and indexing (which can be modified by any analyzers).

Overrides:

toInternal in class FieldType

See Also:

• FieldType.toExternal(org.apache.lucene.index.IndexableField)

toExternal

public String toExternal(org.apache.lucene.index.IndexableField f)

Description copied from class: FieldType

Convert the stored-field format to an external (string, human readable) value

Overrides:

toExternal in class FieldType

See Also:

• FieldType.toInternal(java.lang.String)

toNativeType

public Object toNativeType(Object val)

Description copied from class: FieldType

Converts any Object to a java Object native to this field type

Overrides:

toNativeType in class FieldType