SchemaField (Solr 8.8.0 API)

java.lang.Object
- org.apache.solr.schema.FieldProperties
- - org.apache.solr.schema.SchemaField

All Implemented Interfaces:

IndexableFieldType
```
public final class SchemaField
extends FieldProperties
implements IndexableFieldType
```
Encapsulates all information about a Field in a Solr Schema

Field Summary
- 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 and Description
`SchemaField(SchemaField prototype, String name)` Create a new SchemaField from an existing one by using all of the properties of the prototype except the field name.
`SchemaField(String name, FieldType type)` Create a new SchemaField with the given name and type, using all the default properties from the type.
`SchemaField(String name, FieldType type, int properties, String defaultValue)` Create a new SchemaField with the given name and type, and with the specified properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkFieldCacheSource()` Sanity checks that the properties of this field type are plausible for a field that may be used to get a `FieldCacheSource`, throwing an appropriate exception (including the field name) if it is not.
`void`	`checkSortability()` Sanity checks that the properties of this field type are plausible for a field that may be used in sorting, throwing an appropriate exception (including the field name) if it is not.
`IndexableField`	`createField(Object val)`
`List<IndexableField>`	`createFields(Object val)`
`DocValuesType`	`docValuesType()`
`boolean`	`equals(Object obj)`
`Map<String,?>`	`getArgs()`
`Map<String,String>`	`getAttributes()`
`String`	`getDefaultValue()`
`String`	`getDocValuesFormat()` Expert/advanced method to get the field `DocValuesFormat`.
`String`	`getName()`
`SimpleOrderedMap<Object>`	`getNamedPropertyValues(boolean showDefaults)` Get a map of property name -> value for this field.
`String`	`getPostingsFormat()` Expert/advanced method to get the field `PostingsFormat`.
`int`	`getProperties()`
`SortField`	`getSortField(boolean top)` Delegates to the FieldType for this field
`FieldType`	`getType()`
`boolean`	`hasDocValues()`
`int`	`hashCode()`
`boolean`	`indexed()`
`IndexOptions`	`indexOptions()`
`boolean`	`isLarge()`
`boolean`	`isPolyField()` If true, then use `createFields(Object)`, else use `createField(java.lang.Object)` to save an extra allocation
`boolean`	`isRequired()`
`boolean`	`isUninvertible()`
`boolean`	`multiValued()`
`boolean`	`omitNorms()`
`boolean`	`omitPositions()`
`boolean`	`omitTermFreqAndPositions()`
`int`	`pointDimensionCount()`
`int`	`pointIndexDimensionCount()`
`int`	`pointNumBytes()`
`boolean`	`sortMissingFirst()`
`boolean`	`sortMissingLast()`
`boolean`	`stored()`
`boolean`	`storeOffsetsWithPositions()`
`boolean`	`storeTermOffsets()`
`boolean`	`storeTermPayloads()`
`boolean`	`storeTermPositions()`
`boolean`	`storeTermVector()`
`boolean`	`storeTermVectorOffsets()`
`boolean`	`storeTermVectorPayloads()`
`boolean`	`storeTermVectorPositions()`
`boolean`	`storeTermVectors()`
`boolean`	`tokenized()`
`String`	`toString()`
`boolean`	`useDocValuesAsStored()`
`void`	`write(TextResponseWriter writer, String name, IndexableField val)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SchemaField
```
public SchemaField(String name,
                   FieldType type)
```
    Create a new SchemaField with the given name and type, using all the default properties from the type.
  - SchemaField
```
public SchemaField(SchemaField prototype,
                   String name)
```
    Create a new SchemaField from an existing one by using all of the properties of the prototype except the field name.
  - SchemaField
```
public SchemaField(String name,
                   FieldType type,
                   int properties,
                   String defaultValue)
```
    Create a new SchemaField with the given name and type, and with the specified properties. Properties are *not* inherited from the type in this case, so users of this constructor should derive the properties from type.getSolrProperties() using all the default properties from the type.
- Method Detail
  - getName
```
public String getName()
```
  - getType
```
public FieldType getType()
```
  - getProperties
```
public int getProperties()
```
  - isUninvertible
```
public boolean isUninvertible()
```
  - indexed
```
public boolean indexed()
```
  - stored
```
public boolean stored()
```
    Specified by:
    
    stored in interface IndexableFieldType
  - hasDocValues
```
public boolean hasDocValues()
```
  - storeTermVector
```
public boolean storeTermVector()
```
  - storeTermPositions
```
public boolean storeTermPositions()
```
  - storeTermOffsets
```
public boolean storeTermOffsets()
```
  - storeTermPayloads
```
public boolean storeTermPayloads()
```
  - omitNorms
```
public boolean omitNorms()
```
    Specified by:
    
    omitNorms in interface IndexableFieldType
  - omitTermFreqAndPositions
```
public boolean omitTermFreqAndPositions()
```
  - omitPositions
```
public boolean omitPositions()
```
  - storeOffsetsWithPositions
```
public boolean storeOffsetsWithPositions()
```
  - useDocValuesAsStored
```
public boolean useDocValuesAsStored()
```
  - multiValued
```
public boolean multiValued()
```
  - sortMissingFirst
```
public boolean sortMissingFirst()
```
  - sortMissingLast
```
public boolean sortMissingLast()
```
  - isRequired
```
public boolean isRequired()
```
  - isLarge
```
public boolean isLarge()
```
  - getArgs
```
public Map<String,?> getArgs()
```
  - createField
```
public IndexableField createField(Object val)
```
  - createFields
```
public List<IndexableField> createFields(Object val)
```
  - isPolyField
```
public boolean isPolyField()
```
    If true, then use createFields(Object), else use createField(java.lang.Object) to save an extra allocation
    
    Returns:
    
    true if this field is a poly field
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - write
```
public void write(TextResponseWriter writer,
                  String name,
                  IndexableField val)
           throws IOException
```
    Throws:
    
    IOException
  - getSortField
```
public SortField getSortField(boolean top)
```
    Delegates to the FieldType for this field
    
    See Also:
    
    FieldType.getSortField(org.apache.solr.schema.SchemaField, boolean)
  - getPostingsFormat
```
public String getPostingsFormat()
```
    Expert/advanced method to get the field PostingsFormat.
    
    Returns:
    
    The postingsFormat declared; or null if unspecified.
  - getDocValuesFormat
```
public String getDocValuesFormat()
```
    Expert/advanced method to get the field DocValuesFormat.
    
    Returns:
    
    The docValuesFormat declared; or null if unspecified.
  - checkSortability
```
public void checkSortability()
                      throws SolrException
```
    Sanity checks that the properties of this field type are plausible for a field that may be used in sorting, throwing an appropriate exception (including the field name) if it is not. FieldType subclasses can choose to call this method in their getSortField implementation
    
    Throws:
    
    SolrException
    
    See Also:
    
    FieldType.getSortField(org.apache.solr.schema.SchemaField, boolean)
  - checkFieldCacheSource
```
public void checkFieldCacheSource()
                           throws SolrException
```
    Sanity checks that the properties of this field type are plausible for a field that may be used to get a FieldCacheSource, throwing an appropriate exception (including the field name) if it is not. FieldType subclasses can choose to call this method in their getValueSource implementation
    
    Throws:
    
    SolrException
    
    See Also:
    
    FieldType.getValueSource(org.apache.solr.schema.SchemaField, org.apache.solr.search.QParser)
  - getDefaultValue
```
public String getDefaultValue()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getNamedPropertyValues
```
public SimpleOrderedMap<Object> getNamedPropertyValues(boolean showDefaults)
```
    Get a map of property name -> value for this field. If showDefaults is true, include default properties (those inherited from the declared property type and not overridden in the field declaration).
  - tokenized
```
public boolean tokenized()
```
    Specified by:
    
    tokenized in interface IndexableFieldType
  - storeTermVectors
```
public boolean storeTermVectors()
```
    Specified by:
    
    storeTermVectors in interface IndexableFieldType
  - storeTermVectorOffsets
```
public boolean storeTermVectorOffsets()
```
    Specified by:
    
    storeTermVectorOffsets in interface IndexableFieldType
  - storeTermVectorPositions
```
public boolean storeTermVectorPositions()
```
    Specified by:
    
    storeTermVectorPositions in interface IndexableFieldType
  - storeTermVectorPayloads
```
public boolean storeTermVectorPayloads()
```
    Specified by:
    
    storeTermVectorPayloads in interface IndexableFieldType
  - indexOptions
```
public IndexOptions indexOptions()
```
    Specified by:
    
    indexOptions in interface IndexableFieldType
  - docValuesType
```
public DocValuesType docValuesType()
```
    Specified by:
    
    docValuesType in interface IndexableFieldType
  - pointDimensionCount
```
public int pointDimensionCount()
```
    Specified by:
    
    pointDimensionCount in interface IndexableFieldType
  - pointIndexDimensionCount
```
public int pointIndexDimensionCount()
```
    Specified by:
    
    pointIndexDimensionCount in interface IndexableFieldType
  - pointNumBytes
```
public int pointNumBytes()
```
    Specified by:
    
    pointNumBytes in interface IndexableFieldType
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Specified by:
    
    getAttributes in interface IndexableFieldType

Class SchemaField

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SchemaField

SchemaField

SchemaField

Method Detail

getName

getType

getProperties

isUninvertible

indexed

stored

hasDocValues

storeTermVector

storeTermPositions

storeTermOffsets

storeTermPayloads

omitNorms

omitTermFreqAndPositions

omitPositions

storeOffsetsWithPositions

useDocValuesAsStored

multiValued

sortMissingFirst

sortMissingLast

isRequired

isLarge

getArgs

createField

createFields

isPolyField

toString

write

getSortField

getPostingsFormat

getDocValuesFormat

checkSortability

checkFieldCacheSource

getDefaultValue

hashCode

equals

getNamedPropertyValues

tokenized

storeTermVectors

storeTermVectorOffsets

storeTermVectorPositions

storeTermVectorPayloads

indexOptions

docValuesType

pointDimensionCount

pointIndexDimensionCount

pointNumBytes

getAttributes