Top Description Fields Constructors Methods
org.hibernate.mapping

public Class Property

extends Object
implements Serializable, MetaAttributable
Class Inheritance
All Implemented Interfaces
org.hibernate.mapping.MetaAttributable, java.io.Serializable
Known Direct Subclasses
org.hibernate.mapping.SyntheticProperty, org.hibernate.mapping.Backref, org.hibernate.mapping.IndexBackref
Imports
java.io.Serializable, java.util.Iterator, .StringTokenizer, org.hibernate.EntityMode, .MappingException, .PropertyNotFoundException, org.hibernate.engine.CascadeStyle, .Mapping, org.hibernate.property.Getter, .PropertyAccessor, .PropertyAccessorFactory, .Setter, org.hibernate.type.CompositeType, .Type, org.hibernate.util.ArrayHelper
Represents a property as part of an entity or a component.
Author
Gavin King

Field Summary

Modifier and TypeField and Description
private String
cascade

private PropertyGeneration
generation

private boolean
insertable

private boolean
lazy

private Map<K, V>
metaAttributes

private String
name

private boolean
naturalIdentifier

private String
nodeName

private boolean
optimisticLocked

private boolean
optional

private PersistentClass
persistentClass

private String
propertyAccessorName

private boolean
selectable

private boolean
updateable

private Value
value

Constructor Summary

AccessConstructor and Description
public
Property()

Method Summary

Modifier and TypeMethod and Description
public String
getAccessorPropertyName(EntityMode mode)

public String
getCascade()

public CascadeStyle
getCascadeStyle()

private static CascadeStyle
getCascadeStyle(String cascade)

private static CascadeStyle
getCollectionCascadeStyle(Type elementType, String cascade)

public Iterator<E>
getColumnIterator()

public int
getColumnSpan()

private static CascadeStyle
getCompositeCascadeStyle(CompositeType compositeType, String cascade)

public PropertyGeneration
getGeneration()

public Getter
getGetter(Class<T> clazz)

public MetaAttribute
getMetaAttribute(String attributeName)

Implements org.hibernate.mapping.MetaAttributable.getMetaAttribute.

public Map<K, V>
getMetaAttributes()

Implements org.hibernate.mapping.MetaAttributable.getMetaAttributes.

public String
getName()

public String
getNodeName()

public PersistentClass
getPersistentClass()

public PropertyAccessor
getPropertyAccessor(Class<T> clazz)

public String
getPropertyAccessorName()

public Setter
getSetter(Class<T> clazz)

public Type
getType()

public Value
getValue()

public boolean
isBackRef()

public boolean
isBasicPropertyAccessor()

public boolean
isComposite()

public boolean
isInsertable()

public boolean
isLazy()

public boolean
isNaturalIdentifier()

pack-priv boolean
isNullable()

Approximate!

public boolean
isOptimisticLocked()

public boolean
isOptional()

public boolean
isPrimitive(Class<T> clazz)

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)

public void
setCascade(String cascade)

public void
setGeneration(PropertyGeneration generation)

public void
setInsertable(boolean insertable)

public void
setLazy(boolean lazy)

public void
setMetaAttributes(Map<K, V> metas)

Implements org.hibernate.mapping.MetaAttributable.setMetaAttributes.

public void
setName(String name)

public void
setNaturalIdentifier(boolean naturalIdentifier)

public void
setNodeName(String nodeName)

public void
setOptimisticLocked(boolean optimisticLocked)

public void
setOptional(boolean optional)

public void
setPersistentClass(PersistentClass persistentClass)

public void
setPropertyAccessorName(String string)

public void
setSelectable(boolean selectable)

public void
setUpdateable(boolean mutable)

public void
setValue(Value value)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

cascadeback to summary
private String cascade
generationback to summary
private PropertyGeneration generation
insertableback to summary
private boolean insertable
lazyback to summary
private boolean lazy
metaAttributesback to summary
private Map<K, V> metaAttributes
nameback to summary
private String name
naturalIdentifierback to summary
private boolean naturalIdentifier
nodeNameback to summary
private String nodeName
optimisticLockedback to summary
private boolean optimisticLocked
optionalback to summary
private boolean optional
persistentClassback to summary
private PersistentClass persistentClass
propertyAccessorNameback to summary
private String propertyAccessorName
selectableback to summary
private boolean selectable
updateableback to summary
private boolean updateable
valueback to summary
private Value value

Constructor Detail

Propertyback to summary
public Property()

Method Detail

getAccessorPropertyNameback to summary
public String getAccessorPropertyName(EntityMode mode)
getCascadeback to summary
public String getCascade()
getCascadeStyleback to summary
public CascadeStyle getCascadeStyle() throws MappingException
getCascadeStyleback to summary
private static CascadeStyle getCascadeStyle(String cascade)
getCollectionCascadeStyleback to summary
private static CascadeStyle getCollectionCascadeStyle(Type elementType, String cascade)
getColumnIteratorback to summary
public Iterator<E> getColumnIterator()
getColumnSpanback to summary
public int getColumnSpan()
getCompositeCascadeStyleback to summary
private static CascadeStyle getCompositeCascadeStyle(CompositeType compositeType, String cascade)
getGenerationback to summary
public PropertyGeneration getGeneration()
getGetterback to summary
public Getter getGetter(Class<T> clazz) throws PropertyNotFoundException, MappingException
getMetaAttributeback to summary
public MetaAttribute getMetaAttribute(String attributeName)

Implements org.hibernate.mapping.MetaAttributable.getMetaAttribute.

getMetaAttributesback to summary
public Map<K, V> getMetaAttributes()

Implements org.hibernate.mapping.MetaAttributable.getMetaAttributes.

getNameback to summary
public String getName()
getNodeNameback to summary
public String getNodeName()
getPersistentClassback to summary
public PersistentClass getPersistentClass()
getPropertyAccessorback to summary
public PropertyAccessor getPropertyAccessor(Class<T> clazz) throws MappingException
getPropertyAccessorNameback to summary
public String getPropertyAccessorName()
getSetterback to summary
public Setter getSetter(Class<T> clazz) throws PropertyNotFoundException, MappingException
getTypeback to summary
public Type getType() throws MappingException
getValueback to summary
public Value getValue()
isBackRefback to summary
public boolean isBackRef()
isBasicPropertyAccessorback to summary
public boolean isBasicPropertyAccessor()
isCompositeback to summary
public boolean isComposite()
isInsertableback to summary
public boolean isInsertable()
isLazyback to summary
public boolean isLazy()
isNaturalIdentifierback to summary
public boolean isNaturalIdentifier()
isNullableback to summary
pack-priv boolean isNullable()

Approximate!

isOptimisticLockedback to summary
public boolean isOptimisticLocked()
isOptionalback to summary
public boolean isOptional()
isPrimitiveback to summary
public boolean isPrimitive(Class<T> clazz)
isSelectableback to summary
public boolean isSelectable()
isSyntheticback 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.

isUpdateableback to summary
public boolean isUpdateable()
isValidback to summary
public boolean isValid(Mapping mapping) throws MappingException
setCascadeback to summary
public void setCascade(String cascade)
setGenerationback to summary
public void setGeneration(PropertyGeneration generation)
setInsertableback to summary
public void setInsertable(boolean insertable)
setLazyback to summary
public void setLazy(boolean lazy)
setMetaAttributesback to summary
public void setMetaAttributes(Map<K, V> metas)

Implements org.hibernate.mapping.MetaAttributable.setMetaAttributes.

setNameback to summary
public void setName(String name)
setNaturalIdentifierback to summary
public void setNaturalIdentifier(boolean naturalIdentifier)
setNodeNameback to summary
public void setNodeName(String nodeName)
setOptimisticLockedback to summary
public void setOptimisticLocked(boolean optimisticLocked)
setOptionalback to summary
public void setOptional(boolean optional)
setPersistentClassback to summary
public void setPersistentClass(PersistentClass persistentClass)
setPropertyAccessorNameback to summary
public void setPropertyAccessorName(String string)
setSelectableback to summary
public void setSelectable(boolean selectable)
setUpdateableback to summary
public void setUpdateable(boolean mutable)
setValueback to summary
public void setValue(Value value)
toStringback 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.