Package org.hibernate.mapping

Class Component

java.lang.Object

org.hibernate.mapping.SimpleValue

org.hibernate.mapping.Component

All Implemented Interfaces:

Serializable, KeyValue, MetaAttributable, SortableValue, Value

public class Component
extends SimpleValue
implements MetaAttributable, SortableValue

A mapping model object that represents an embeddable class.

See Also:

• Serialized Form

API Note:

The name of this class is historical and unfortunate. It reflects modeling a *composition* of state. It has absolutely nothing to do with modularity in software engineering.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Component.StandardGenerationContextLocator
static class	Component.ValueGenerationPlan

Nested classes/interfaces inherited from interface org.hibernate.mapping.KeyValue

KeyValue.NullValueSemantic

Field Summary

Fields inherited from class org.hibernate.mapping.SimpleValue

DEFAULT_ID_GEN_STRATEGY

Constructor Summary

Constructors

Constructor	Description
Component(MetadataBuildingContext metadata, Collection collection)
Component(MetadataBuildingContext metadata, Component component)
Component(MetadataBuildingContext metadata, Join join)
Component(MetadataBuildingContext metadata, PersistentClass owner)
Component(MetadataBuildingContext metadata, Table table, PersistentClass owner)

Method Summary

Modifier and Type	Method	Description
Object	accept(ValueVisitor visitor)
void	addColumn(Column column)
void	addProperty(Property p)
void	addProperty(Property p, org.hibernate.models.spi.ClassDetails declaringClass)
void	checkColumnDuplication(Set<String> distinctColumns, String owner)	Checks if this value contains any duplicate column.
void	clearProperties()
Component	copy()
Generator	createGenerator(Dialect dialect, RootClass rootClass, Property property, GeneratorSettings defaults)
AggregateColumn	getAggregateColumn()
List<Column>	getAggregatedColumns()
boolean[]	getColumnInsertability()
String	getColumnNamingPattern()	Column naming pattern applied to the component
List<Column>	getColumns()	If the mapping involves only columns, return them.
int	getColumnSpan()	The number of columns and formulas in the mapping.
boolean[]	getColumnUpdateability()
Class<?>	getComponentClass()
String	getComponentClassName()
Class<? extends EmbeddableInstantiator>	getCustomInstantiator()
Value	getDiscriminator()
DiscriminatorType<?>	getDiscriminatorType()
Map<Object,String>	getDiscriminatorValues()
Constructor<?>	getInstantiator()
String[]	getInstantiatorPropertyNames()
MappedSuperclass	getMappedSuperclass()
MetaAttribute	getMetaAttribute(String attributeName)
Map<String,MetaAttribute>	getMetaAttributes()
PersistentClass	getOwner()
AggregateColumn	getParentAggregateColumn()
String	getParentProperty()
List<Property>	getProperties()
Property	getProperty(int index)	Returns the Property at the specified position in this Component.
Property	getProperty(String propertyName)
String	getPropertyDeclaringClass(Property p)
String[]	getPropertyNames()
int	getPropertySpan()
String	getRoleName()
List<Selectable>	getSelectables()	The mapping to columns and formulas.
String[]	getStructColumnNames()
QualifiedName	getStructName()
String	getSuperclass(String subclass)
CompositeType	getType()
boolean	hasAnyInsertableColumns()
boolean	hasAnyUpdatableColumns()
boolean	hasProperty(String propertyName)
boolean	isDynamic()
boolean	isEmbedded()
boolean	isGeneric()
boolean	isKey()
boolean	isPolymorphic()
boolean	isSame(Component other)
boolean	isSame(SimpleValue other)
boolean	isSimpleRecord()
boolean	isSorted()
boolean	isValid(MappingContext mappingContext)
boolean	matchesAllProperties(String... propertyNames)
void	prepareForMappingModel()
void	setAggregateColumn(AggregateColumn aggregateColumn)
void	setColumnNamingPattern(String columnNamingPattern)	Apply a column naming pattern.
void	setComponentClassName(String componentClass)
void	setCustomInstantiator(Class<? extends EmbeddableInstantiator> customInstantiator)
void	setDiscriminator(Value discriminator)
void	setDiscriminatorValues(Map<Object,String> discriminatorValues)
void	setDynamic(boolean dynamic)
void	setEmbedded(boolean embedded)
void	setGeneric(boolean generic)
void	setInstantiator(Constructor<?> instantiator, String[] instantiatorPropertyNames)
void	setKey(boolean isKey)
void	setMappedSuperclass(MappedSuperclass mappedSuperclass)
void	setMetaAttributes(Map<String,MetaAttribute> metas)
void	setOwner(PersistentClass owner)
void	setParentAggregateColumn(AggregateColumn parentAggregateColumn)
void	setParentProperty(String parentProperty)
void	setRoleName(String roleName)
void	setSimpleRecord(boolean simpleRecord)
void	setStructColumnNames(String[] structColumnNames)
void	setStructName(QualifiedName structName)
void	setSubclassToSuperclass(Map<String,String> subclassToSuperclass)
void	setTypeUsingReflection(String className, String propertyName)
int[]	sortProperties()
String	toString()

Methods inherited from class org.hibernate.mapping.SimpleValue

addColumn, addFormula, copyTypeFrom, createForeignKey, createForeignKey, createForeignKeyOfEntity, createForeignKeyOfEntity, createGenerator, createParameterType, createUniqueKey, disableForeignKey, getAttributeConverterDescriptor, getBuildingContext, getColumn, getCustomIdGeneratorCreator, getFetchMode, getForeignKeyDefinition, getForeignKeyName, getForeignKeyOptions, getJpaAttributeConverterDescriptor, getMetadata, getNullValue, getNullValueSemantic, getOnDeleteAction, getServiceRegistry, getTable, getTypeConfiguration, getTypeName, getTypeParameters, hasFormula, isAlternateUniqueKey, isCascadeDeleteEnabled, isColumnInsertable, isColumnUpdateable, isConstrained, isForeignKeyEnabled, isLob, isNationalized, isNullable, isPartitionKey, isSame, isSame, isSimpleValue, isTypeSpecified, isUpdateable, isVersion, justAddColumn, justAddColumn, justAddFormula, makeLob, makeNationalized, makeVersion, setAlternateUniqueKey, setAttributeConverterDescriptor, setColumnToIdentity, setCustomIdGeneratorCreator, setForeignKeyDefinition, setForeignKeyName, setForeignKeyOptions, setJpaAttributeConverterDescriptor, setNullValue, setNullValueSemantic, setNullValueUndefined, setOnDeleteAction, setPartitionKey, setTable, setTypeName, setTypeParameters, setTypeParameters, sortColumns

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.mapping.Value

getConstraintColumns, getExtraCreateTableInfo, getSelectableType, getVirtualSelectables

Constructor Details

Component

public Component(MetadataBuildingContext metadata,
 PersistentClass owner)
          throws MappingException

Throws:

MappingException

Component

public Component(MetadataBuildingContext metadata,
 Component component)
          throws MappingException

Throws:

MappingException

Component

public Component(MetadataBuildingContext metadata,
 Join join)
          throws MappingException

Throws:

MappingException

Component

public Component(MetadataBuildingContext metadata,
 Collection collection)
          throws MappingException

Throws:

MappingException

Component

public Component(MetadataBuildingContext metadata,
 Table table,
 PersistentClass owner)
          throws MappingException

Throws:

MappingException

Method Details

copy

public Component copy()

Specified by:

copy in interface Value

getPropertySpan

public int getPropertySpan()

getProperties

public List<Property> getProperties()

addProperty

public void addProperty(Property p,
 org.hibernate.models.spi.ClassDetails declaringClass)

addProperty

public void addProperty(Property p)

getPropertyDeclaringClass

public String getPropertyDeclaringClass(Property p)

addColumn

public void addColumn(Column column)

Overrides:

addColumn in class SimpleValue

getSelectables

public List<Selectable> getSelectables()

Description copied from interface: Value

The mapping to columns and formulas.

Specified by:

getSelectables in interface Value

Overrides:

getSelectables in class SimpleValue

getColumns

public List<Column> getColumns()

Description copied from interface: Value

If the mapping involves only columns, return them.

Specified by:

getColumns in interface Value

Overrides:

getColumns in class SimpleValue

isEmbedded

public boolean isEmbedded()

getAggregateColumn

public AggregateColumn getAggregateColumn()

setAggregateColumn

public void setAggregateColumn(AggregateColumn aggregateColumn)

getColumnSpan

public int getColumnSpan()

Description copied from interface: Value

The number of columns and formulas in the mapping.

Specified by:

getColumnSpan in interface Value

Overrides:

getColumnSpan in class SimpleValue

getAggregatedColumns

public List<Column> getAggregatedColumns()

getParentAggregateColumn

public AggregateColumn getParentAggregateColumn()

setParentAggregateColumn

public void setParentAggregateColumn(AggregateColumn parentAggregateColumn)

getStructName

public QualifiedName getStructName()

setStructName

public void setStructName(QualifiedName structName)

checkColumnDuplication

public void checkColumnDuplication(Set<String> distinctColumns,
 String owner)

Description copied from interface: Value

Checks if this value contains any duplicate column. A column is considered duplicate when its name is already contained in the distinctColumn set.

If a duplicate column is found, a MappingException is thrown.

Specified by:

checkColumnDuplication in interface Value

Parameters:

distinctColumns - set containing the names of the columns to check

owner - the owner of this value, used just for error reporting

getComponentClassName

public String getComponentClassName()

getComponentClass

public Class<?> getComponentClass()
                           throws MappingException

Throws:

MappingException

getOwner

public PersistentClass getOwner()

getParentProperty

public String getParentProperty()

setComponentClassName

public void setComponentClassName(String componentClass)

setEmbedded

public void setEmbedded(boolean embedded)

setOwner

public void setOwner(PersistentClass owner)

setParentProperty

public void setParentProperty(String parentProperty)

isDynamic

public boolean isDynamic()

setDynamic

public void setDynamic(boolean dynamic)

getType

public CompositeType getType()
                      throws MappingException

Specified by:

getType in interface Value

Throws:

MappingException

setTypeUsingReflection

public void setTypeUsingReflection(String className,
 String propertyName)
                            throws MappingException

Specified by:

setTypeUsingReflection in interface Value

Overrides:

setTypeUsingReflection in class SimpleValue

Throws:

MappingException

getMetaAttributes

public Map<String,MetaAttribute> getMetaAttributes()

Specified by:

getMetaAttributes in interface MetaAttributable

getMetaAttribute

public MetaAttribute getMetaAttribute(String attributeName)

Specified by:

getMetaAttribute in interface MetaAttributable

setMetaAttributes

public void setMetaAttributes(Map<String,MetaAttribute> metas)

Specified by:

setMetaAttributes in interface MetaAttributable

accept

public Object accept(ValueVisitor visitor)

Specified by:

accept in interface Value

Overrides:

accept in class SimpleValue

isSame

public boolean isSame(SimpleValue other)

Overrides:

isSame in class SimpleValue

isSame

public boolean isSame(Component other)

getColumnInsertability

public boolean[] getColumnInsertability()

Specified by:

getColumnInsertability in interface Value

Overrides:

getColumnInsertability in class SimpleValue

hasAnyInsertableColumns

public boolean hasAnyInsertableColumns()

Specified by:

hasAnyInsertableColumns in interface Value

Overrides:

hasAnyInsertableColumns in class SimpleValue

getColumnUpdateability

public boolean[] getColumnUpdateability()

Specified by:

getColumnUpdateability in interface Value

Overrides:

getColumnUpdateability in class SimpleValue

hasAnyUpdatableColumns

public boolean hasAnyUpdatableColumns()

Specified by:

hasAnyUpdatableColumns in interface Value

Overrides:

hasAnyUpdatableColumns in class SimpleValue

isKey

public boolean isKey()

setKey

public void setKey(boolean isKey)

getProperty

public Property getProperty(int index)

Returns the Property at the specified position in this Component.

Parameters:

index - index of the Property to return

Returns:

Property

Throws:

IndexOutOfBoundsException - - if the index is out of range(index < 0 || index >= getPropertySpan())

getProperty

public Property getProperty(String propertyName)
                     throws MappingException

Throws:

MappingException

matchesAllProperties

public boolean matchesAllProperties(String... propertyNames)

hasProperty

public boolean hasProperty(String propertyName)

getRoleName

public String getRoleName()

setRoleName

public void setRoleName(String roleName)

getMappedSuperclass

public MappedSuperclass getMappedSuperclass()

setMappedSuperclass

public void setMappedSuperclass(MappedSuperclass mappedSuperclass)

getDiscriminator

public Value getDiscriminator()

setDiscriminator

public void setDiscriminator(Value discriminator)

getDiscriminatorType

public DiscriminatorType<?> getDiscriminatorType()

isPolymorphic

public boolean isPolymorphic()

getDiscriminatorValues

public Map<Object,String> getDiscriminatorValues()

setDiscriminatorValues

public void setDiscriminatorValues(Map<Object,String> discriminatorValues)

getSuperclass

public String getSuperclass(String subclass)

setSubclassToSuperclass

public void setSubclassToSuperclass(Map<String,String> subclassToSuperclass)

toString

public String toString()

Overrides:

toString in class SimpleValue

createGenerator

public Generator createGenerator(Dialect dialect,
 RootClass rootClass,
 Property property,
 GeneratorSettings defaults)

Specified by:

createGenerator in interface KeyValue

Overrides:

createGenerator in class SimpleValue

getPropertyNames

@Internal
public String[] getPropertyNames()

clearProperties

public void clearProperties()

setColumnNamingPattern

public void setColumnNamingPattern(String columnNamingPattern)

Apply a column naming pattern.

See Also:

• EmbeddedColumnNaming

getColumnNamingPattern

public String getColumnNamingPattern()

Column naming pattern applied to the component

See Also:

• EmbeddedColumnNaming

prepareForMappingModel

public void prepareForMappingModel()

isValid

public boolean isValid(MappingContext mappingContext)
                throws MappingException

Specified by:

isValid in interface Value

Overrides:

isValid in class SimpleValue

Throws:

MappingException

isSorted

public boolean isSorted()

Specified by:

isSorted in interface SortableValue

sortProperties

public int[] sortProperties()

Specified by:

sortProperties in interface SortableValue

setSimpleRecord

public void setSimpleRecord(boolean simpleRecord)

isSimpleRecord

public boolean isSimpleRecord()

getCustomInstantiator

public Class<? extends EmbeddableInstantiator> getCustomInstantiator()

setCustomInstantiator

public void setCustomInstantiator(Class<? extends EmbeddableInstantiator> customInstantiator)

getInstantiator

public Constructor<?> getInstantiator()

getInstantiatorPropertyNames

public String[] getInstantiatorPropertyNames()

setInstantiator

public void setInstantiator(Constructor<?> instantiator,
 String[] instantiatorPropertyNames)

getStructColumnNames

public String[] getStructColumnNames()

setStructColumnNames

public void setStructColumnNames(String[] structColumnNames)

isGeneric

public boolean isGeneric()

setGeneric

public void setGeneric(boolean generic)