• Home
• org.hibernate.search
• hibernate-search-engine
• 7.1.2.Final
• source code
• DocumentReference.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.hibernate.search.engine.backend.common.DocumentReference Maven / Gradle / Ivy

/*
 * Hibernate Search, full-text search for your domain model
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.search.engine.backend.common;

/**
 * A reference to an indexed document.
 */
public interface DocumentReference {

	/**
	 * @return 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.
	 */
	String typeName();

	/**
	 * @return 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.
	 */
	String id();

}