Package org.hibernate.mapping
Interface Value
- All Superinterfaces:
Serializable
- All Known Subinterfaces:
KeyValue
- All Known Implementing Classes:
Any,Any.KeyValue,Any.MetaValue,Array,Bag,BasicValue,Collection,Component,DependantBasicValue,DependantValue,ExportableColumn.ValueImpl,IdentifierBag,IdentifierCollection,IndexedCollection,List,ManyToOne,Map,OneToMany,OneToOne,PrimitiveArray,Set,SimpleValue,ToOne
public interfaceValueextendsSerializable
A mapping model object which represents something that's persisted "by value", instead of "by reference", that is, anything with no primary key.A
Valueis essentially a HibernateType, together with zero or morecolumns. In the mapping model, aValuealways comes wrapped in something with higher-level semantics, for example, a property, a collection, or a class.
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Objectaccept(ValueVisitor visitor)default voidcheckColumnDuplication(Set<String> distinctColumns,String owner)Checks if this value contains any duplicate column.Valuecopy()voidcreateForeignKey()voidcreateUniqueKey(MetadataBuildingContext context)defaultMetadataBuildingContextgetBuildingContext()boolean[]getColumnInsertability()List<Column>getColumns()If the mapping involves only columns, return them.intgetColumnSpan()The number of columns and formulas in the mapping.boolean[]getColumnUpdateability()defaultList<Column>getConstraintColumns()Same asgetColumns()except it returns the PK for the non-owning side of a one-to-one association.defaultStringgetExtraCreateTableInfo()FetchModegetFetchMode()List<Selectable>getSelectables()The mapping to columns and formulas.defaultJdbcMappinggetSelectableType(Mapping factory, int index)ServiceRegistrygetServiceRegistry()TablegetTable()TypegetType()defaultList<Selectable>getVirtualSelectables()Same asgetSelectables()except it returns the PK for the non-owning side of a one-to-one association.booleanhasAnyInsertableColumns()booleanhasAnyUpdatableColumns()booleanhasFormula()booleanisAlternateUniqueKey()booleanisColumnInsertable(int index)booleanisColumnUpdateable(int index)booleanisNullable()booleanisSame(Value other)booleanisSimpleValue()booleanisValid(Mapping mapping)voidsetTypeUsingReflection(String className,String propertyName)
Method Detail
getColumnSpan
int getColumnSpan()
The number of columns and formulas in the mapping.
getSelectables
List<Selectable> getSelectables()
The mapping to columns and formulas.
getColumns
List<Column> getColumns()
If the mapping involves only columns, return them.- Throws:
AssertionFailure- if the mapping involves formulas
getVirtualSelectables
default List<Selectable> getVirtualSelectables()
Same asgetSelectables()except it returns the PK for the non-owning side of a one-to-one association.
getConstraintColumns
default List<Column> getConstraintColumns()
Same asgetColumns()except it returns the PK for the non-owning side of a one-to-one association.- Throws:
AssertionFailure- if the mapping involves formulas
getType
Type getType() throwsMappingException
- Throws:
MappingException
getSelectableType
@Incubatingdefault JdbcMapping getSelectableType(Mapping factory, int index) throwsMappingException
- Throws:
MappingException
getFetchMode
FetchMode getFetchMode()
getTable
Table getTable()
hasFormula
boolean hasFormula()
isAlternateUniqueKey
boolean isAlternateUniqueKey()
isNullable
boolean isNullable()
createForeignKey
void createForeignKey()
createUniqueKey
void createUniqueKey(MetadataBuildingContext context)
isSimpleValue
boolean isSimpleValue()
isValid
boolean isValid(Mapping mapping) throwsMappingException
- Throws:
MappingException
setTypeUsingReflection
void setTypeUsingReflection(String className,String propertyName) throwsMappingException
- Throws:
MappingException
accept
Object accept(ValueVisitor visitor)
isSame
boolean isSame(Value other)
getColumnInsertability
boolean[] getColumnInsertability()
hasAnyInsertableColumns
boolean hasAnyInsertableColumns()
getColumnUpdateability
boolean[] getColumnUpdateability()
hasAnyUpdatableColumns
boolean hasAnyUpdatableColumns()
getBuildingContext
@Incubatingdefault MetadataBuildingContext getBuildingContext()
getServiceRegistry
ServiceRegistry getServiceRegistry()
copy
Value copy()
isColumnInsertable
boolean isColumnInsertable(int index)
isColumnUpdateable
boolean isColumnUpdateable(int index)
getExtraCreateTableInfo
@Incubatingdefault String getExtraCreateTableInfo()
checkColumnDuplication
@Internaldefault void checkColumnDuplication(Set<String> distinctColumns,String owner)
Checks if this value contains any duplicate column. A column is considered duplicate when itsnameis already contained in thedistinctColumnset.If a duplicate column is found, a
MappingExceptionis thrown.- Parameters:
distinctColumns- set containing the names of the columns to checkowner- the owner of this value, used just for error reporting