Package org.hibernate.mapping

Class SimpleValue

java.lang.Object

org.hibernate.mapping.SimpleValue

All Implemented Interfaces:

Serializable, KeyValue, Value

Direct Known Subclasses:

Any, Any.KeyValue, Any.MetaValue, BasicValue, Component, DependantValue, ToOne

public abstract class SimpleValue
extends Object
implements KeyValue

A mapping model object that represents any value that maps to columns.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_ID_GEN_STRATEGY

Constructor Summary

Constructors

Modifier	Constructor	Description
	SimpleValue(MetadataBuildingContext buildingContext)
	SimpleValue(MetadataBuildingContext buildingContext, Table table)
protected	SimpleValue(SimpleValue original)

Method Summary

Modifier and Type	Method	Description
Object	accept(ValueVisitor visitor)
void	addColumn(Column column)
void	addColumn(Column column, boolean isInsertable, boolean isUpdatable)
void	addFormula(Formula formula)
void	copyTypeFrom(SimpleValue sourceValue)
void	createForeignKey()
void	createForeignKey(PersistentClass referencedEntity, AnnotatedJoinColumns joinColumns)
ForeignKey	createForeignKeyOfEntity(String entityName)
Generator	createGenerator(IdentifierGeneratorFactory identifierGeneratorFactory, Dialect dialect, RootClass rootClass)
protected void	createParameterImpl()
void	createUniqueKey()
void	disableForeignKey()
protected ConverterDescriptor	getAttributeConverterDescriptor()
MetadataBuildingContext	getBuildingContext()
protected Selectable	getColumn(int position)
boolean[]	getColumnInsertability()
List<Column>	getColumns()	If the mapping involves only columns, return them.
int	getColumnSpan()	The number of columns and formulas in the mapping.
boolean[]	getColumnUpdateability()
Iterator<Selectable>	getConstraintColumnIterator()	Deprecated, for removal: This API element is subject to removal in a future version. Use getSelectables() instead
IdentifierGeneratorCreator	getCustomIdGeneratorCreator()
FetchMode	getFetchMode()
String	getForeignKeyDefinition()
String	getForeignKeyName()
IdentifierGenerator	getIdentifierGenerator()	Deprecated. not used and no longer supported.
Map<String,Object>	getIdentifierGeneratorParameters()
@Remove Properties	getIdentifierGeneratorProperties()	Deprecated. use getIdentifierGeneratorParameters()
String	getIdentifierGeneratorStrategy()	Returns the identifierGeneratorStrategy.
ConverterDescriptor	getJpaAttributeConverterDescriptor()
MetadataImplementor	getMetadata()
String	getNullValue()
OnDeleteAction	getOnDeleteAction()
List<Selectable>	getSelectables()	The mapping to columns and formulas.
ServiceRegistry	getServiceRegistry()
Table	getTable()
TypeConfiguration	getTypeConfiguration()
String	getTypeName()
Properties	getTypeParameters()
boolean	hasAnyInsertableColumns()
boolean	hasAnyUpdatableColumns()
boolean	hasFormula()
boolean	isAlternateUniqueKey()
boolean	isCascadeDeleteEnabled()	Deprecated. use getOnDeleteAction()
boolean	isColumnInsertable(int index)
boolean	isColumnUpdateable(int index)
boolean	isConstrained()
boolean	isForeignKeyEnabled()
boolean	isIdentityColumn(IdentifierGeneratorFactory identifierGeneratorFactory, Dialect dialect)	Deprecated.
boolean	isLob()
boolean	isNationalized()
boolean	isNullable()
boolean	isPartitionKey()
boolean	isSame(SimpleValue other)
boolean	isSame(Value other)
protected static boolean	isSame(Value v1, Value v2)
boolean	isSimpleValue()
boolean	isTypeSpecified()
boolean	isUpdateable()
boolean	isValid(Mapping mapping)
boolean	isVersion()
protected void	justAddColumn(Column column)
protected void	justAddColumn(Column column, boolean insertable, boolean updatable)
protected void	justAddFormula(Formula formula)
void	makeLob()
void	makeNationalized()
DynamicParameterizedType.ParameterType	makeParameterImpl()
void	makeVersion()
void	setAlternateUniqueKey(boolean unique)
protected void	setAttributeConverterDescriptor(ConverterDescriptor descriptor)
void	setCascadeDeleteEnabled(boolean cascadeDeleteEnabled)	Deprecated. use setOnDeleteAction(OnDeleteAction)
void	setCustomIdGeneratorCreator(IdentifierGeneratorCreator customIdGeneratorCreator)
void	setForeignKeyDefinition(String foreignKeyDefinition)
void	setForeignKeyName(String foreignKeyName)
void	setIdentifierGeneratorParameters(Map<String,Object> identifierGeneratorParameters)
void	setIdentifierGeneratorProperties(Map<String,Object> identifierGeneratorProperties)	Deprecated. use setIdentifierGeneratorParameters(Map)
void	setIdentifierGeneratorProperties(Properties identifierGeneratorProperties)	Deprecated. use setIdentifierGeneratorParameters(Map)
void	setIdentifierGeneratorStrategy(String identifierGeneratorStrategy)	Sets the identifierGeneratorStrategy.
void	setJpaAttributeConverterDescriptor(ConverterDescriptor descriptor)
void	setNullValue(String nullValue)	Sets the nullValue.
void	setOnDeleteAction(OnDeleteAction onDeleteAction)
void	setPartitionKey(boolean partitionColumn)
void	setTable(Table table)
void	setTypeName(String typeName)
void	setTypeParameters(Map<String,?> parameters)
void	setTypeParameters(Properties parameterMap)
void	setTypeUsingReflection(String className, String propertyName)
void	sortColumns(int[] originalOrder)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.mapping.KeyValue

createIdentifierGenerator, createIdentifierGenerator

Methods inherited from interface org.hibernate.mapping.Value

checkColumnDuplication, copy, getConstraintColumns, getExtraCreateTableInfo, getSelectableType, getType, getVirtualSelectables

Field Detail

DEFAULT_ID_GEN_STRATEGY

public static final String DEFAULT_ID_GEN_STRATEGY

See Also:

Constant Field Values

Constructor Detail

SimpleValue

public SimpleValue(MetadataBuildingContext buildingContext)

SimpleValue

public SimpleValue(MetadataBuildingContext buildingContext,
                   Table table)

SimpleValue

protected SimpleValue(SimpleValue original)

Method Detail

getBuildingContext

public MetadataBuildingContext getBuildingContext()

Specified by:

getBuildingContext in interface Value

getMetadata

public MetadataImplementor getMetadata()

getServiceRegistry

public ServiceRegistry getServiceRegistry()

Specified by:

getServiceRegistry in interface Value

getTypeConfiguration

public TypeConfiguration getTypeConfiguration()

setOnDeleteAction

public void setOnDeleteAction(OnDeleteAction onDeleteAction)

getOnDeleteAction

public OnDeleteAction getOnDeleteAction()

isCascadeDeleteEnabled

@Deprecated(since="6.2")
public boolean isCascadeDeleteEnabled()

Deprecated.

use getOnDeleteAction()

Specified by:

isCascadeDeleteEnabled in interface KeyValue

setCascadeDeleteEnabled

@Deprecated(since="6.2")
public void setCascadeDeleteEnabled(boolean cascadeDeleteEnabled)

Deprecated.

use setOnDeleteAction(OnDeleteAction)

addColumn

public void addColumn(Column column)

addColumn

public void addColumn(Column column,
                      boolean isInsertable,
                      boolean isUpdatable)

addFormula

public void addFormula(Formula formula)

justAddColumn

protected void justAddColumn(Column column)

justAddColumn

protected void justAddColumn(Column column,
                             boolean insertable,
                             boolean updatable)

justAddFormula

protected void justAddFormula(Formula formula)

sortColumns

public void sortColumns(int[] originalOrder)

hasFormula

public boolean hasFormula()

Specified by:

hasFormula in interface Value

getColumnSpan

public int getColumnSpan()

Description copied from interface: Value

The number of columns and formulas in the mapping.

Specified by:

getColumnSpan in interface Value

getColumn

protected Selectable getColumn(int position)

getSelectables

public List<Selectable> getSelectables()

Description copied from interface: Value

The mapping to columns and formulas.

Specified by:

getSelectables in interface Value

getColumns

public List<Column> getColumns()

Description copied from interface: Value

If the mapping involves only columns, return them.

Specified by:

getColumns in interface Value

getConstraintColumnIterator

@Deprecated(forRemoval=true,
            since="6.3")
public Iterator<Selectable> getConstraintColumnIterator()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getSelectables() instead

getTypeName

public String getTypeName()

setTypeName

public void setTypeName(String typeName)

makeVersion

public void makeVersion()

isVersion

public boolean isVersion()

makeNationalized

public void makeNationalized()

isNationalized

public boolean isNationalized()

makeLob

public void makeLob()

isLob

public boolean isLob()

setTable

public void setTable(Table table)

createForeignKey

public void createForeignKey()
                      throws MappingException

Specified by:

createForeignKey in interface Value

Throws:

MappingException

createForeignKey

public void createForeignKey(PersistentClass referencedEntity,
                             AnnotatedJoinColumns joinColumns)
                      throws MappingException

Throws:

MappingException

createForeignKeyOfEntity

public ForeignKey createForeignKeyOfEntity(String entityName)

Specified by:

createForeignKeyOfEntity in interface KeyValue

createUniqueKey

public void createUniqueKey()

Specified by:

createUniqueKey in interface Value

getIdentifierGenerator

@Deprecated(since="6.0")
public IdentifierGenerator getIdentifierGenerator()

Deprecated.

not used and no longer supported.

Returns the cached IdentifierGenerator, or null if KeyValue.createIdentifierGenerator(IdentifierGeneratorFactory, Dialect, String, String, RootClass) was never completed.

setCustomIdGeneratorCreator

@Internal
public void setCustomIdGeneratorCreator(IdentifierGeneratorCreator customIdGeneratorCreator)

getCustomIdGeneratorCreator

@Internal
public IdentifierGeneratorCreator getCustomIdGeneratorCreator()

createGenerator

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

Specified by:

createGenerator in interface KeyValue

Throws:

MappingException

isUpdateable

public boolean isUpdateable()

Specified by:

isUpdateable in interface KeyValue

getFetchMode

public FetchMode getFetchMode()

Specified by:

getFetchMode in interface Value

getTable

public Table getTable()

Specified by:

getTable in interface Value

getIdentifierGeneratorStrategy

public String getIdentifierGeneratorStrategy()

Returns the identifierGeneratorStrategy.

Returns:

String

setIdentifierGeneratorStrategy

public void setIdentifierGeneratorStrategy(String identifierGeneratorStrategy)

Sets the identifierGeneratorStrategy.

Parameters:

identifierGeneratorStrategy - The identifierGeneratorStrategy to set

isIdentityColumn

@Deprecated
public boolean isIdentityColumn(IdentifierGeneratorFactory identifierGeneratorFactory,
                                Dialect dialect)

Deprecated.

Specified by:

isIdentityColumn in interface KeyValue

getIdentifierGeneratorParameters

public Map<String,Object> getIdentifierGeneratorParameters()

setIdentifierGeneratorParameters

public void setIdentifierGeneratorParameters(Map<String,Object> identifierGeneratorParameters)

getIdentifierGeneratorProperties

@Deprecated
@Remove
public @Remove Properties getIdentifierGeneratorProperties()

Deprecated.

use getIdentifierGeneratorParameters()

setIdentifierGeneratorProperties

@Deprecated
@Remove
public void setIdentifierGeneratorProperties(Properties identifierGeneratorProperties)

Deprecated.

use setIdentifierGeneratorParameters(Map)

setIdentifierGeneratorProperties

@Deprecated
@Remove
public void setIdentifierGeneratorProperties(Map<String,Object> identifierGeneratorProperties)

Deprecated.

use setIdentifierGeneratorParameters(Map)

getNullValue

public String getNullValue()

Specified by:

getNullValue in interface KeyValue

setNullValue

public void setNullValue(String nullValue)

Sets the nullValue.

Parameters:

nullValue - The nullValue to set

getForeignKeyName

public String getForeignKeyName()

setForeignKeyName

public void setForeignKeyName(String foreignKeyName)

isForeignKeyEnabled

public boolean isForeignKeyEnabled()

disableForeignKey

public void disableForeignKey()

isConstrained

public boolean isConstrained()

getForeignKeyDefinition

public String getForeignKeyDefinition()

setForeignKeyDefinition

public void setForeignKeyDefinition(String foreignKeyDefinition)

isAlternateUniqueKey

public boolean isAlternateUniqueKey()

Specified by:

isAlternateUniqueKey in interface Value

setAlternateUniqueKey

public void setAlternateUniqueKey(boolean unique)

isNullable

public boolean isNullable()

Specified by:

isNullable in interface Value

isSimpleValue

public boolean isSimpleValue()

Specified by:

isSimpleValue in interface Value

isValid

public boolean isValid(Mapping mapping)
                throws MappingException

Specified by:

isValid in interface Value

Throws:

MappingException

setAttributeConverterDescriptor

protected void setAttributeConverterDescriptor(ConverterDescriptor descriptor)

getAttributeConverterDescriptor

protected ConverterDescriptor getAttributeConverterDescriptor()

setTypeUsingReflection

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

Specified by:

setTypeUsingReflection in interface Value

Throws:

MappingException

isTypeSpecified

public boolean isTypeSpecified()

setTypeParameters

public void setTypeParameters(Properties parameterMap)

setTypeParameters

public void setTypeParameters(Map<String,?> parameters)

getTypeParameters

public Properties getTypeParameters()

copyTypeFrom

public void copyTypeFrom(SimpleValue sourceValue)

isSame

public boolean isSame(Value other)

Specified by:

isSame in interface Value

isSame

protected static boolean isSame(Value v1,
                                Value v2)

isSame

public boolean isSame(SimpleValue other)

toString

public String toString()

Overrides:

toString in class Object

accept

public Object accept(ValueVisitor visitor)

Specified by:

accept in interface Value

getColumnInsertability

public boolean[] getColumnInsertability()

Specified by:

getColumnInsertability in interface Value

hasAnyInsertableColumns

public boolean hasAnyInsertableColumns()

Specified by:

hasAnyInsertableColumns in interface Value

getColumnUpdateability

public boolean[] getColumnUpdateability()

Specified by:

getColumnUpdateability in interface Value

hasAnyUpdatableColumns

public boolean hasAnyUpdatableColumns()

Specified by:

hasAnyUpdatableColumns in interface Value

isColumnInsertable

public boolean isColumnInsertable(int index)

Specified by:

isColumnInsertable in interface Value

isColumnUpdateable

public boolean isColumnUpdateable(int index)

Specified by:

isColumnUpdateable in interface Value

isPartitionKey

public boolean isPartitionKey()

setPartitionKey

public void setPartitionKey(boolean partitionColumn)

getJpaAttributeConverterDescriptor

public ConverterDescriptor getJpaAttributeConverterDescriptor()

setJpaAttributeConverterDescriptor

public void setJpaAttributeConverterDescriptor(ConverterDescriptor descriptor)

createParameterImpl

protected void createParameterImpl()

makeParameterImpl

public DynamicParameterizedType.ParameterType makeParameterImpl()