Package org.hibernate.search.backend.elasticsearch.types.dsl.impl

Class ElasticsearchIndexFieldTypeFactoryImpl

java.lang.Object

org.hibernate.search.backend.elasticsearch.types.dsl.impl.ElasticsearchIndexFieldTypeFactoryImpl

All Implemented Interfaces:

ElasticsearchIndexFieldTypeFactory, ElasticsearchIndexFieldTypeBuildContext, IndexFieldTypeFactory

public class ElasticsearchIndexFieldTypeFactoryImpl
extends Object
implements ElasticsearchIndexFieldTypeFactory, ElasticsearchIndexFieldTypeBuildContext

Constructor Summary

Constructors

Constructor	Description
ElasticsearchIndexFieldTypeFactoryImpl(EventContext eventContext, BackendMapperContext backendMapperContext, com.google.gson.Gson userFacingGson, ElasticsearchDefaultFieldFormatProvider defaultFieldFormatProvider, IndexFieldTypeDefaultsProvider typeDefaultsProvider, ElasticsearchVectorFieldTypeMappingContributor vectorFieldTypeMappingContributor)

Method Summary

Modifier and Type	Method	Description
<F> StandardIndexFieldTypeOptionsStep<?,F>	as(Class<F> valueType)	Define a field type whose values are represented as a given type in Hibernate Search.
ScaledNumberIndexFieldTypeOptionsStep<?,BigDecimal>	asBigDecimal()	Define a field type whose values are represented as a BigDecimal in Hibernate Search.
ScaledNumberIndexFieldTypeOptionsStep<?,BigInteger>	asBigInteger()	Define a field type whose values are represented as a BigInteger in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,Boolean>	asBoolean()	Define a field type whose values are represented as a Boolean in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,Byte>	asByte()	Define a field type whose values are represented as a Byte in Hibernate Search.
VectorFieldTypeOptionsStep<?,byte[]>	asByteVector()	Define a field type intended for use in vector search and whose values are represented as a byte[] in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,Double>	asDouble()	Define a field type whose values are represented as a Double in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,Float>	asFloat()	Define a field type whose values are represented as a Float in Hibernate Search.
VectorFieldTypeOptionsStep<?,float[]>	asFloatVector()	Define a field type intended for use in vector search and whose values are represented as a float[] in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,GeoPoint>	asGeoPoint()	Define a field type whose values are represented as a GeoPoint in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,Instant>	asInstant()	Define a field type whose values are represented as an Instant in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,Integer>	asInteger()	Define a field type whose values are represented as an Integer in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,LocalDate>	asLocalDate()	Define a field type whose values are represented as a LocalDate in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,LocalDateTime>	asLocalDateTime()	Define a field type whose values are represented as a LocalDateTime in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,LocalTime>	asLocalTime()	Define a field type whose values are represented as a LocalTime in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,Long>	asLong()	Define a field type whose values are represented as a Long in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,MonthDay>	asMonthDay()	Define a field type whose values are represented as a MonthDay in Hibernate Search.
ElasticsearchNativeIndexFieldTypeMappingStep	asNative()	Define a native field type.
StandardIndexFieldTypeOptionsStep<?,OffsetDateTime>	asOffsetDateTime()	Define a field type whose values are represented as an OffsetDateTime in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,OffsetTime>	asOffsetTime()	Define a field type whose values are represented as an OffsetTime in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,Short>	asShort()	Define a field type whose values are represented as a Short in Hibernate Search.
StringIndexFieldTypeOptionsStep<?>	asString()	Define a field type whose values are represented as a String in Hibernate Search.
<F> VectorFieldTypeOptionsStep<?,F>	asVector(Class<F> valueType)	Define a vector field type whose values are represented as a given type in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,Year>	asYear()	Define a field type whose values are represented as a Year in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,YearMonth>	asYearMonth()	Define a field type whose values are represented as a YearMonth in Hibernate Search.
StandardIndexFieldTypeOptionsStep<?,ZonedDateTime>	asZonedDateTime()	Define a field type whose values are represented as a ZonedDateTime in Hibernate Search.
ElasticsearchDefaultFieldFormatProvider	getDefaultFieldFormatProvider()
EventContext	getEventContext()
com.google.gson.Gson	getUserFacingGson()
BackendMappingHints	hints()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeFactory

extension

Constructor Details

ElasticsearchIndexFieldTypeFactoryImpl

public ElasticsearchIndexFieldTypeFactoryImpl(EventContext eventContext,
 BackendMapperContext backendMapperContext,
 com.google.gson.Gson userFacingGson,
 ElasticsearchDefaultFieldFormatProvider defaultFieldFormatProvider,
 IndexFieldTypeDefaultsProvider typeDefaultsProvider,
 ElasticsearchVectorFieldTypeMappingContributor vectorFieldTypeMappingContributor)

Method Details

as

public <F> StandardIndexFieldTypeOptionsStep<?,F> as(Class<F> valueType)

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a given type in Hibernate Search.

Note this method will return a "generic" DSL step that does not offer any type-specific options. When possible, prefer the other methods such as IndexFieldTypeFactory.asString() or IndexFieldTypeFactory.asInteger().

Specified by:

as in interface IndexFieldTypeFactory

Type Parameters:

F - The type of values for this field type.

Parameters:

valueType - The type of values for this field type.

Returns:

A DSL step where the index field type can be defined in more details.

asString

public StringIndexFieldTypeOptionsStep<?> asString()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a String in Hibernate Search.

Specified by:

asString in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asInteger

public StandardIndexFieldTypeOptionsStep<?,Integer> asInteger()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as an Integer in Hibernate Search.

Specified by:

asInteger in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asLong

public StandardIndexFieldTypeOptionsStep<?,Long> asLong()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a Long in Hibernate Search.

Specified by:

asLong in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asBoolean

public StandardIndexFieldTypeOptionsStep<?,Boolean> asBoolean()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a Boolean in Hibernate Search.

Specified by:

asBoolean in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asByte

public StandardIndexFieldTypeOptionsStep<?,Byte> asByte()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a Byte in Hibernate Search.

Specified by:

asByte in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asShort

public StandardIndexFieldTypeOptionsStep<?,Short> asShort()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a Short in Hibernate Search.

Specified by:

asShort in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asFloat

public StandardIndexFieldTypeOptionsStep<?,Float> asFloat()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a Float in Hibernate Search.

Specified by:

asFloat in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asDouble

public StandardIndexFieldTypeOptionsStep<?,Double> asDouble()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a Double in Hibernate Search.

Specified by:

asDouble in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asLocalDate

public StandardIndexFieldTypeOptionsStep<?,LocalDate> asLocalDate()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a LocalDate in Hibernate Search.

Specified by:

asLocalDate in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asLocalDateTime

public StandardIndexFieldTypeOptionsStep<?,LocalDateTime> asLocalDateTime()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a LocalDateTime in Hibernate Search.

Specified by:

asLocalDateTime in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asLocalTime

public StandardIndexFieldTypeOptionsStep<?,LocalTime> asLocalTime()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a LocalTime in Hibernate Search.

Specified by:

asLocalTime in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asInstant

public StandardIndexFieldTypeOptionsStep<?,Instant> asInstant()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as an Instant in Hibernate Search.

Specified by:

asInstant in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asZonedDateTime

public StandardIndexFieldTypeOptionsStep<?,ZonedDateTime> asZonedDateTime()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a ZonedDateTime in Hibernate Search.

Specified by:

asZonedDateTime in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asYear

public StandardIndexFieldTypeOptionsStep<?,Year> asYear()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a Year in Hibernate Search.

Specified by:

asYear in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asYearMonth

public StandardIndexFieldTypeOptionsStep<?,YearMonth> asYearMonth()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a YearMonth in Hibernate Search.

Specified by:

asYearMonth in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asMonthDay

public StandardIndexFieldTypeOptionsStep<?,MonthDay> asMonthDay()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a MonthDay in Hibernate Search.

Specified by:

asMonthDay in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asOffsetDateTime

public StandardIndexFieldTypeOptionsStep<?,OffsetDateTime> asOffsetDateTime()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as an OffsetDateTime in Hibernate Search.

Specified by:

asOffsetDateTime in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asOffsetTime

public StandardIndexFieldTypeOptionsStep<?,OffsetTime> asOffsetTime()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as an OffsetTime in Hibernate Search.

Specified by:

asOffsetTime in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asGeoPoint

public StandardIndexFieldTypeOptionsStep<?,GeoPoint> asGeoPoint()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a GeoPoint in Hibernate Search.

Specified by:

asGeoPoint in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asBigDecimal

public ScaledNumberIndexFieldTypeOptionsStep<?,BigDecimal> asBigDecimal()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a BigDecimal in Hibernate Search.

Specified by:

asBigDecimal in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asBigInteger

public ScaledNumberIndexFieldTypeOptionsStep<?,BigInteger> asBigInteger()

Description copied from interface: IndexFieldTypeFactory

Define a field type whose values are represented as a BigInteger in Hibernate Search.

Specified by:

asBigInteger in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asVector

public <F> VectorFieldTypeOptionsStep<?,F> asVector(Class<F> valueType)

Description copied from interface: IndexFieldTypeFactory

Define a vector field type whose values are represented as a given type in Hibernate Search.

When possible, prefer the other methods such as IndexFieldTypeFactory.asByteVector() or IndexFieldTypeFactory.asFloatVector() to avoid unnecessary type checks.

Specified by:

asVector in interface IndexFieldTypeFactory

Type Parameters:

F - The type of values for this field type.

Parameters:

valueType - The type of values for this field type. Should be an array type like byte[] or float[].

Returns:

A DSL step where the index vector field type can be defined in more details.

asByteVector

public VectorFieldTypeOptionsStep<?,byte[]> asByteVector()

Description copied from interface: IndexFieldTypeFactory

Define a field type intended for use in vector search and whose values are represented as a byte[] in Hibernate Search.

Specified by:

asByteVector in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asFloatVector

public VectorFieldTypeOptionsStep<?,float[]> asFloatVector()

Description copied from interface: IndexFieldTypeFactory

Define a field type intended for use in vector search and whose values are represented as a float[] in Hibernate Search.

Specified by:

asFloatVector in interface IndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

asNative

public ElasticsearchNativeIndexFieldTypeMappingStep asNative()

Description copied from interface: ElasticsearchIndexFieldTypeFactory

Define a native field type.

A native field type has the following characteristics:

• Hibernate Search doesn't know its exact type, so it must be entirely defined as a JSON object, provided as the mappingJsonString parameter
• When indexing, fields of this type must be populated with JSON. The field has a string type, but the string is interpreted as JSON, so it can contain a boolean, an integer, or even an object.
• The predicate/sort/projection DSLs have only limited support for fields of this type. Some features may not work and throw an exception, such as phrase predicates. It is recommended to create the predicate/sort/projections targeting these fields from JSON using ElasticsearchSearchPredicateFactory.fromJson(String) or ElasticsearchSearchSortFactory.fromJson(String)

Specified by:

asNative in interface ElasticsearchIndexFieldTypeFactory

Returns:

A DSL step where the index field type can be defined in more details.

getEventContext

public EventContext getEventContext()

Specified by:

getEventContext in interface ElasticsearchIndexFieldTypeBuildContext

getUserFacingGson

public com.google.gson.Gson getUserFacingGson()

Specified by:

getUserFacingGson in interface ElasticsearchIndexFieldTypeBuildContext

getDefaultFieldFormatProvider

public ElasticsearchDefaultFieldFormatProvider getDefaultFieldFormatProvider()

Specified by:

getDefaultFieldFormatProvider in interface ElasticsearchIndexFieldTypeBuildContext

hints

public BackendMappingHints hints()

Specified by:

hints in interface ElasticsearchIndexFieldTypeBuildContext