com.blazebit.persistence.view.spi

Interface EntityViewConfiguration

public interface EntityViewConfiguration

This class is used to configure the entity view manager that it creates.

Since:

1.0.0

Author:

Christian Beikov

Method Summary

Modifier and Type	Method and Description
EntityViewConfiguration	addEntityView(Class<?> clazz) Adds the given class to the set of known entity views.
EntityViewConfiguration	addProperties(Properties extraProperties) Add the given properties to the properties of the configuration.
EntityViewManager	createEntityViewManager(CriteriaBuilderFactory criteriaBuilderFactory) Creates a new entity view manager from this configuration.
EntityViewManager	createEntityViewManager(CriteriaBuilderFactory criteriaBuilderFactory, javax.persistence.EntityManagerFactory entityManagerFactory) Deprecated. Will be removed. Use createEntityViewManager(CriteriaBuilderFactory) instead.
EntityViewMapping	createEntityViewMapping(Class<?> clazz) Creates an entity view mapping based on the given annotated class that can be further refined and finally added.
Map<Class<?>,BasicUserType<?>>	getBasicUserTypes() Returns the currently registered basic user types.
Collection<EntityViewMapping>	getEntityViewMappings() Returns the currently registered entity view mappings.
Set<Class<?>>	getEntityViews() Returns the currently known entity views.
Properties	getProperties() Returns all properties.
String	getProperty(String propertyName) Returns a property value by name.
Map<Class<?>,Map<Class<?>,TypeConverter<?,?>>>	getTypeConverters() Returns the currently registered type converters.
<Y> Map<Class<?>,TypeConverter<?,Y>>	getTypeConverters(Class<Y> viewModelType) Returns the currently registered type converters for the given view model type.
EntityViewConfiguration	mergeProperties(Properties properties) Adds the given properties to the properties of the configuration, without overriding existing values.
<X> EntityViewConfiguration	registerBasicUserType(Class<X> clazz, BasicUserType<X> userType) Registers the given user type for the given class.
<X,Y> EntityViewConfiguration	registerTypeConverter(Class<X> underlyingType, Class<Y> viewModelType, TypeConverter<X,Y> converter) Registers the given converter for the given types.
EntityViewConfiguration	setProperties(Properties properties) Replace the properties of the configuration with the given properties.
EntityViewConfiguration	setProperty(String propertyName, String value) Set a property value by name.

Method Detail

addEntityView

EntityViewConfiguration addEntityView(Class<?> clazz)

Adds the given class to the set of known entity views.

Parameters:

clazz - The class to be added

Returns:

this for method chaining

createEntityViewMapping

EntityViewMapping createEntityViewMapping(Class<?> clazz)

Creates an entity view mapping based on the given annotated class that can be further refined and finally added.

Parameters:

clazz - The annotated class to base the mapping on

Returns:

the entity view mapping

Since:

1.2.0

registerBasicUserType

<X> EntityViewConfiguration registerBasicUserType(Class<X> clazz,
                                                  BasicUserType<X> userType)

Registers the given user type for the given class.

Type Parameters:

X - The type of the class

Parameters:

clazz - The class for which to register the user type

userType - The user type implementation

Returns:

this for method chaining

Since:

1.2.0

registerTypeConverter

<X,Y> EntityViewConfiguration registerTypeConverter(Class<X> underlyingType,
                                                    Class<Y> viewModelType,
                                                    TypeConverter<X,Y> converter)

Registers the given converter for the given types.

Type Parameters:

X - The underlying type

Y - The entity view model type

Parameters:

underlyingType - The underlying type supported by the entity view type system

viewModelType - The entity view model type

converter - The type converter

Returns:

this for method chaining

Since:

1.2.0

createEntityViewManager

EntityViewManager createEntityViewManager(CriteriaBuilderFactory criteriaBuilderFactory)

Creates a new entity view manager from this configuration.

Parameters:

criteriaBuilderFactory - The criteria builder factory for which the entity view manager should be created

Returns:

A new entity view manager

Since:

1.2.0

createEntityViewManager

@Deprecated
EntityViewManager createEntityViewManager(CriteriaBuilderFactory criteriaBuilderFactory,
                                                       javax.persistence.EntityManagerFactory entityManagerFactory)

Deprecated. Will be removed. Use createEntityViewManager(CriteriaBuilderFactory) instead.

Creates a new entity view manager from this configuration.

Parameters:

criteriaBuilderFactory - The criteria builder factory for which the entity view manager should be created

entityManagerFactory - The entity manager factory for which the entity view manager should be created

Returns:

A new entity view manager

getEntityViews

Set<Class<?>> getEntityViews()

Returns the currently known entity views.

Returns:

The currently known entity views

getEntityViewMappings

Collection<EntityViewMapping> getEntityViewMappings()

Returns the currently registered entity view mappings.

Returns:

The currently registered entity view mappings.

Since:

1.2.0

getBasicUserTypes

Map<Class<?>,BasicUserType<?>> getBasicUserTypes()

Returns the currently registered basic user types.

Returns:

The currently registered basic user types.

Since:

1.2.0

getTypeConverters

Map<Class<?>,Map<Class<?>,TypeConverter<?,?>>> getTypeConverters()

Returns the currently registered type converters.

Returns:

The currently registered type converters.

Since:

1.2.0

getTypeConverters

<Y> Map<Class<?>,TypeConverter<?,Y>> getTypeConverters(Class<Y> viewModelType)

Returns the currently registered type converters for the given view model type.

Type Parameters:

Y - The entity view model type

Parameters:

viewModelType - The view model type

Returns:

The currently registered type converters for the given view model type.

Since:

1.2.0

getProperties

Properties getProperties()

Returns all properties.

Returns:

All properties

getProperty

String getProperty(String propertyName)

Returns a property value by name.

Parameters:

propertyName - The name of the property

Returns:

The value currently associated with that property name; may be null.

setProperties

EntityViewConfiguration setProperties(Properties properties)

Replace the properties of the configuration with the given properties.

Parameters:

properties - The new set of properties

Returns:

this for method chaining

addProperties

EntityViewConfiguration addProperties(Properties extraProperties)

Add the given properties to the properties of the configuration.

Parameters:

extraProperties - The properties to add.

Returns:

this for method chaining

mergeProperties

EntityViewConfiguration mergeProperties(Properties properties)

Adds the given properties to the properties of the configuration, without overriding existing values.

Parameters:

properties - The properties to merge

Returns:

this for method chaining

setProperty

EntityViewConfiguration setProperty(String propertyName,
                                    String value)

Set a property value by name.

Parameters:

propertyName - The name of the property to set

value - The new property value

Returns:

this for method chaining