EntityViewAttributeMapping (Blazebit Persistence Entity-View API 1.2.0-Alpha4 API)

All Known Subinterfaces:

EntityViewMethodAttributeMapping, EntityViewParameterMapping
```
public interface EntityViewAttributeMapping
```
Mapping of an entity view attribute.

Since:

1.2.0

Author:

Christian Beikov

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class EntityViewAttributeMapping.ContainerBehavior
The behavior of a plural attribute container.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`EntityViewAttributeMapping.ContainerBehavior` The behavior of a plural attribute container.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Class<? extends Comparator<?>>`	`getComparatorClass()` Returns the comparator class, or `null` if there none.
`EntityViewAttributeMapping.ContainerBehavior`	`getContainerBehavior()` Returns the behavior of a plural attribute container if the attribute is plural, or `null` otherwise.
`Class<?>`	`getDeclaredElementType()` The attribute's element type, or `null` if the attribute type is not a subtype of `Collection` or `Map`.
`Class<?>`	`getDeclaredKeyType()` The attribute's key type, or `null` if the attribute type is not a subtype of `Map`.
`Class<?>`	`getDeclaredType()` Returns the attribute type.
`EntityViewMapping`	`getDeclaringView()` Returns the mapping of the view declaring this attribute.
`Integer`	`getDefaultBatchSize()` Returns the default batch size to use for batched `FetchStrategy.SELECT` fetching.
`boolean`	`isCollection()` Returns whether this attribute is of the plural type.
`void`	`setContainerDefault()` Sets the container behavior to `EntityViewAttributeMapping.ContainerBehavior.DEFAULT`.
`void`	`setContainerIndexed()` Sets the container behavior to `EntityViewAttributeMapping.ContainerBehavior.INDEXED`.
`void`	`setContainerOrdered()` Sets the container behavior to `EntityViewAttributeMapping.ContainerBehavior.ORDERED`.
`void`	`setContainerSorted(Class<? extends Comparator<?>> comparatorClass)` Sets the container behavior to `EntityViewAttributeMapping.ContainerBehavior.SORTED` using the given comparator class, if given, for sorting.
`void`	`setDefaultBatchSize(Integer defaultBatchSize)` Sets the default batch size to use for batched `FetchStrategy.SELECT` fetching.

- Method Detail
  - getDeclaringView
```
EntityViewMapping getDeclaringView()
```
    Returns the mapping of the view declaring this attribute.
    
    Returns:
    
    The declaring view mapping
  - isCollection
```
boolean isCollection()
```
    Returns whether this attribute is of the plural type.
    
    Returns:
    
    true if this attribute is of the plural type, false otherwise
  - getContainerBehavior
```
EntityViewAttributeMapping.ContainerBehavior getContainerBehavior()
```
    Returns the behavior of a plural attribute container if the attribute is plural, or null otherwise.
    
    Returns:
    
    The container behavior, or null if attribute is singular
  - setContainerDefault
```
void setContainerDefault()
```
    Sets the container behavior to EntityViewAttributeMapping.ContainerBehavior.DEFAULT.
  - setContainerIndexed
```
void setContainerIndexed()
```
    Sets the container behavior to EntityViewAttributeMapping.ContainerBehavior.INDEXED.
  - setContainerOrdered
```
void setContainerOrdered()
```
    Sets the container behavior to EntityViewAttributeMapping.ContainerBehavior.ORDERED.
  - setContainerSorted
```
void setContainerSorted(Class<? extends Comparator<?>> comparatorClass)
```
    Sets the container behavior to EntityViewAttributeMapping.ContainerBehavior.SORTED using the given comparator class, if given, for sorting. If none is given, the key/element type is expected to implement Comparable.
    
    Parameters:
    
    comparatorClass - The class of the comparator to use for sorting or null
  - getComparatorClass
```
Class<? extends Comparator<?>> getComparatorClass()
```
    Returns the comparator class, or null if there none.
    
    Returns:
    
    The comparator class
  - getDefaultBatchSize
```
Integer getDefaultBatchSize()
```
    Returns the default batch size to use for batched FetchStrategy.SELECT fetching.
    
    Returns:
    
    The default batch size
  - setDefaultBatchSize
```
void setDefaultBatchSize(Integer defaultBatchSize)
```
    Sets the default batch size to use for batched FetchStrategy.SELECT fetching.
    
    Parameters:
    
    defaultBatchSize - The default batch size
  - getDeclaredType
```
Class<?> getDeclaredType()
```
    Returns the attribute type.
    
    Returns:
    
    The attribute type
  - getDeclaredKeyType
```
Class<?> getDeclaredKeyType()
```
    The attribute's key type, or null if the attribute type is not a subtype of Map.
    
    Returns:
    
    The attribute's key type, or null
  - getDeclaredElementType
```
Class<?> getDeclaredElementType()
```
    The attribute's element type, or null if the attribute type is not a subtype of Collection or Map.
    
    Returns:
    
    The attribute's element type, or null

Interface EntityViewAttributeMapping

Nested Class Summary

Method Summary

Method Detail

getDeclaringView

isCollection

getContainerBehavior

setContainerDefault

setContainerIndexed

setContainerOrdered

setContainerSorted

getComparatorClass

getDefaultBatchSize

setDefaultBatchSize

getDeclaredType

getDeclaredKeyType

getDeclaredElementType