Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.mapping.Property

Modifier and Type	Class and Description
private class	Property.PropertyGeneratorCreationContext

Modifier and Type	Field and Description
private List<CallbackDefinition>	callbackDefinitions
private String	cascade
private GeneratorCreator	generatorCreator
private boolean	insertable
private boolean	isGeneric
private boolean	lazy
private String	lazyGroup
private boolean	lob
private Map<K, V>	metaAttributes
private String	name
private boolean	naturalIdentifier
private boolean	optimisticLocked
private boolean	optional
private PersistentClass	persistentClass
private String	propertyAccessorName
private PropertyAccessStrategy	propertyAccessStrategy
private String	returnedClassName
private boolean	selectable
private boolean	updateable
private Value	value

Access	Constructor and Description
public	Property()

Method Summary

Modifier and Type	Method and Description
public void	addCallbackDefinitions(List<CallbackDefinition> callbackDefinitions)
public Property	copy()
public Generator	createGenerator(RuntimeModelCreationContext context) Deprecated as a consequence of `RuntimeModelCreationContext` being deprecated.
public String	getAccessorPropertyName(RepresentationMode mode)
public List<CallbackDefinition>	getCallbackDefinitions()
public String	getCascade()
public CascadeStyle	getCascadeStyle()
private static CascadeStyle	getCascadeStyle(String cascade)
private static CascadeStyle	getCollectionCascadeStyle(Type elementType, String cascade)
public List<Column>	getColumns() Delegates to `Value#getColumns()`.
public int	getColumnSpan()
private static CascadeStyle	getCompositeCascadeStyle(CompositeType compositeType, String cascade)
public Getter	getGetter(Class<T> clazz)
public String	getLazyGroup()
public MetaAttribute	getMetaAttribute(String attributeName) Implements org.hibernate.mapping.MetaAttributable.getMetaAttribute.
public Map<String, MetaAttribute>	getMetaAttributes() Implements org.hibernate.mapping.MetaAttributable.getMetaAttributes.
public String	getName()
public PersistentClass	getPersistentClass()
public String	getPropertyAccessorName()
public PropertyAccessStrategy	getPropertyAccessStrategy()
public PropertyAccessStrategy	getPropertyAccessStrategy(Class<T> clazz)
public String	getReturnedClassName()
public List<Selectable>	getSelectables() Delegates to `Value#getSelectables()`.
public Setter	getSetter(Class<T> clazz)
public Type	getType()
public Value	getValue()
public GeneratorCreator	getValueGeneratorCreator()
public boolean	isBackRef()
public boolean	isBasicPropertyAccessor()
public boolean	isComposite()
public boolean	isGeneric()
public boolean	isInsertable()
public boolean	isLazy() Is this property lazy in the "bytecode" sense?
public boolean	isLob()
public boolean	isNaturalIdentifier()
pack-priv boolean	isNullable() Approximate!
public boolean	isOptimisticLocked()
public boolean	isOptional()
public boolean	isPrimitive(Class<?> clazz) Deprecated for removal since 6. this method is no longer used
public boolean	isSelectable()
public boolean	Returns: True if synthetic; false otherwise. isSynthetic() Does this property represent a synthetic property?
public boolean	isUpdateable()
public boolean	isValid(Mapping mapping) Deprecated as a consequence of `Mapping` being deprecated.
public void	resetOptional(boolean optional)
public void	resetUpdateable(boolean updateable)
protected ServiceRegistry	resolveServiceRegistry()
public void	setCascade(String cascade)
public void	setGeneric(boolean generic)
public void	setInsertable(boolean insertable)
public void	setLazy(boolean lazy)
public void	setLazyGroup(String lazyGroup)
public void	setLob(boolean lob)
public void	setMetaAttributes(Map<String, MetaAttribute> metas) Implements org.hibernate.mapping.MetaAttributable.setMetaAttributes.
public void	setName(String name)
public void	setNaturalIdentifier(boolean naturalIdentifier)
public void	setOptimisticLocked(boolean optimisticLocked)
public void	setOptional(boolean optional)
public void	setPersistentClass(PersistentClass persistentClass)
public void	setPropertyAccessorName(String string)
public void	setPropertyAccessStrategy(PropertyAccessStrategy propertyAccessStrategy)
public void	setReturnedClassName(String returnedClassName)
public void	setSelectable(boolean selectable)
public void	setUpdateable(boolean mutable)
public void	setValue(Value value)
public void	setValueGeneratorCreator(GeneratorCreator generator)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

callbackDefinitions	back to summary
private List<CallbackDefinition> callbackDefinitions

cascade	back to summary
private String cascade

generatorCreator	back to summary
private GeneratorCreator generatorCreator

insertable	back to summary
private boolean insertable

isGeneric	back to summary
private boolean isGeneric

lazy	back to summary
private boolean lazy

lazyGroup	back to summary
private String lazyGroup

lob	back to summary
private boolean lob

metaAttributes	back to summary
private Map<K, V> metaAttributes

name	back to summary
private String name

naturalIdentifier	back to summary
private boolean naturalIdentifier

optimisticLocked	back to summary
private boolean optimisticLocked

optional	back to summary
private boolean optional

persistentClass	back to summary
private PersistentClass persistentClass

propertyAccessorName	back to summary
private String propertyAccessorName

propertyAccessStrategy	back to summary
private PropertyAccessStrategy propertyAccessStrategy

returnedClassName	back to summary
private String returnedClassName

selectable	back to summary
private boolean selectable

updateable	back to summary
private boolean updateable

value	back to summary
private Value value

Property	back to summary
public Property()

Method Detail

addCallbackDefinitions	back to summary
public void addCallbackDefinitions(List<CallbackDefinition> callbackDefinitions)

copy	back to summary
public Property copy()

createGenerator	back to summary
public Generator createGenerator(RuntimeModelCreationContext context) Deprecated as a consequence of `RuntimeModelCreationContext` being deprecated. See corresponding docs for further information.

getAccessorPropertyName	back to summary
public String getAccessorPropertyName(RepresentationMode mode)

getCallbackDefinitions	back to summary
public List<CallbackDefinition> getCallbackDefinitions()

getCascade	back to summary
public String getCascade()

getCascadeStyle	back to summary
public CascadeStyle getCascadeStyle() throws MappingException

getCascadeStyle	back to summary
private static CascadeStyle getCascadeStyle(String cascade)

getCollectionCascadeStyle	back to summary
private static CascadeStyle getCollectionCascadeStyle(Type elementType, String cascade)

getColumns back to summary

getColumns	back to summary
public List<Column> getColumns() Delegates to `Value#getColumns()`. Exceptions AssertionFailure: if the mapping involves formulas

public List<Column> getColumns()

Delegates to Value#getColumns().

Exceptions

AssertionFailure:: if the mapping involves formulas

getColumnSpan	back to summary
public int getColumnSpan()

getCompositeCascadeStyle	back to summary
private static CascadeStyle getCompositeCascadeStyle(CompositeType compositeType, String cascade)

getGetter	back to summary
public Getter getGetter(Class<T> clazz) throws MappingException

getLazyGroup	back to summary
public String getLazyGroup()

getMetaAttribute	back to summary
public MetaAttribute getMetaAttribute(String attributeName) Implements org.hibernate.mapping.MetaAttributable.getMetaAttribute.

getMetaAttributes	back to summary
public Map<String, MetaAttribute> getMetaAttributes() Implements org.hibernate.mapping.MetaAttributable.getMetaAttributes.

getName	back to summary
public String getName()

getPersistentClass	back to summary
public PersistentClass getPersistentClass()

getPropertyAccessorName	back to summary
public String getPropertyAccessorName()

getPropertyAccessStrategy	back to summary
public PropertyAccessStrategy getPropertyAccessStrategy()

getPropertyAccessStrategy	back to summary
public PropertyAccessStrategy getPropertyAccessStrategy(Class<T> clazz) throws MappingException

getReturnedClassName	back to summary
public String getReturnedClassName()

getSelectables	back to summary
public List<Selectable> getSelectables() Delegates to `Value#getSelectables()`.

getSetter	back to summary
public Setter getSetter(Class<T> clazz) throws MappingException

getType	back to summary
public Type getType() throws MappingException

getValue	back to summary
public Value getValue()

getValueGeneratorCreator	back to summary
public GeneratorCreator getValueGeneratorCreator() Annotations @Internal

isBackRef	back to summary
public boolean isBackRef()

isBasicPropertyAccessor	back to summary
public boolean isBasicPropertyAccessor()

isComposite	back to summary
public boolean isComposite()

isGeneric	back to summary
public boolean isGeneric()

isInsertable	back to summary
public boolean isInsertable()

isLazy back to summary

public boolean isLazy()

Is this property lazy in the "bytecode" sense?

Lazy here means whether we initialize this field of the entity instance in its "base fetch group". It affects whether we list this property's columns in the SQL select for the owning entity when we load its "base fetch group". The actual value that is set varies based on the nature (basic, etc) of the property.

API Note

This method reports whether the property is considered part of the base fetch group based solely on the information in the mapping but EnhancementHelper#includeInBaseFetchGroup is also accounts for other details.

isLob	back to summary
public boolean isLob()

isNaturalIdentifier	back to summary
public boolean isNaturalIdentifier()

isNullable	back to summary
pack-priv boolean isNullable() Approximate!

isOptimisticLocked	back to summary
public boolean isOptimisticLocked()

isOptional	back to summary
public boolean isOptional()

isPrimitive	back to summary
public boolean isPrimitive(Class<?> clazz) Deprecated for removal since 6. this method is no longer used Annotations @Deprecated since:6 forRemoval:true

isSelectable	back to summary
public boolean isSelectable()

isSynthetic

back to summary

public boolean isSynthetic()

Does this property represent a synthetic property? A synthetic property is one we create during metamodel binding to represent a collection of columns but which does not represent a property physically available on the entity.

Returns:boolean: True if synthetic; false otherwise.

isUpdateable	back to summary
public boolean isUpdateable()

isValid	back to summary
public boolean isValid(Mapping mapping) throws MappingException Deprecated as a consequence of `Mapping` being deprecated. See corresponding docs for further information.

resetOptional	back to summary
public void resetOptional(boolean optional)

resetUpdateable	back to summary
public void resetUpdateable(boolean updateable)

resolveServiceRegistry	back to summary
protected ServiceRegistry resolveServiceRegistry()

setCascade	back to summary
public void setCascade(String cascade)

setGeneric	back to summary
public void setGeneric(boolean generic)

setInsertable	back to summary
public void setInsertable(boolean insertable)

setLazy	back to summary
public void setLazy(boolean lazy)

setLazyGroup	back to summary
public void setLazyGroup(String lazyGroup)

setLob	back to summary
public void setLob(boolean lob)

setMetaAttributes	back to summary
public void setMetaAttributes(Map<String, MetaAttribute> metas) Implements org.hibernate.mapping.MetaAttributable.setMetaAttributes.

setName	back to summary
public void setName(String name)

setNaturalIdentifier	back to summary
public void setNaturalIdentifier(boolean naturalIdentifier)

setOptimisticLocked	back to summary
public void setOptimisticLocked(boolean optimisticLocked)

setOptional	back to summary
public void setOptional(boolean optional)

setPersistentClass	back to summary
public void setPersistentClass(PersistentClass persistentClass)

setPropertyAccessorName	back to summary
public void setPropertyAccessorName(String string)

setPropertyAccessStrategy	back to summary
public void setPropertyAccessStrategy(PropertyAccessStrategy propertyAccessStrategy)

setReturnedClassName	back to summary
public void setReturnedClassName(String returnedClassName)

setSelectable	back to summary
public void setSelectable(boolean selectable)

setUpdateable	back to summary
public void setUpdateable(boolean mutable)

setValue	back to summary
public void setValue(Value value)

setValueGeneratorCreator	back to summary
public void setValueGeneratorCreator(GeneratorCreator generator) Annotations @Internal

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object.

Modifier and Type	Method and Description
public Database	getDatabase() Implements org.hibernate.generator.GeneratorCreationContext.getDatabase.
public String	getDefaultCatalog() Implements org.hibernate.generator.GeneratorCreationContext.getDefaultCatalog.
public String	getDefaultSchema() Implements org.hibernate.generator.GeneratorCreationContext.getDefaultSchema.
public PersistentClass	getPersistentClass() Implements org.hibernate.generator.GeneratorCreationContext.getPersistentClass.
public Property	getProperty() Implements org.hibernate.generator.GeneratorCreationContext.getProperty.
public ServiceRegistry	getServiceRegistry() Implements org.hibernate.generator.GeneratorCreationContext.getServiceRegistry.

public Class Property

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Property.PropertyGeneratorCreationContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail