org.hibernate.mapping

Class Component

java.lang.Object

org.hibernate.mapping.SimpleValue

org.hibernate.mapping.Component

All Implemented Interfaces:

Serializable, KeyValue, MetaAttributable, Value

public class Component
extends SimpleValue
implements MetaAttributable

The mapping for a component, composite element, composite identifier, etc.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.hibernate.mapping.SimpleValue

DEFAULT_ID_GEN_STRATEGY

Constructor Summary

Constructors

Constructor and 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 and Description
Object	accept(ValueVisitor visitor)
void	addColumn(Column column)
void	addProperty(Property p)
void	addTuplizer(EntityMode entityMode, String implClassName)
IdentifierGenerator	createIdentifierGenerator(IdentifierGeneratorFactory identifierGeneratorFactory, Dialect dialect, String defaultCatalog, String defaultSchema, RootClass rootClass)
boolean[]	getColumnInsertability()
Iterator<Selectable>	getColumnIterator()
int	getColumnSpan()
boolean[]	getColumnUpdateability()
Class	getComponentClass()
String	getComponentClassName()
MetaAttribute	getMetaAttribute(String attributeName)
Map	getMetaAttributes()
PersistentClass	getOwner()
String	getParentProperty()
Property	getProperty(int index) Returns the Property at the specified position in this Component.
Property	getProperty(String propertyName)
Iterator<Property>	getPropertyIterator()
int	getPropertySpan()
String	getRoleName()
List<Selectable>	getSelectables()
String	getTuplizerImplClassName(EntityMode mode)
Map	getTuplizerMap()
Type	getType()
boolean	hasAnyInsertableColumns()
boolean	hasAnyUpdatableColumns()
boolean	hasPojoRepresentation()
boolean	isDynamic()
boolean	isEmbedded()
boolean	isKey()
boolean	isSame(Component other)
boolean	isSame(SimpleValue other)
void	prepareForMappingModel()
void	setComponentClassName(String componentClass)
void	setDynamic(boolean dynamic)
void	setEmbedded(boolean embedded)
void	setKey(boolean isKey)
void	setMetaAttributes(Map metas)
void	setOwner(PersistentClass owner)
void	setParentProperty(String parentProperty)
void	setRoleName(String roleName)
void	setTypeUsingReflection(String className, String propertyName)
void	sortProperties()
String	toString()

Methods inherited from class org.hibernate.mapping.SimpleValue

addColumn, addFormula, copyTypeFrom, createForeignKey, createForeignKeyOfEntity, getAttributeConverterDescriptor, getBuildingContext, getColumn, getConstraintColumns, getFetchMode, getForeignKeyDefinition, getForeignKeyName, getIdentifierGenerator, getIdentifierGeneratorProperties, getIdentifierGeneratorStrategy, getJpaAttributeConverterDescriptor, getMetadata, getNullValue, getServiceRegistry, getTable, getTypeName, getTypeParameters, hasFormula, isAlternateUniqueKey, isCascadeDeleteEnabled, isIdentityColumn, isLob, isNationalized, isNullable, isSame, isSame, isSimpleValue, isTypeSpecified, isUpdateable, isValid, isVersion, justAddColumn, justAddColumn, justAddFormula, makeLob, makeNationalized, makeVersion, setAlternateUniqueKey, setAttributeConverterDescriptor, setCascadeDeleteEnabled, setForeignKeyDefinition, setForeignKeyName, setIdentifierGeneratorProperties, setIdentifierGeneratorProperties, setIdentifierGeneratorStrategy, setJpaAttributeConverterDescriptor, setNullValue, setTable, setTypeName, setTypeParameters, setTypeParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

getPropertySpan

public int getPropertySpan()

getPropertyIterator

public Iterator<Property> getPropertyIterator()

addProperty

public void addProperty(Property p)

addColumn

public void addColumn(Column column)

Overrides:

addColumn in class SimpleValue

getColumnSpan

public int getColumnSpan()

Specified by:

getColumnSpan in interface Value

Overrides:

getColumnSpan in class SimpleValue

getColumnIterator

public Iterator<Selectable> getColumnIterator()

Specified by:

getColumnIterator in interface Value

Overrides:

getColumnIterator in class SimpleValue

getSelectables

public List<Selectable> getSelectables()

Specified by:

getSelectables in interface Value

Overrides:

getSelectables in class SimpleValue

isEmbedded

public boolean isEmbedded()

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 Type 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 getMetaAttributes()

Specified by:

getMetaAttributes in interface MetaAttributable

getMetaAttribute

public MetaAttribute getMetaAttribute(String attributeName)

Specified by:

getMetaAttribute in interface MetaAttributable

setMetaAttributes

public void setMetaAttributes(Map 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)

hasPojoRepresentation

public boolean hasPojoRepresentation()

addTuplizer

public void addTuplizer(EntityMode entityMode,
                        String implClassName)

getTuplizerImplClassName

public String getTuplizerImplClassName(EntityMode mode)

getTuplizerMap

public Map getTuplizerMap()

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

getRoleName

public String getRoleName()

setRoleName

public void setRoleName(String roleName)

toString

public String toString()

Overrides:

toString in class SimpleValue

createIdentifierGenerator

public IdentifierGenerator createIdentifierGenerator(IdentifierGeneratorFactory identifierGeneratorFactory,
                                                     Dialect dialect,
                                                     String defaultCatalog,
                                                     String defaultSchema,
                                                     RootClass rootClass)
                                              throws MappingException

Specified by:

createIdentifierGenerator in interface KeyValue

Overrides:

createIdentifierGenerator in class SimpleValue

Throws:

MappingException

prepareForMappingModel

public void prepareForMappingModel()

sortProperties

public void sortProperties()