Package org.apache.solr.schema
Class BoolField
- java.lang.Object
-
- org.apache.solr.schema.FieldProperties
-
- org.apache.solr.schema.FieldType
-
- org.apache.solr.schema.PrimitiveFieldType
-
- org.apache.solr.schema.BoolField
-
public class BoolField extends PrimitiveFieldType
-
-
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 static org.apache.lucene.analysis.Analyzer
boolAnalyzer
static char[]
FALSE_TOKEN
static char[]
TRUE_TOKEN
-
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 BoolField()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<org.apache.lucene.index.IndexableField>
createFields(SchemaField field, Object value)
Given aSchemaField
, create one or moreIndexableField
instancesorg.apache.lucene.analysis.Analyzer
getIndexAnalyzer()
Returns the Analyzer to be used when indexing fields of this type.org.apache.lucene.analysis.Analyzer
getQueryAnalyzer()
Returns the Analyzer to be used when searching fields of this type.org.apache.lucene.search.SortField
getSortField(SchemaField field, boolean reverse)
Returns the SortField instance that should be used to sort fields of this type.UninvertingReader.Type
getUninversionType(SchemaField sf)
If DocValues is not enabled for a field, but it's indexed, docvalues can be constructed on the fly (uninverted, aka fieldcache) on the first request to sort, facet, etc.org.apache.lucene.queries.function.ValueSource
getValueSource(SchemaField field, QParser qparser)
called to get the default value source (normally, from the Lucene FieldCache.)String
indexedToReadable(String indexedForm)
Given an indexed term, return the human readable representationorg.apache.lucene.util.CharsRef
indexedToReadable(org.apache.lucene.util.BytesRef input, org.apache.lucene.util.CharsRefBuilder charsRef)
Given an indexed term, append the human readable representationObject
marshalSortValue(Object value)
Convert a value used by the FieldComparator for this FieldType's SortField into a marshalable value for distributed sorting.String
toExternal(org.apache.lucene.index.IndexableField f)
Convert the stored-field format to an external (string, human readable) valueString
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 typeBoolean
toObject(org.apache.lucene.index.IndexableField f)
Convert the stored-field format to an external object.Object
toObject(SchemaField sf, org.apache.lucene.util.BytesRef term)
Object
unmarshalSortValue(Object value)
Convert a value marshaled viaFieldType.marshalSortValue(java.lang.Object)
back into a value usable by the FieldComparator for this FieldType's SortFieldvoid
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, init
-
Methods inherited from class org.apache.solr.schema.FieldType
checkSchemaField, createField, createField, getAnalyzerProperties, getClassArg, getDocValuesFormat, getExistenceQuery, getFieldQuery, getFieldTermQuery, getNamedPropertyValues, getNonFieldPropertyArgs, getNumberType, getNumericSort, getPostingsFormat, getPrefixQuery, getRangeQuery, getRewriteMethod, getSetQuery, getSimilarity, getSimilarityFactory, getSingleValueSource, getSortedNumericSortField, getSortedSetSortField, getSortField, getSpecializedExistenceQuery, getSpecializedRangeQuery, getStringSort, getTypeName, hasProperty, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isPointField, isPolyField, isTokenized, isUtf8Field, marshalBase64SortValue, marshalStringSortValue, multiValuedFieldCache, readableToIndexed, readableToIndexed, restrictProps, setArgs, setIndexAnalyzer, setIsExplicitAnalyzer, setIsExplicitQueryAnalyzer, setQueryAnalyzer, setSimilarity, storedToIndexed, storedToReadable, supportsAnalyzers, toString, treatUnboundedRangeAsExistence, unmarshalBase64SortValue, unmarshalStringSortValue, useDocValuesAsStored, write
-
-
-
-
Method Detail
-
getSortField
public org.apache.lucene.search.SortField getSortField(SchemaField field, boolean reverse)
Description copied from class:FieldType
Returns the SortField instance that should be used to sort fields of this type.
-
getUninversionType
public UninvertingReader.Type getUninversionType(SchemaField sf)
Description copied from class:FieldType
If DocValues is not enabled for a field, but it's indexed, docvalues can be constructed on the fly (uninverted, aka fieldcache) on the first request to sort, facet, etc. This specifies the structure to use.This method will not be used if the field is (effectively)
uninvertible="false"
- Specified by:
getUninversionType
in classFieldType
- Parameters:
sf
- field instance- Returns:
- type to uninvert, or
null
(to disallow uninversion for the field) - See Also:
SchemaField.isUninvertible()
-
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 classFieldType
-
getIndexAnalyzer
public org.apache.lucene.analysis.Analyzer getIndexAnalyzer()
Description copied from class:FieldType
Returns the Analyzer to be used when indexing fields of this type.This method may be called many times, at any time.
- Overrides:
getIndexAnalyzer
in classFieldType
- See Also:
FieldType.getQueryAnalyzer()
-
getQueryAnalyzer
public org.apache.lucene.analysis.Analyzer getQueryAnalyzer()
Description copied from class:FieldType
Returns the Analyzer to be used when searching fields of this type.This method may be called many times, at any time.
- Overrides:
getQueryAnalyzer
in classFieldType
- See Also:
FieldType.getIndexAnalyzer()
-
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 classFieldType
- 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 classFieldType
- See Also:
FieldType.toInternal(java.lang.String)
-
toObject
public Boolean toObject(org.apache.lucene.index.IndexableField f)
Description copied from class:FieldType
Convert the stored-field format to an external object.- Overrides:
toObject
in classFieldType
- See Also:
FieldType.toInternal(java.lang.String)
-
toObject
public Object toObject(SchemaField sf, org.apache.lucene.util.BytesRef term)
-
indexedToReadable
public String indexedToReadable(String indexedForm)
Description copied from class:FieldType
Given an indexed term, return the human readable representation- Overrides:
indexedToReadable
in classFieldType
-
indexedToReadable
public org.apache.lucene.util.CharsRef indexedToReadable(org.apache.lucene.util.BytesRef input, org.apache.lucene.util.CharsRefBuilder charsRef)
Description copied from class:FieldType
Given an indexed term, append the human readable representation- Overrides:
indexedToReadable
in classFieldType
-
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 valueSub-classes should prefer using
FieldType.toExternal(IndexableField)
orFieldType.toObject(IndexableField)
to get the writeable external value off
instead of directly usingf.stringValue()
orf.binaryValue()
- Specified by:
write
in classFieldType
- Throws:
IOException
-
marshalSortValue
public Object marshalSortValue(Object value)
Description copied from class:FieldType
Convert a value used by the FieldComparator for this FieldType's SortField into a marshalable value for distributed sorting.- Overrides:
marshalSortValue
in classFieldType
-
unmarshalSortValue
public Object unmarshalSortValue(Object value)
Description copied from class:FieldType
Convert a value marshaled viaFieldType.marshalSortValue(java.lang.Object)
back into a value usable by the FieldComparator for this FieldType's SortField- Overrides:
unmarshalSortValue
in classFieldType
-
createFields
public List<org.apache.lucene.index.IndexableField> createFields(SchemaField field, Object value)
Description copied from class:FieldType
Given aSchemaField
, create one or moreIndexableField
instances- Overrides:
createFields
in classFieldType
- Parameters:
field
- theSchemaField
value
- The value to add to the field- Returns:
- An array of
IndexableField
- See Also:
FieldType.createField(SchemaField, Object)
,FieldType.isPolyField()
-
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 classFieldType
-
-