com.blazebit.persistence.view

Annotation Type MappingCorrelatedSimple

@Target(value={METHOD,PARAMETER})
 @Retention(value=RUNTIME)
public @interface MappingCorrelatedSimple

Maps the annotated attribute as correlation attribute with a simple declarative mapping of the correlation.

Since:

1.2.0

Author:

Christian Beikov

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	correlated The entity class which is correlated.
String	correlationBasis The expression which is the basis for correlation.
String	correlationExpression The expression to use for correlating the entity type to the correlation basis.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	correlationKeyAlias The alias to use for the correlation key in the correlation expression.
String	correlationResult The expression for the result mapping of the correlated entity type.
FetchStrategy	fetch The fetch strategy to use for correlation.
String[]	fetches The associations of the entity that should be fetched.

Element Detail

correlated

public abstract Class<?> correlated

The entity class which is correlated.

Returns:

The correlated entity class

correlationBasis

public abstract String correlationBasis

The expression which is the basis for correlation.

Returns:

The expression

correlationExpression

public abstract String correlationExpression

The expression to use for correlating the entity type to the correlation basis.

Returns:

The expression

correlationKeyAlias

public abstract String correlationKeyAlias

The alias to use for the correlation key in the correlation expression.

Returns:

The expression

Default:

"correlationKey"

correlationResult

public abstract String correlationResult

The expression for the result mapping of the correlated entity type.

Returns:

The expression

Default:

""

fetches

public abstract String[] fetches

The associations of the entity that should be fetched. This is only valid if the mapping refers to an entity and is mapped as attribute with the original type.

Returns:

The JPQL expression mapping

Since:

1.2.0

Default:

{}

fetch

public abstract FetchStrategy fetch

The fetch strategy to use for correlation.

Returns:

The correlation fetch strategy

Default:

com.blazebit.persistence.view.FetchStrategy.SELECT