org.hibernate.jpa.criteria.path

Class MapKeyHelpers.MapKeyAttribute<K>

java.lang.Object

org.hibernate.jpa.criteria.path.MapKeyHelpers.MapKeyAttribute<K>

Type Parameters:

K - The type of the map key

All Implemented Interfaces:

Serializable, Attribute<Map<K,?>,K>, Bindable<K>, SingularAttribute<Map<K,?>,K>

Enclosing class:

MapKeyHelpers

public static class MapKeyHelpers.MapKeyAttribute<K>
extends Object
implements SingularAttribute<Map<K,?>,K>, Bindable<K>, Serializable

Defines an Attribute modelling of a map-key.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface javax.persistence.metamodel.Attribute

Attribute.PersistentAttributeType

Nested classes/interfaces inherited from interface javax.persistence.metamodel.Bindable

Bindable.BindableType

Constructor Summary

Constructors

Constructor and Description
MapKeyAttribute(CriteriaBuilderImpl criteriaBuilder, MapAttribute<?,K,?> attribute)

Method Summary

Modifier and Type	Method and Description
Class<K>	getBindableJavaType() Return the Java type of the represented object.
Bindable.BindableType	getBindableType() Return the bindable type of the represented object.
ManagedType<Map<K,?>>	getDeclaringType() Return the managed type representing the type in which the attribute was declared.
Member	getJavaMember() Return the java.lang.reflect.Member for the represented attribute.
Class<K>	getJavaType() Return the Java type of the represented attribute.
String	getName() Return the name of the attribute.
Attribute.PersistentAttributeType	getPersistentAttributeType() Return the persistent attribute type for the attribute.
Type<K>	getType() Return the type that represents the type of the attribute.
boolean	isAssociation() Is the attribute an association.
boolean	isCollection() Is the attribute collection-valued (represents a Collection, Set, List, or Map).
boolean	isId() Is the attribute an id attribute.
boolean	isOptional() Can the attribute be null.
boolean	isVersion() Is the attribute a version attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapKeyAttribute

public MapKeyAttribute(CriteriaBuilderImpl criteriaBuilder,
                       MapAttribute<?,K,?> attribute)

Method Detail

getName

public String getName()

Description copied from interface: Attribute

Return the name of the attribute.

Specified by:

getName in interface Attribute<Map<K,?>,K>

Returns:

name

getPersistentAttributeType

public Attribute.PersistentAttributeType getPersistentAttributeType()

Description copied from interface: Attribute

Return the persistent attribute type for the attribute.

Specified by:

getPersistentAttributeType in interface Attribute<Map<K,?>,K>

Returns:

persistent attribute type

getDeclaringType

public ManagedType<Map<K,?>> getDeclaringType()

Description copied from interface: Attribute

Return the managed type representing the type in which the attribute was declared.

Specified by:

getDeclaringType in interface Attribute<Map<K,?>,K>

Returns:

declaring type

getJavaType

public Class<K> getJavaType()

Description copied from interface: Attribute

Return the Java type of the represented attribute.

Specified by:

getJavaType in interface Attribute<Map<K,?>,K>

Returns:

Java type

getJavaMember

public Member getJavaMember()

Description copied from interface: Attribute

Return the java.lang.reflect.Member for the represented attribute.

Specified by:

getJavaMember in interface Attribute<Map<K,?>,K>

Returns:

corresponding java.lang.reflect.Member

isAssociation

public boolean isAssociation()

Description copied from interface: Attribute

Is the attribute an association.

Specified by:

isAssociation in interface Attribute<Map<K,?>,K>

Returns:

boolean indicating whether the attribute corresponds to an association

isCollection

public boolean isCollection()

Description copied from interface: Attribute

Is the attribute collection-valued (represents a Collection, Set, List, or Map).

Specified by:

isCollection in interface Attribute<Map<K,?>,K>

Returns:

boolean indicating whether the attribute is collection-valued

isId

public boolean isId()

Description copied from interface: SingularAttribute

Is the attribute an id attribute. This method will return true if the attribute is an attribute that corresponds to a simple id, an embedded id, or an attribute of an id class.

Specified by:

isId in interface SingularAttribute<Map<K,?>,K>

Returns:

boolean indicating whether the attribute is an id

isVersion

public boolean isVersion()

Description copied from interface: SingularAttribute

Is the attribute a version attribute.

Specified by:

isVersion in interface SingularAttribute<Map<K,?>,K>

Returns:

boolean indicating whether the attribute is a version attribute

isOptional

public boolean isOptional()

Description copied from interface: SingularAttribute

Can the attribute be null.

Specified by:

isOptional in interface SingularAttribute<Map<K,?>,K>

Returns:

boolean indicating whether the attribute can be null

getType

public Type<K> getType()

Description copied from interface: SingularAttribute

Return the type that represents the type of the attribute.

Specified by:

getType in interface SingularAttribute<Map<K,?>,K>

Returns:

type of attribute

getBindableType

public Bindable.BindableType getBindableType()

Description copied from interface: Bindable

Return the bindable type of the represented object.

Specified by:

getBindableType in interface Bindable<K>

Returns:

bindable type

getBindableJavaType

public Class<K> getBindableJavaType()

Description copied from interface: Bindable

Return the Java type of the represented object. If the bindable type of the object is PLURAL_ATTRIBUTE, the Java element type is returned. If the bindable type is SINGULAR_ATTRIBUTE or ENTITY_TYPE, the Java type of the represented entity or attribute is returned.

Specified by:

getBindableJavaType in interface Bindable<K>

Returns:

Java type