Top Description Inners Fields Constructors Methods
org.hibernate.mapping

public Class Component

extends SimpleValue
implements MetaAttributable, SortableValue
Class Inheritance
All Implemented Interfaces
org.hibernate.mapping.SortableValue, org.hibernate.mapping.MetaAttributable
Imports
java.lang.reflect.Constructor, java.util.ArrayList, .Comparator, .HashMap, .HashSet, .Iterator, .List, .Map, .Objects, .Set, org.hibernate.Internal, .MappingException, .Remove, org.hibernate.boot.model.relational.Database, .ExportableProducer, .SqlStringGenerationContext, org.hibernate.boot.model.source.internal.hbm.MappingDocument, org.hibernate.boot.registry.classloading.spi.ClassLoaderService, .ClassLoadingException, org.hibernate.boot.spi.BootstrapContext, .MetadataBuildingContext, org.hibernate.dialect.Dialect, org.hibernate.engine.spi.Mapping, .SharedSessionContractImplementor, org.hibernate.id.CompositeNestedGeneratedValueGenerator, .IdentifierGenerationException, .IdentifierGenerator, org.hibernate.id.factory.IdentifierGeneratorFactory, org.hibernate.internal.util.ReflectHelper, org.hibernate.internal.util.collections.ArrayHelper, .CollectionHelper, org.hibernate.metamodel.spi.EmbeddableInstantiator, org.hibernate.property.access.spi.Setter, org.hibernate.generator.Generator, .BeforeExecutionGenerator, org.hibernate.resource.beans.internal.FallbackBeanInstanceProducer, org.hibernate.resource.beans.spi.ManagedBeanRegistry, org.hibernate.type.ComponentType, .CompositeType, .EmbeddedComponentType, .UserComponentType, org.hibernate.usertype.CompositeUserType
A mapping model object that represents an embeddable class.

API Note

The name of this class is historical and unfortunate. An embeddable class holds a "component" of the state of an entity. It has absolutely nothing to do with modularity in software engineering.

Authors
Gavin King, Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Component.StandardGenerationContextLocator

public static class
Component.ValueGenerationPlan

Field Summary

Modifier and TypeField and Description
private AggregateColumn
aggregateColumn

private transient Generator
builtIdentifierGenerator

private transient List<Column>
cachedColumns

private transient List<Selectable>
cachedSelectables

private String
componentClassName

private Class<? extends EmbeddableInstantiator>
customInstantiator

private boolean
dynamic

private boolean
embedded

private Constructor<?>
instantiator

private String[]
instantiatorPropertyNames

private Boolean
isGeneric

private boolean
isKey

private Map<String, MetaAttribute>
metaAttributes

private int[]
originalPropertyOrder

private PersistentClass
owner

private AggregateColumn
parentAggregateColumn

private String
parentProperty

private final ArrayList<Property>
properties

private String
roleName

private String[]
structColumnNames

private String
structName

private volatile CompositeType
type

Hides org.hibernate.mapping.SimpleValue.type.

Inherited from org.hibernate.mapping.SimpleValue:
DEFAULT_ID_GEN_STRATEGY

Constructor Summary

AccessConstructor and Description
public
Component(MetadataBuildingContext metadata, PersistentClass owner)

public
Component(MetadataBuildingContext metadata, Component component)

public
Component(MetadataBuildingContext metadata, Join join)

public
Component(MetadataBuildingContext metadata, Collection collection)

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

private
Component(Component original)

Method Summary

Modifier and TypeMethod and Description
public Object
accept(ValueVisitor visitor)

Overrides org.hibernate.mapping.SimpleValue.accept.

Implements org.hibernate.mapping.Value.accept.

public void
addColumn(Column column)

Overrides org.hibernate.mapping.SimpleValue.addColumn.

public void
addProperty(Property p)

private Generator
buildIdentifierGenerator(IdentifierGeneratorFactory identifierGeneratorFactory, Dialect dialect, RootClass rootClass)

public void
checkColumnDuplication(Set<String>
set containing the names of the columns to check
distinctColumns, String
the owner of this value, used just for error reporting
owner)

Overrides default org.hibernate.mapping.Value.checkColumnDuplication.

Checks if this value contains any duplicate column.
private void
collectAggregatedColumns(List<Column> aggregatedColumns, Component component)

public Component
copy()

Implements org.hibernate.mapping.Value.copy.

private CompositeUserType<?>
createCompositeUserType(Component component)

public Generator
createGenerator(IdentifierGeneratorFactory identifierGeneratorFactory, Dialect dialect, RootClass rootClass)

Overrides org.hibernate.mapping.SimpleValue.createGenerator.

Implements org.hibernate.mapping.KeyValue.createGenerator.

public AggregateColumn
getAggregateColumn()

public List<Column>
getAggregatedColumns()

public boolean[]
getColumnInsertability()

Overrides org.hibernate.mapping.SimpleValue.getColumnInsertability.

Implements org.hibernate.mapping.Value.getColumnInsertability.

public List<Column>
getColumns()

Overrides org.hibernate.mapping.SimpleValue.getColumns.

Implements org.hibernate.mapping.Value.getColumns.

If the mapping involves only columns, return them.
public int
getColumnSpan()

Overrides org.hibernate.mapping.SimpleValue.getColumnSpan.

Implements org.hibernate.mapping.Value.getColumnSpan.

The number of columns and formulas in the mapping.
public boolean[]
getColumnUpdateability()

Overrides org.hibernate.mapping.SimpleValue.getColumnUpdateability.

Implements org.hibernate.mapping.Value.getColumnUpdateability.

public Class<?>
getComponentClass()

public String
getComponentClassName()

public Class<? extends EmbeddableInstantiator>
getCustomInstantiator()

public Constructor<?>
getInstantiator()

public String[]
getInstantiatorPropertyNames()

public MetaAttribute
getMetaAttribute(String attributeName)

Implements org.hibernate.mapping.MetaAttributable.getMetaAttribute.

public Map<String, MetaAttribute>
getMetaAttributes()

Implements org.hibernate.mapping.MetaAttributable.getMetaAttributes.

public PersistentClass
getOwner()

public AggregateColumn
getParentAggregateColumn()

public String
getParentProperty()

public List<Property>
getProperties()

public Property

Returns:

Property
getProperty(int
index of the Property to return
index)

Returns the Property at the specified position in this Component.

public Property
getProperty(String propertyName)

public @Remove Iterator<Property>
getPropertyIterator()

Deprecated
public String[]
getPropertyNames()

public int
getPropertySpan()

public String
getRoleName()

public List<Selectable>
getSelectables()

Overrides org.hibernate.mapping.SimpleValue.getSelectables.

Implements org.hibernate.mapping.Value.getSelectables.

The mapping to columns and formulas.
public String[]
getStructColumnNames()

public String
getStructName()

public CompositeType
getType()

Implements org.hibernate.mapping.Value.getType.

public boolean
hasAnyInsertableColumns()

Overrides org.hibernate.mapping.SimpleValue.hasAnyInsertableColumns.

Implements org.hibernate.mapping.Value.hasAnyInsertableColumns.

public boolean
hasAnyUpdatableColumns()

Overrides org.hibernate.mapping.SimpleValue.hasAnyUpdatableColumns.

Implements org.hibernate.mapping.Value.hasAnyUpdatableColumns.

public boolean
hasPojoRepresentation()

public boolean
hasProperty(String propertyName)

private Setter
injector(Property property, Class<?> attributeDeclarer)

public boolean
isDynamic()

public boolean
isEmbedded()

public boolean
isGeneric()

public boolean
isKey()

public boolean
isSame(SimpleValue other)

Overrides org.hibernate.mapping.SimpleValue.isSame.

public boolean
isSame(Component other)

private boolean
isSimpleRecord()

public boolean
isSorted()

Implements org.hibernate.mapping.SortableValue.isSorted.

public boolean
isValid(Mapping mapping)

Overrides org.hibernate.mapping.SimpleValue.isValid.

Implements org.hibernate.mapping.Value.isValid.

Deprecated as a consequence of Mapping being deprecated.
public boolean
matchesAllProperties(String... propertyNames)

private void
notifyPropertiesAboutAggregateColumn(AggregateColumn aggregateColumn, Component component)

public void
prepareForMappingModel()

private void
propertiesListModified()

private Class<?>
resolveComponentClass()

public void
setAggregateColumn(AggregateColumn aggregateColumn)

public void
setComponentClassName(String componentClass)

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

public void
setDynamic(boolean dynamic)

public void
setEmbedded(boolean embedded)

public void
setGeneric(boolean generic)

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

public void
setKey(boolean isKey)

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

Implements org.hibernate.mapping.MetaAttributable.setMetaAttributes.

public void
setOwner(PersistentClass owner)

public void
setParentAggregateColumn(AggregateColumn parentAggregateColumn)

public void
setParentProperty(String parentProperty)

public void
setRoleName(String roleName)

public void
setStructColumnNames(String[] structColumnNames)

public void
setStructName(String structName)

public void
setTypeUsingReflection(String className, String propertyName)

Overrides org.hibernate.mapping.SimpleValue.setTypeUsingReflection.

Implements org.hibernate.mapping.Value.setTypeUsingReflection.

public int[]
sortProperties()

Implements org.hibernate.mapping.SortableValue.sortProperties.

private int[]
sortProperties(boolean forceRetainOriginalOrder)

public String
toString()

Overrides org.hibernate.mapping.SimpleValue.toString.

Returns a string representation of the object.
Inherited from org.hibernate.mapping.SimpleValue:
addColumnaddFormulacopyTypeFromcreateForeignKeycreateForeignKeycreateForeignKeyOfEntitycreateParameterImplcreateUniqueKeydisableForeignKeygetAttributeConverterDescriptorgetBuildingContextgetColumngetConstraintColumnIteratorgetCustomIdGeneratorCreatorgetFetchModegetForeignKeyDefinitiongetForeignKeyNamegetIdentifierGeneratorgetIdentifierGeneratorParametersgetIdentifierGeneratorPropertiesgetIdentifierGeneratorStrategygetJpaAttributeConverterDescriptorgetMetadatagetNullValuegetOnDeleteActiongetServiceRegistrygetTablegetTypeConfigurationgetTypeNamegetTypeParametershasFormulaisAlternateUniqueKeyisCascadeDeleteEnabledisColumnInsertableisColumnUpdateableisConstrainedisForeignKeyEnabledisIdentityColumnisLobisNationalizedisNullableisPartitionKeyisSameisSameisSimpleValueisTypeSpecifiedisUpdateableisVersionjustAddColumnjustAddColumnjustAddFormulamakeLobmakeNationalizedmakeParameterImplmakeVersionsetAlternateUniqueKeysetAttributeConverterDescriptorsetCascadeDeleteEnabledsetCustomIdGeneratorCreatorsetForeignKeyDefinitionsetForeignKeyNamesetIdentifierGeneratorParameterssetIdentifierGeneratorPropertiessetIdentifierGeneratorPropertiessetIdentifierGeneratorStrategysetJpaAttributeConverterDescriptorsetNullValuesetOnDeleteActionsetPartitionKeysetTablesetTypeNamesetTypeParameterssetTypeParameterssortColumns