org.hibernate.search.engine.search

Interface DocumentReference

public interface DocumentReference

A reference to an indexed document.

Method Summary

Modifier and Type	Method and Description
String	getId()
String	getIndexName()

Method Detail

getIndexName

String getIndexName()

Returns:

The name of the index hosting the referenced document. The name is returned as it is configured in Hibernate Search, i.e. it is not normalized (lowercased, ...) as some backends may do under the hood.

getId

String getId()

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.