MetadataProvider.java

/*
 * 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 <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.search.engine.metadata.impl;

import org.hibernate.search.indexes.spi.IndexManagerType;

/**
 * @author Hardy Ferentschik
 */
public interface MetadataProvider {

	/**
	 * Returns the Search related metadata for the specified type.
	 *
	 * @param clazz The type of interest.
	 * @param indexManagerType the {@code IndexManagerType} type managing this entity type
	 *
	 * @return the {@code TypeMetadata} for the specified type
	 */
	TypeMetadata getTypeMetadataFor(Class<?> clazz, IndexManagerType indexManagerType);

	/**
	 * Returns the {@code ContainedIn} related metadata for the specified type.
	 *
	 * <p>The metadata for {@code ContainedIn} are not comprehensive: they do not
	 * contain the information about the FieldBridges, the analyzers or the NullMarkerCodecs.
	 * <p>We can't build these information because classes only marked with
	 * {@code ContainedIn} are not tied to an {@code IndexManager}.
	 * <p>It's of no use for {@code ContainedIn} resolution anyway.
	 *
	 * @param clazz The type of interest.
	 *
	 * @return the {@code ContainedInTypeMetadata} for the specified type
	 */
	TypeMetadata getTypeMetadataForContainedIn(Class<?> clazz);

	boolean containsSearchMetadata(Class<?> clazz);
}