Uses of Interface org.apache.lucene.index.IndexableFieldType (Lucene 10.5.0 core API)
Description: use: package: org.apache.lucene.index, interface: IndexableFieldType

# Uses of Interface
org.apache.lucene.index.IndexableFieldType

Packages that use IndexableFieldType
Package
Description
org.apache.lucene.document
The logical representation of a `Document` for indexing and searching.
org.apache.lucene.document.column
Column-oriented batch indexing API.
org.apache.lucene.index
Code to maintain and access indices.

- ## Uses of IndexableFieldType in org.apache.lucene.document

  Classes in org.apache.lucene.document that implement IndexableFieldType
  Modifier and Type
  Class
  Description
  `class`
  `FieldType`
  Describes the properties of a field.
  Fields in org.apache.lucene.document declared as IndexableFieldType
  Modifier and Type
  Field
  Description
  `protected final IndexableFieldType`
  Field.`type`
  Field's type
  Methods in org.apache.lucene.document that return IndexableFieldType
  Modifier and Type
  Method
  Description
  `IndexableFieldType`
  Field.`fieldType()`
  Returns the `FieldType` for this field.
  `IndexableFieldType`
  ShapeDocValuesField.`fieldType()`
  Gets the `IndexableFieldType` for this ShapeDocValue field
  Constructors in org.apache.lucene.document with parameters of type IndexableFieldType
  Modifier
  Constructor
  Description
  ``
  `BinaryPoint(String name, byte[] packedPoint, IndexableFieldType type)`
  Expert API
  ``
  `Field(String name, byte[] value, int offset, int length, IndexableFieldType type)`
  Create field with binary value.
  ``
  `Field(String name, byte[] value, IndexableFieldType type)`
  Create field with binary value.
  ``
  `Field(String name, Reader reader, IndexableFieldType type)`
  Create field with Reader value.
  ``
  `Field(String name, CharSequence value, IndexableFieldType type)`
  Create field with String value.
  ``
  `Field(String name, TokenStream tokenStream, IndexableFieldType type)`
  Create field with TokenStream value.
  `protected`
  `Field(String name, IndexableFieldType type)`
  Expert: creates a field with no initial value.
  ``
  `Field(String name, BytesRef bytes, IndexableFieldType type)`
  Create field with binary value.
  ``
  `FieldType(IndexableFieldType ref)`
  Create a new mutable FieldType with all of the properties from `ref`

- ## Uses of IndexableFieldType in org.apache.lucene.document.column

  Methods in org.apache.lucene.document.column that return IndexableFieldType
  Modifier and Type
  Method
  Description
  `IndexableFieldType`
  Column.`fieldType()`
  Returns the field type describing how this field is indexed.
  Methods in org.apache.lucene.document.column with parameters of type IndexableFieldType
  Modifier and Type
  Method
  Description
  `static int`
  ColumnValidation.`featureMask(IndexableFieldType fieldType)`
  Returns a bitmask of the indexing features (`FEATURE_*`) declared by `fieldType`.
  `static void`
  ColumnValidation.`validateBinaryColumn(BinaryColumn column, IndexableFieldType fieldType)`
  Validates a `BinaryColumn` against the field type it will feed.
  `static void`
  ColumnValidation.`validateColumnHasIndexingFeature(String fieldName, IndexableFieldType fieldType)`
  Throws `IllegalArgumentException` if `fieldType` declares no indexing feature (no doc values, no points, not stored, no index options, no vectors).
  `static void`
  ColumnValidation.`validateDictionaryColumn(DictionaryColumn column, IndexableFieldType fieldType)`
  Validates a `DictionaryColumn` against the field type it will feed.
  `static void`
  ColumnValidation.`validateLongColumn(LongColumn column, IndexableFieldType fieldType)`
  Validates a `LongColumn` against the field type it will feed.
  `static void`
  ColumnValidation.`validateTokenStreamColumn(TokenStreamColumn column, IndexableFieldType fieldType)`
  Validates a `TokenStreamColumn` against the field type it will feed.
  `static void`
  ColumnValidation.`validateVectorColumn(VectorColumn<?> column, IndexableFieldType fieldType)`
  Validates a `VectorColumn` against the field type it will feed.
  Constructors in org.apache.lucene.document.column with parameters of type IndexableFieldType
  Modifier
  Constructor
  Description
  `protected`
  `BinaryColumn(String name, IndexableFieldType fieldType, Column.Density density)`
  Creates a BinaryColumn with the given field name, type, and density.
  `protected`
  `Column(String name, IndexableFieldType fieldType, Column.Density density)`
  Creates a Column with the given field name, type, and density.
  `protected`
  `DictionaryColumn(String name, IndexableFieldType fieldType, Column.Density density, List<BytesRef> dictionary)`
  Creates a DictionaryColumn.
  `protected`
  `LongColumn(String name, IndexableFieldType fieldType, Column.Density density)`
  Creates a LongColumn with `LongColumn.NumericKind.LONG`.
  `protected`
  `LongColumn(String name, IndexableFieldType fieldType, Column.Density density, LongColumn.NumericKind numericKind)`
  Creates a LongColumn with the given numeric interpretation.
  `protected`
  `TokenStreamColumn(String name, IndexableFieldType fieldType, Column.Density density)`
  Creates a TokenStreamColumn with the given field name, type, and density.
  `protected`
  `VectorColumn(String name, IndexableFieldType fieldType, Column.Density density)`
  Creates a VectorColumn with the given field name, type, and density.

- ## Uses of IndexableFieldType in org.apache.lucene.index

  Methods in org.apache.lucene.index that return IndexableFieldType
  Modifier and Type
  Method
  Description
  `IndexableFieldType`
  IndexableField.`fieldType()`
  `IndexableFieldType` describing the properties of this field.