Top Description Fields Constructors Methods
org.hibernate.mapping

public Class MappedSuperclass

extends Object
Class Inheritance
Imports
java.util.ArrayList, .Iterator, .List
Represents a @MappedSuperclass. A @MappedSuperclass can be a superclass of an @Entity (root or not) This class primary goal is to give a representation to @MappedSuperclass in the metamodel in order to reflect them in the JPA 2 metamodel. Do not use outside this use case. A proper redesign will be evaluated in Hibernate 4 Implementation details: properties are copies of their closest sub-persistentClass versions
Author
Emmanuel Bernard

Field Summary

Modifier and TypeField and Description
private final List<E>
declaredProperties

private Component
identifierMapper

private Property
identifierProperty

private Class<T>
mappedClass

private final MappedSuperclass
superMappedSuperclass

private final PersistentClass
superPersistentClass

private Property
version

Constructor Summary

AccessConstructor and Description
public
MappedSuperclass(MappedSuperclass superMappedSuperclass, PersistentClass superPersistentClass)

Method Summary

Modifier and TypeMethod and Description
public void
addDeclaredProperty(Property p)

public Component
getDeclaredIdentifierMapper()

public Property
getDeclaredIdentifierProperty()

public Iterator<E>
getDeclaredPropertyIterator()

public Property
getDeclaredVersion()

public Component
getIdentifierMapper()

public Property
getIdentifierProperty()

public Class<T>
getMappedClass()

public MappedSuperclass

Returns:

the super MappedSuperclass
getSuperMappedSuperclass()

Returns the first superclass marked as @MappedSuperclass or null if: - none exists - or the first persistent superclass found is an @Entity

public PersistentClass

Returns:

the PersistentClass of the superclass
getSuperPersistentClass()

Returns the PersistentClass of the first superclass marked as @Entity or null if none exists

public Property
getVersion()

public boolean
hasIdentifierProperty()

public boolean

Returns:

true if a property with that name exists; false if not
hasProperty(String
The property name to check
name)

Check to see if this MappedSuperclass defines a property with the given name.

public boolean

Returns:

true if a property with that name exists; false if not
isPropertyDefinedInHierarchy(String
The property name to check
name)

Check to see if a property with the given name exists in this MappedSuperclass or in any of its super hierarchy.

public boolean
isVersioned()

public void
setDeclaredIdentifierMapper(Component identifierMapper)

public void
setDeclaredIdentifierProperty(Property prop)

public void
setDeclaredVersion(Property prop)

public void
setMappedClass(Class<T> mappedClass)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

declaredPropertiesback to summary
private final List<E> declaredProperties
identifierMapperback to summary
private Component identifierMapper
identifierPropertyback to summary
private Property identifierProperty
mappedClassback to summary
private Class<T> mappedClass
superMappedSuperclassback to summary
private final MappedSuperclass superMappedSuperclass
superPersistentClassback to summary
private final PersistentClass superPersistentClass
versionback to summary
private Property version

Constructor Detail

MappedSuperclassback to summary
public MappedSuperclass(MappedSuperclass superMappedSuperclass, PersistentClass superPersistentClass)

Method Detail

addDeclaredPropertyback to summary
public void addDeclaredProperty(Property p)
getDeclaredIdentifierMapperback to summary
public Component getDeclaredIdentifierMapper()
getDeclaredIdentifierPropertyback to summary
public Property getDeclaredIdentifierProperty()
getDeclaredPropertyIteratorback to summary
public Iterator<E> getDeclaredPropertyIterator()
getDeclaredVersionback to summary
public Property getDeclaredVersion()
getIdentifierMapperback to summary
public Component getIdentifierMapper()
getIdentifierPropertyback to summary
public Property getIdentifierProperty()
getMappedClassback to summary
public Class<T> getMappedClass()
getSuperMappedSuperclassback to summary
public MappedSuperclass getSuperMappedSuperclass()

Returns the first superclass marked as @MappedSuperclass or null if: - none exists - or the first persistent superclass found is an @Entity

Returns:MappedSuperclass

the super MappedSuperclass

getSuperPersistentClassback to summary
public PersistentClass getSuperPersistentClass()

Returns the PersistentClass of the first superclass marked as @Entity or null if none exists

Returns:PersistentClass

the PersistentClass of the superclass

getVersionback to summary
public Property getVersion()
hasIdentifierPropertyback to summary
public boolean hasIdentifierProperty()
hasPropertyback to summary
public boolean hasProperty(String name)

Check to see if this MappedSuperclass defines a property with the given name.

Parameters
name:String

The property name to check

Returns:boolean

true if a property with that name exists; false if not

Annotations
@SuppressWarnings:WeakerAccess
isPropertyDefinedInHierarchyback to summary
public boolean isPropertyDefinedInHierarchy(String name)

Check to see if a property with the given name exists in this MappedSuperclass or in any of its super hierarchy.

Parameters
name:String

The property name to check

Returns:boolean

true if a property with that name exists; false if not

Annotations
@SuppressWarnings:WeakerAccess, RedundantIfStatement
isVersionedback to summary
public boolean isVersioned()
setDeclaredIdentifierMapperback to summary
public void setDeclaredIdentifierMapper(Component identifierMapper)
setDeclaredIdentifierPropertyback to summary
public void setDeclaredIdentifierProperty(Property prop)
setDeclaredVersionback to summary
public void setDeclaredVersion(Property prop)
setMappedClassback to summary
public void setMappedClass(Class<T> mappedClass)