Interface ViewRoot
public interface ViewRoot
An entity view root.
- Since:
- 1.6.0
- Author:
- Christian Beikov
-
Method Summary
Modifier and Type Method Description Class<? extends CorrelationProvider>
getCorrelationProvider()
Returns the correlation provider of the view root.CorrelationProviderFactory
getCorrelationProviderFactory()
Returns the correlation provider factory of the view root.String[]
getFetches()
The associations that should be fetched along with the entity mapped by this attribute.JoinType
getJoinType()
The join type to use for the entity view root.String
getLimitExpression()
Returns the limit expression.String
getName()
The name of the entity view root through which it can be accessed in the entity view mappings.String
getOffsetExpression()
Returns the offset expression.List<OrderByItem>
getOrderByItems()
Returns the order by items for the limit expression.javax.persistence.metamodel.Type<?>
getType()
Returns the type of the view root.
-
Method Details
-
getName
String getName()The name of the entity view root through which it can be accessed in the entity view mappings.- Returns:
- The entity view root name
-
getType
javax.persistence.metamodel.Type<?> getType()Returns the type of the view root. May benull
if not resolvable.- Returns:
- The type of the view root
-
getCorrelationProviderFactory
CorrelationProviderFactory getCorrelationProviderFactory()Returns the correlation provider factory of the view root.- Returns:
- The correlation provider factory of the view root
-
getCorrelationProvider
Class<? extends CorrelationProvider> getCorrelationProvider()Returns the correlation provider of the view root.- Returns:
- The correlation provider of the view root
-
getJoinType
JoinType getJoinType()The join type to use for the entity view root.- Returns:
- The join type
-
getFetches
String[] getFetches()The associations that should be fetched along with the entity mapped by this attribute.- Returns:
- The association that should be fetched
-
getOrderByItems
List<OrderByItem> getOrderByItems()Returns the order by items for the limit expression.- Returns:
- The order by items for the limit expression
-
getLimitExpression
String getLimitExpression()Returns the limit expression.- Returns:
- The limit expression
-
getOffsetExpression
String getOffsetExpression()Returns the offset expression.- Returns:
- The offset expression
-