/*
 * Hibernate OGM, Domain model persistence for NoSQL datastores
 *
 * 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.ogm.options.navigation;

import java.lang.annotation.ElementType;

import org.hibernate.ogm.options.navigation.spi.BaseEntityContext;
import org.hibernate.ogm.options.navigation.spi.ConfigurationContext;

/**
 * Property level to the options navigation API. Let's you define property level options as well as navigate to a
 * another property level of the current entity or to another entity.
 * <p>
 * Implementations must declare a constructor with a single parameter of type {@link ConfigurationContext} and should
 * preferably be derived from {@link BaseEntityContext}.
 *
 * @author Emmanuel Bernard <emmanuel@hibernate.org>
 * @param <E> the type of provider-specific entity context definition, associated with the specific property context
 * type
 * @param <P> the type of a provider-specific property context definition, following the self-referential generic type
 * pattern
 */
public interface PropertyContext<E extends EntityContext<E, P>, P extends PropertyContext<E, P>> {

	/**
	 * Specify mapping for the entity {@code type}
	 *
	 * @param type the type of the entity
	 * @return the entity context definition
	 */
	E entity(Class<?> type);

	/**
	 * Specify mapping for the given property.
	 *
	 * @param propertyName the name of the property to be configured, following to the JavaBeans naming convention
	 * @param target the target element type of the property, must either be {@link ElementType#FIELD} or
	 * {@link ElementType#METHOD}).
	 * @return the property context definition
	 */
	P property(String propertyName, ElementType target);
}