org.hibernate.ogm.options.navigation.impl

Class ConfigurationContext

java.lang.Object

org.hibernate.ogm.options.navigation.impl.ConfigurationContext

public class ConfigurationContext
extends Object

Keeps track of the entities and properties configured using the fluent configuration API. There is one instance of this context per invocation of this API (beginning with the creation of a GlobalContext). This instance is passed between the individual context types created in the course of using the fluent API. The book-keeping of configured options is delegated to OptionsContext.

Author:

Davide D'Alto , Gunnar Morling

Constructor Summary

Constructors

Constructor and Description
ConfigurationContext(OptionsContext globalContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	addEntityOption(Option<?> option)
void	addGlobalOption(Option<?> option)
void	addPropertyOption(Option<?> option)
void	configureEntity(Class<?> entityType)
void	configureProperty(String propertyName, ElementType elementType)
<G extends GlobalContext<?,?>> G	createGlobalContext(Class<? extends G> globalContextImplType, Class<? extends EntityContext<?,?>> entityContextImplType, Class<? extends PropertyContext<?,?>> propertyContextImplType) Creates a new GlobalContext object based on the given context implementation types.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurationContext

public ConfigurationContext(OptionsContext globalContext)

Method Detail

addGlobalOption

public void addGlobalOption(Option<?> option)

addEntityOption

public void addEntityOption(Option<?> option)

addPropertyOption

public void addPropertyOption(Option<?> option)

configureEntity

public void configureEntity(Class<?> entityType)

configureProperty

public void configureProperty(String propertyName,
                     ElementType elementType)

createGlobalContext

public <G extends GlobalContext<?,?>> G createGlobalContext(Class<? extends G> globalContextImplType,
                                                   Class<? extends EntityContext<?,?>> entityContextImplType,
                                                   Class<? extends PropertyContext<?,?>> propertyContextImplType)

Creates a new GlobalContext object based on the given context implementation types. All implementation types must declare a public or protected constructor with a single parameter, accepting ConfigurationContext.

Each context implementation type must provide an implementation of the method(s) declared on the particular provider-specific context interface. All methods declared on context super interfaces - entity() and property() - are implemented following the dynamic proxy pattern, the implementation types therefore can be declared abstract, avoiding the need to implement these methods themselves.

By convention, the implementation types should directly or indirectly extend BaseContext.

Parameters:

globalContextImplType - the provider-specific global context implementation type

entityContextImplType - the provider-specific entity context implementation type

propertyContextImplType - the provider-specific property context implementation type

Returns:

a new GlobalContext object based on the given context implementation types