Top Description Fields Constructors Methods
org.hibernate.mapping

public Class MappedSuperclass

extends Object
implements IdentifiableTypeClass
Class Inheritance
All Implemented Interfaces
org.hibernate.mapping.IdentifiableTypeClass, org.hibernate.mapping.TableContainer
Imports
java.util.ArrayList, .Comparator, .Iterator, .List
A mapping model object representing a mapped superclass of an entity class. A mapped superclass is not itself an entity, but it may declare persistent attributes which are inherited by entity subclasses.
Author
Emmanuel Bernard

Field Summary

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

private Component
identifierMapper

private Property
identifierProperty

private final Table
implicitTable

private Class<?>
mappedClass

private final MappedSuperclass
superMappedSuperclass

private final PersistentClass
superPersistentClass

private Property
version

Constructor Summary

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

Method Summary

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

public void
applyProperty(Property property)

Implements org.hibernate.mapping.IdentifiableTypeClass.applyProperty.

public Join
findSecondaryTable(String name)

Implements org.hibernate.mapping.TableContainer.findSecondaryTable.

public Table
findTable(String name)

Implements org.hibernate.mapping.TableContainer.findTable.

public Component
getDeclaredIdentifierMapper()

public Property
getDeclaredIdentifierProperty()

public List<Property>
getDeclaredProperties()

Implements org.hibernate.mapping.IdentifiableTypeClass.getDeclaredProperties.

public Property
getDeclaredVersion()

public Component
getIdentifierMapper()

public Property
getIdentifierProperty()

public Table
getImplicitTable()

Implements org.hibernate.mapping.IdentifiableTypeClass.getImplicitTable.

public Class<?>
getMappedClass()

public Join
getSecondaryTable(String name)

Implements org.hibernate.mapping.TableContainer.getSecondaryTable.

public List<IdentifiableTypeClass>
getSubTypes()

Implements org.hibernate.mapping.IdentifiableTypeClass.getSubTypes.

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 IdentifiableTypeClass
getSuperType()

Implements org.hibernate.mapping.IdentifiableTypeClass.getSuperType.

public Table
getTable(String name)

Implements org.hibernate.mapping.TableContainer.getTable.

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
prepareForMappingModel()

public void
setDeclaredIdentifierMapper(Component identifierMapper)

public void
setDeclaredIdentifierProperty(Property prop)

public void
setDeclaredVersion(Property prop)

public void
setMappedClass(Class<?> mappedClass)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

declaredPropertiesback to summary
private final List<Property> declaredProperties
identifierMapperback to summary
private Component identifierMapper
identifierPropertyback to summary
private Property identifierProperty
implicitTableback to summary
private final Table implicitTable
mappedClassback to summary
private Class<?> 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, Table implicitTable)

Method Detail

addDeclaredPropertyback to summary
public void addDeclaredProperty(Property p)
applyPropertyback to summary
public void applyProperty(Property property)

Implements org.hibernate.mapping.IdentifiableTypeClass.applyProperty.

Annotations
@Override
findSecondaryTableback to summary
public Join findSecondaryTable(String name)

Implements org.hibernate.mapping.TableContainer.findSecondaryTable.

Annotations
@Override
findTableback to summary
public Table findTable(String name)

Implements org.hibernate.mapping.TableContainer.findTable.

Annotations
@Override
getDeclaredIdentifierMapperback to summary
public Component getDeclaredIdentifierMapper()
getDeclaredIdentifierPropertyback to summary
public Property getDeclaredIdentifierProperty()
getDeclaredPropertiesback to summary
public List<Property> getDeclaredProperties()

Implements org.hibernate.mapping.IdentifiableTypeClass.getDeclaredProperties.

getDeclaredVersionback to summary
public Property getDeclaredVersion()
getIdentifierMapperback to summary
public Component getIdentifierMapper()
getIdentifierPropertyback to summary
public Property getIdentifierProperty()
getImplicitTableback to summary
public Table getImplicitTable()

Implements org.hibernate.mapping.IdentifiableTypeClass.getImplicitTable.

Annotations
@Override
getMappedClassback to summary
public Class<?> getMappedClass()
getSecondaryTableback to summary
public Join getSecondaryTable(String name)

Implements org.hibernate.mapping.TableContainer.getSecondaryTable.

Annotations
@Override
getSubTypesback to summary
public List<IdentifiableTypeClass> getSubTypes()

Implements org.hibernate.mapping.IdentifiableTypeClass.getSubTypes.

Annotations
@Override
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

getSuperTypeback to summary
public IdentifiableTypeClass getSuperType()

Implements org.hibernate.mapping.IdentifiableTypeClass.getSuperType.

Annotations
@Override
getTableback to summary
public Table getTable(String name)

Implements org.hibernate.mapping.TableContainer.getTable.

Annotations
@Override
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

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

isVersionedback to summary
public boolean isVersioned()
prepareForMappingModelback to summary
public void prepareForMappingModel()
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<?> mappedClass)