com.blazebit.persistence.view.metamodel

Interface Attribute<X,Y>

Type Parameters:

X - The type of the declaring entity view

Y - The type of attribute

All Known Subinterfaces:

CollectionAttribute<X,E>, CorrelatedAttribute<X,Y>, ListAttribute<X,E>, MapAttribute<X,K,V>, MappingAttribute<X,Y>, MethodAttribute<X,Y>, ParameterAttribute<X,Y>, PluralAttribute<X,C,E>, SetAttribute<X,E>, SingularAttribute<X,Y>, SubqueryAttribute<X,Y>

public interface Attribute<X,Y>

Represents an attribute of a view type.

Since:

1.0.0

Author:

Christian Beikov

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Attribute.AttributeType The different attribute types.
static class	Attribute.MappingType The different attribute mapping types.
static class	Attribute.MemberType The different attribute types.

Method Summary

Modifier and Type	Method and Description
Attribute.AttributeType	getAttributeType() Returns the type of the attribute.
int	getBatchSize() Returns the default batch size of the attribute.
ManagedViewType<X>	getDeclaringType() Returns the declaring view type.
String[]	getFetches() The associations that should be fetched along with the entity mapped by this attribute.
FetchStrategy	getFetchStrategy() Returns the fetch strategy of the attribute.
Class<Y>	getJavaType() Returns the java type of the attribute.
Attribute.MappingType	getMappingType() Returns the type of the attribute mapping.
Attribute.MemberType	getMemberType() Returns the type of the attribute member.
boolean	isCollection() Returns true if this attribute is a collection, otherwise false.
boolean	isCorrelated() Returns true if this attribute is correlated, otherwise false.
boolean	isSubquery() Returns true if this attribute maps to a subquery provider, otherwise false.
boolean	isSubview() Returns true if this attribute is a subview, otherwise false.

Method Detail

getDeclaringType

ManagedViewType<X> getDeclaringType()

Returns the declaring view type.

Returns:

The declaring view type

getJavaType

Class<Y> getJavaType()

Returns the java type of the attribute.

Returns:

The java type of the attribute

getMemberType

Attribute.MemberType getMemberType()

Returns the type of the attribute member.

Returns:

The type of the attribute member.

Since:

1.2.0

getAttributeType

Attribute.AttributeType getAttributeType()

Returns the type of the attribute.

Returns:

The type of the attribute

Since:

1.2.0

getMappingType

Attribute.MappingType getMappingType()

Returns the type of the attribute mapping.

Returns:

The type of the attribute mapping

Since:

1.2.0

isSubquery

boolean isSubquery()

Returns true if this attribute maps to a subquery provider, otherwise false.

Returns:

True if this attribute maps to a subquery provider, otherwise false

isCollection

boolean isCollection()

Returns true if this attribute is a collection, otherwise false.

Returns:

True if this attribute is a collection, otherwise false

isSubview

boolean isSubview()

Returns true if this attribute is a subview, otherwise false.

Returns:

True if this attribute is a subview, otherwise false

isCorrelated

boolean isCorrelated()

Returns true if this attribute is correlated, otherwise false.

Returns:

True if this attribute is correlated, otherwise false

getFetches

String[] getFetches()

The associations that should be fetched along with the entity mapped by this attribute.

Returns:

The association that should be fetched

Since:

1.2.0

getFetchStrategy

FetchStrategy getFetchStrategy()

Returns the fetch strategy of the attribute.

Returns:

The fetch strategy of the attribute

Since:

1.2.0

getBatchSize

int getBatchSize()

Returns the default batch size of the attribute. If no default batch size is configured, returns -1.

Returns:

The default batch size of the attribute

Since:

1.2.0