mapped superclass type.">
Jakarta Persistence (JPA) Interface

jakarta.persistence.metamodel.MappedSuperclassType<X>

Type Parameters:
<X> - The represented mapped superclass type
Super Interfaces:
IdentifiableType<X>, ManagedType<X>, Type<X>
An instance of the type MappedSuperclassType represents a mapped superclass type.
Since:
Jakarta Persistence (JPA) 2.0

Public Instance Methods

Attribute<? super X,?> getAttribute(String name)
Return the attribute of the managed type that corresponds to the specified name.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
Returns:
attribute with given name.
Throws:
IllegalArgumentException - if attribute of the given name is not present in the managed type.
Since:
Jakarta Persistence (JPA) 1.0
Set<Attribute<? super X,?>> getAttributes()
Return the attributes of the managed type.
Inherited from ManagedType<X>
Returns:
attributes of the managed type.
Since:
Jakarta Persistence (JPA) 1.0
CollectionAttribute<? super X,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.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
elementType - the element type of the represented attribute
Returns:
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.
Since:
Jakarta Persistence (JPA) 1.0
CollectionAttribute<? super X,?> getCollection(String name)
Return the Collection-valued attribute of the managed type that corresponds to the specified name.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
Returns:
CollectionAttribute of the given name.
Throws:
IllegalArgumentException - if attribute of the given name is not present in the managed type.
Since:
Jakarta Persistence (JPA) 1.0
Attribute<X,?> getDeclaredAttribute(String name)
Return the attribute declared by the managed type that corresponds to the specified name.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
Returns:
attribute with given name.
Throws:
IllegalArgumentException - if attribute of the given name is not declared in the managed type.
Since:
Jakarta Persistence (JPA) 1.0
Set<Attribute<X,?>> getDeclaredAttributes()
Return the attributes declared by the managed type.
Returns empty set if the managed type has no declared attributes.
Inherited from ManagedType<X>
Returns:
declared attributes of the managed type.
Since:
Jakarta Persistence (JPA) 1.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.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
elementType - the element type of the represented attribute
Returns:
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.
Since:
Jakarta Persistence (JPA) 1.0
CollectionAttribute<X,?> getDeclaredCollection(String name)
Return the Collection-valued attribute declared by the managed type that corresponds to the specified name.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
Returns:
declared CollectionAttribute of the given name.
Throws:
IllegalArgumentException - if attribute of the given name is not declared in the managed type.
Since:
Jakarta Persistence (JPA) 1.0
SingularAttribute<X,Y> getDeclaredId(Class<Y> type)
Return the attribute that corresponds to the id attribute declared by the entity or mapped superclass.
Inherited from IdentifiableType<X>
Parameters:
type - the type of the represented declared id attribute
Returns:
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:
Jakarta Persistence (JPA) 1.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.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
elementType - the element type of the represented attribute
Returns:
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.
Since:
Jakarta Persistence (JPA) 1.0
ListAttribute<X,?> getDeclaredList(String name)
Return the List-valued attribute declared by the managed type that corresponds to the specified name.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
Returns:
declared ListAttribute of the given name.
Throws:
IllegalArgumentException - if attribute of the given name is not declared in the managed type.
Since:
Jakarta Persistence (JPA) 1.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.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
keyType - the key type of the represented attribute
valueType - the value type of the represented attribute
Returns:
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.
Since:
Jakarta Persistence (JPA) 1.0
MapAttribute<X,?,?> getDeclaredMap(String name)
Return the Map-valued attribute declared by the managed type that corresponds to the specified name.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
Returns:
declared MapAttribute of the given name.
Throws:
IllegalArgumentException - if attribute of the given name is not declared in the managed type.
Since:
Jakarta Persistence (JPA) 1.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 multivalued attributes.
Inherited from ManagedType<X>
Returns:
declared Collection-, Set-, List-, and Map-valued attributes.
Since:
Jakarta Persistence (JPA) 1.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.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
elementType - the element type of the represented attribute
Returns:
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.
Since:
Jakarta Persistence (JPA) 1.0
SetAttribute<X,?> getDeclaredSet(String name)
Return the Set-valued attribute declared by the managed type that corresponds to the specified name.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
Returns:
declared SetAttribute of the given name.
Throws:
IllegalArgumentException - if attribute of the given name is not declared in the managed type.
Since:
Jakarta Persistence (JPA) 1.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.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
type - the type of the represented attribute
Returns:
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.
Since:
Jakarta Persistence (JPA) 1.0
SingularAttribute<X,?> getDeclaredSingularAttribute(String name)
Return the single-valued attribute declared by the managed type that corresponds to the specified name.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
Returns:
declared single-valued attribute of the given name.
Throws:
IllegalArgumentException - if attribute of the given name is not declared in the managed type.
Since:
Jakarta Persistence (JPA) 1.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.
Inherited from ManagedType<X>
Returns:
declared single-valued attributes.
Since:
Jakarta Persistence (JPA) 1.0
SingularAttribute<X,Y> getDeclaredVersion(Class<Y> type)
Return the attribute that corresponds to the version attribute declared by the entity or mapped superclass.
Inherited from IdentifiableType<X>
Parameters:
type - the type of the represented declared version attribute
Returns:
declared version attribute.
Throws:
IllegalArgumentException - if version attribute of the type is not declared in the identifiable type.
Since:
Jakarta Persistence (JPA) 1.0
SingularAttribute<? super X,Y> getId(Class<Y> type)
Return the attribute that corresponds to the id attribute of the entity or mapped superclass.
Inherited from IdentifiableType<X>
Parameters:
type - the type of the represented id attribute
Returns:
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:
Jakarta Persistence (JPA) 1.0
Set<SingularAttribute<? super X,?>> getIdClassAttributes()
Return the attributes corresponding to the id class of the identifiable type.
Inherited from IdentifiableType<X>
Returns:
id attributes.
Throws:
IllegalArgumentException - if the identifiable type does not have an id class.
Since:
Jakarta Persistence (JPA) 1.0
Type<?> getIdType()
Return the type that represents the type of the id.
Inherited from IdentifiableType<X>
Returns:
type of id.
Since:
Jakarta Persistence (JPA) 1.0
Class<X> getJavaType()
Return the represented Java type.
Inherited from Type<X>
Returns:
Java type.
Since:
Jakarta Persistence (JPA) 1.0
ListAttribute<? super X,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.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
elementType - the element type of the represented attribute
Returns:
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.
Since:
Jakarta Persistence (JPA) 1.0
ListAttribute<? super X,?> getList(String name)
Return the List-valued attribute of the managed type that corresponds to the specified name.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
Returns:
ListAttribute of the given name.
Throws:
IllegalArgumentException - if attribute of the given name is not present in the managed type.
Since:
Jakarta Persistence (JPA) 1.0
MapAttribute<? super X,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.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
keyType - the key type of the represented attribute
valueType - the value type of the represented attribute
Returns:
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.
Since:
Jakarta Persistence (JPA) 1.0
MapAttribute<? super X,?,?> getMap(String name)
Return the Map-valued attribute of the managed type that corresponds to the specified name.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
Returns:
MapAttribute of the given name.
Throws:
IllegalArgumentException - if attribute of the given name is not present in the managed type.
Since:
Jakarta Persistence (JPA) 1.0
PersistenceType getPersistenceType()
Return the persistence type.
Inherited from Type<X>
Returns:
persistence type.
Since:
Jakarta Persistence (JPA) 1.0
Set<PluralAttribute<? super X,?,?>> 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.
Inherited from ManagedType<X>
Returns:
Collection-, Set-, List-, and Map-valued attributes.
Since:
Jakarta Persistence (JPA) 1.0
SetAttribute<? super X,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.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
elementType - the element type of the represented attribute
Returns:
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.
Since:
Jakarta Persistence (JPA) 1.0
SetAttribute<? super X,?> getSet(String name)
Return the Set-valued attribute of the managed type that corresponds to the specified name.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
Returns:
SetAttribute of the given name.
Throws:
IllegalArgumentException - if attribute of the given name is not present in the managed type.
Since:
Jakarta Persistence (JPA) 1.0
SingularAttribute<? super X,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.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
type - the type of the represented attribute
Returns:
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.
Since:
Jakarta Persistence (JPA) 1.0
SingularAttribute<? super X,?> getSingularAttribute(String name)
Return the single-valued attribute of the managed type that corresponds to the specified name.
Inherited from ManagedType<X>
Parameters:
name - the name of the represented attribute
Returns:
single-valued attribute with the given name.
Throws:
IllegalArgumentException - if attribute of the given name is not present in the managed type.
Since:
Jakarta Persistence (JPA) 1.0
Set<SingularAttribute<? super X,?>> getSingularAttributes()
Return the single-valued attributes of the managed type.
Returns empty set if the managed type has no single-valued attributes.
Inherited from ManagedType<X>
Returns:
single-valued attributes.
Since:
Jakarta Persistence (JPA) 1.0
IdentifiableType<? super X> getSupertype()
Return the identifiable type that corresponds to the most specific mapped superclass or entity extended by the entity or mapped superclass.
Inherited from IdentifiableType<X>
Returns:
supertype of identifiable type or null if no such supertype.
Since:
Jakarta Persistence (JPA) 1.0
SingularAttribute<? super X,Y> getVersion(Class<Y> type)
Return the attribute that corresponds to the version attribute of the entity or mapped superclass.
Inherited from IdentifiableType<X>
Parameters:
type - the type of the represented version attribute
Returns:
version attribute.
Throws:
IllegalArgumentException - if version attribute of the given type is not present in the identifiable type.
Since:
Jakarta Persistence (JPA) 1.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.
Inherited from IdentifiableType<X>
Returns:
boolean indicating whether the identifiable type has a single id attribute.
Since:
Jakarta Persistence (JPA) 1.0
boolean hasVersionAttribute()
Whether the identifiable type has a version attribute.
Inherited from IdentifiableType<X>
Returns:
boolean indicating whether the identifiable type has a version attribute.
Since:
Jakarta Persistence (JPA) 1.0