JPA Interface

IdentifiableType<X>

Type Parameters:
<X> - The represented entity or mapped superclass type.
Super Interfaces:
ManagedType<X>, Type<X>
Instances of the type IdentifiableType represent entity or mapped superclass types.
Since:
JPA 2.0

Public Methods

Attribute<?superX,?> getAttribute(String name)
Return the attribute of the managed type that corresponds to the specified name.
Parameters:
name - the name of the represented attribute
Return:
attribute with given name
Throws:
IllegalArgumentException - if attribute of the given name is not present in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
Set<Attribute<?superX,?>> getAttributes()
Return the attributes of the managed type.
Return:
attributes of the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
CollectionAttribute<?superX,?> getCollection(String name)
Return the Collection-valued attribute of the managed type that corresponds to the specified name.
Parameters:
name - the name of the represented attribute
Return:
CollectionAttribute of the given name
Throws:
IllegalArgumentException - if attribute of the given name is not present in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
CollectionAttribute<?superX,E> getCollection(String name, Class<E> elementType)
Return the Collection-valued attribute of the managed type that corresponds to the specified name and Java element type.
Parameters:
name - the name of the represented attribute
elementType - the element type of the represented attribute
Return:
CollectionAttribute of the given name and element type
Throws:
IllegalArgumentException - if attribute of the given name and type is not present in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
Attribute<X,?> getDeclaredAttribute(String name)
Return the attribute declared by the managed type that corresponds to the specified name.
Parameters:
name - the name of the represented attribute
Return:
attribute with given name
Throws:
IllegalArgumentException - if attribute of the given name is not declared in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
Set<Attribute<X,?>> getDeclaredAttributes()
Return the attributes declared by the managed type.
Returns empty set if the managed type has no declared attributes.
Return:
declared attributes of the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
CollectionAttribute<X,?> getDeclaredCollection(String name)
Return the Collection-valued attribute declared by the managed type that corresponds to the specified name.
Parameters:
name - the name of the represented attribute
Return:
declared CollectionAttribute of the given name
Throws:
IllegalArgumentException - if attribute of the given name is not declared in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
CollectionAttribute<X,E> getDeclaredCollection(String name, Class<E> elementType)
Return the Collection-valued attribute declared by the managed type that corresponds to the specified name and Java element type.
Parameters:
name - the name of the represented attribute
elementType - the element type of the represented attribute
Return:
declared CollectionAttribute of the given name and element type
Throws:
IllegalArgumentException - if attribute of the given name and type is not declared in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
SingularAttribute<X,Y> getDeclaredId(Class<Y> type)
Return the attribute that corresponds to the id attribute declared by the entity or mapped superclass.
Parameters:
type - the type of the represented declared id attribute
Return:
declared id attribute
Throws:
IllegalArgumentException - if id attribute of the given type is not declared in the identifiable type or if the identifiable type has an id class
Since:
JPA 2.0
ListAttribute<X,?> getDeclaredList(String name)
Return the List-valued attribute declared by the managed type that corresponds to the specified name.
Parameters:
name - the name of the represented attribute
Return:
declared ListAttribute of the given name
Throws:
IllegalArgumentException - if attribute of the given name is not declared in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
ListAttribute<X,E> getDeclaredList(String name, Class<E> elementType)
Return the List-valued attribute declared by the managed type that corresponds to the specified name and Java element type.
Parameters:
name - the name of the represented attribute
elementType - the element type of the represented attribute
Return:
declared ListAttribute of the given name and element type
Throws:
IllegalArgumentException - if attribute of the given name and type is not declared in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
MapAttribute<X,?,?> getDeclaredMap(String name)
Return the Map-valued attribute declared by the managed type that corresponds to the specified name.
Parameters:
name - the name of the represented attribute
Return:
declared MapAttribute of the given name
Throws:
IllegalArgumentException - if attribute of the given name is not declared in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
MapAttribute<X,K,V> getDeclaredMap(String name, Class<K> keyType, Class<V> valueType)
Return the Map-valued attribute declared by the managed type that corresponds to the specified name and Java key and value types.
Parameters:
name - the name of the represented attribute
keyType - the key type of the represented attribute
valueType - the value type of the represented attribute
Return:
declared MapAttribute of the given name and key and value types
Throws:
IllegalArgumentException - if attribute of the given name and type is not declared in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
Set<PluralAttribute<X,?,?>> getDeclaredPluralAttributes()
Return all multi-valued attributes (Collection-, Set-, List-, and Map-valued attributes) declared by the managed type.
Returns empty set if the managed type has no declared multi-valued attributes.
Return:
declared Collection-, Set-, List-, and Map-valued attributes
Inherited from:
ManagedType<X>
Since:
JPA 2.0
SetAttribute<X,?> getDeclaredSet(String name)
Return the Set-valued attribute declared by the managed type that corresponds to the specified name.
Parameters:
name - the name of the represented attribute
Return:
declared SetAttribute of the given name
Throws:
IllegalArgumentException - if attribute of the given name is not declared in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
SetAttribute<X,E> getDeclaredSet(String name, Class<E> elementType)
Return the Set-valued attribute declared by the managed type that corresponds to the specified name and Java element type.
Parameters:
name - the name of the represented attribute
elementType - the element type of the represented attribute
Return:
declared SetAttribute of the given name and element type
Throws:
IllegalArgumentException - if attribute of the given name and type is not declared in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
SingularAttribute<X,?> getDeclaredSingularAttribute(String name)
Return the single-valued attribute declared by the managed type that corresponds to the specified name.
Parameters:
name - the name of the represented attribute
Return:
declared single-valued attribute of the given name
Throws:
IllegalArgumentException - if attribute of the given name is not declared in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
SingularAttribute<X,Y> getDeclaredSingularAttribute(String name, Class<Y> type)
Return the single-valued attribute declared by the managed type that corresponds to the specified name and Java type.
Parameters:
name - the name of the represented attribute
type - the type of the represented attribute
Return:
declared single-valued attribute of the given name and type
Throws:
IllegalArgumentException - if attribute of the given name and type is not declared in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
Set<SingularAttribute<X,?>> getDeclaredSingularAttributes()
Return the single-valued attributes declared by the managed type.
Returns empty set if the managed type has no declared single-valued attributes.
Return:
declared single-valued attributes
Inherited from:
ManagedType<X>
Since:
JPA 2.0
SingularAttribute<X,Y> getDeclaredVersion(Class<Y> type)
Return the attribute that corresponds to the version attribute declared by the entity or mapped superclass.
Parameters:
type - the type of the represented declared version attribute
Return:
declared version attribute
Throws:
IllegalArgumentException - if version attribute of the type is not declared in the identifiable type
Since:
JPA 2.0
SingularAttribute<?superX,Y> getId(Class<Y> type)
Return the attribute that corresponds to the id attribute of the entity or mapped superclass.
Parameters:
type - the type of the represented id attribute
Return:
id attribute
Throws:
IllegalArgumentException - if id attribute of the given type is not present in the identifiable type or if the identifiable type has an id class
Since:
JPA 2.0
Set<SingularAttribute<?superX,?>> getIdClassAttributes()
Return the attributes corresponding to the id class of the identifiable type.
Return:
id attributes
Throws:
IllegalArgumentException - if the identifiable type does not have an id class
Since:
JPA 2.0
Type<?> getIdType()
Return the type that represents the type of the id.
Return:
type of id
Since:
JPA 2.0
ListAttribute<?superX,?> getList(String name)
Return the List-valued attribute of the managed type that corresponds to the specified name.
Parameters:
name - the name of the represented attribute
Return:
ListAttribute of the given name
Throws:
IllegalArgumentException - if attribute of the given name is not present in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
ListAttribute<?superX,E> getList(String name, Class<E> elementType)
Return the List-valued attribute of the managed type that corresponds to the specified name and Java element type.
Parameters:
name - the name of the represented attribute
elementType - the element type of the represented attribute
Return:
ListAttribute of the given name and element type
Throws:
IllegalArgumentException - if attribute of the given name and type is not present in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
MapAttribute<?superX,?,?> getMap(String name)
Return the Map-valued attribute of the managed type that corresponds to the specified name.
Parameters:
name - the name of the represented attribute
Return:
MapAttribute of the given name
Throws:
IllegalArgumentException - if attribute of the given name is not present in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
MapAttribute<?superX,K,V> getMap(String name, Class<K> keyType, Class<V> valueType)
Return the Map-valued attribute of the managed type that corresponds to the specified name and Java key and value types.
Parameters:
name - the name of the represented attribute
keyType - the key type of the represented attribute
valueType - the value type of the represented attribute
Return:
MapAttribute of the given name and key and value types
Throws:
IllegalArgumentException - if attribute of the given name and type is not present in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
Set<PluralAttribute<?superX,?,?>> getPluralAttributes()
Return all multi-valued attributes (Collection-, Set-, List-, and Map-valued attributes) of the managed type.
Returns empty set if the managed type has no multi-valued attributes.
Return:
Collection-, Set-, List-, and Map-valued attributes
Inherited from:
ManagedType<X>
Since:
JPA 2.0
SetAttribute<?superX,?> getSet(String name)
Return the Set-valued attribute of the managed type that corresponds to the specified name.
Parameters:
name - the name of the represented attribute
Return:
SetAttribute of the given name
Throws:
IllegalArgumentException - if attribute of the given name is not present in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
SetAttribute<?superX,E> getSet(String name, Class<E> elementType)
Return the Set-valued attribute of the managed type that corresponds to the specified name and Java element type.
Parameters:
name - the name of the represented attribute
elementType - the element type of the represented attribute
Return:
SetAttribute of the given name and element type
Throws:
IllegalArgumentException - if attribute of the given name and type is not present in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
SingularAttribute<?superX,?> getSingularAttribute(String name)
Return the single-valued attribute of the managed type that corresponds to the specified name.
Parameters:
name - the name of the represented attribute
Return:
single-valued attribute with the given name
Throws:
IllegalArgumentException - if attribute of the given name is not present in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
SingularAttribute<?superX,Y> getSingularAttribute(String name, Class<Y> type)
Return the single-valued attribute of the managed type that corresponds to the specified name and Java type.
Parameters:
name - the name of the represented attribute
type - the type of the represented attribute
Return:
single-valued attribute with given name and type
Throws:
IllegalArgumentException - if attribute of the given name and type is not present in the managed type
Inherited from:
ManagedType<X>
Since:
JPA 2.0
Set<SingularAttribute<?superX,?>> getSingularAttributes()
Return the single-valued attributes of the managed type.
Returns empty set if the managed type has no single-valued attributes.
Return:
single-valued attributes
Inherited from:
ManagedType<X>
Since:
JPA 2.0
IdentifiableType<?superX> getSupertype()
Return the identifiable type that corresponds to the most specific mapped superclass or entity extended by the entity or mapped superclass.
Return:
supertype of identifiable type or null if no such supertype
Since:
JPA 2.0
SingularAttribute<?superX,Y> getVersion(Class<Y> type)
Return the attribute that corresponds to the version attribute of the entity or mapped superclass.
Parameters:
type - the type of the represented version attribute
Return:
version attribute
Throws:
IllegalArgumentException - if version attribute of the given type is not present in the identifiable type
Since:
JPA 2.0
boolean hasSingleIdAttribute()
Whether the identifiable type has a single id attribute.
Returns true for a simple id or embedded id; returns false for an idclass.
Return:
boolean indicating whether the identifiable type has a single id attribute
Since:
JPA 2.0
boolean hasVersionAttribute()
Whether the identifiable type has a version attribute.
Return:
boolean indicating whether the identifiable type has a version attribute
Since:
JPA 2.0