org.hibernate.search.engine.backend.common

Interface DocumentReference

public interface DocumentReference

A reference to an indexed document.

Method Summary

Modifier and Type	Method and Description
default String	getId() Deprecated. Use id() instead.
default String	getTypeName() Deprecated. Use typeName() instead.
String	id()
String	typeName()

Method Detail

typeName

String typeName()

Returns:

The name of the type of the referenced document. The type name is mapper-specific. For example, in the Hibernate ORM mapper, it will be the JPA entity name.

getTypeName

@Deprecated
default String getTypeName()

Deprecated. Use typeName() instead.

Returns:

The name of the type of the referenced document. The type name is mapper-specific. For example, in the Hibernate ORM mapper, it will be the JPA entity name.

id

String id()

Returns:

The identifier of the referenced document. The identifier is returned as it was generated during document building, i.e. it does not take into account backend-specific transformations such as appending a tenant ID when using multi-tenancy.

getId

@Deprecated
default String getId()

Deprecated. Use id() instead.

Returns:

The identifier of the referenced document. The identifier is returned as it was generated during document building, i.e. it does not take into account backend-specific transformations such as appending a tenant ID when using multi-tenancy.