public class Property extends java.lang.Object
Base class for classes returned from PropertyMapping.getMappedForm
Type Params | Return Type | Name and description |
---|---|---|
|
Property |
clone() |
|
javax.persistence.AccessType |
getAccessType() @return The default access type to use to read and write property values |
|
java.lang.String |
getCascade() Cascading strategy for this property. |
|
java.lang.String |
getEnumType() @return The type of the enum, either ordinal or string |
|
javax.persistence.EnumType |
getEnumTypeObject() @return The type of the enum, either ordinal or string |
|
javax.persistence.FetchType |
getFetchStrategy() @return The strategy to use to fetch the property (lazy or eager) |
|
java.lang.String |
getFormula() The formula used to build the property |
|
java.lang.String |
getGenerator() Get the id generator. |
|
java.util.List<java.lang.String> |
getInList() @return List of valid values |
|
java.lang.Boolean |
getLazy() |
|
java.lang.Comparable |
getMax() @return The maximum value |
|
java.lang.Number |
getMaxSize() @return The maximum size |
|
java.lang.Comparable |
getMin() @return The minimum value |
|
java.lang.Number |
getMinSize() @return The minimum size |
|
java.lang.String |
getName() @return The name of the property this property mapping relates to |
|
int |
getScale() @return The scale |
|
java.lang.String |
getTargetName() The target to map to, could be a database column, document attribute, or hash key |
|
java.util.List<java.lang.String> |
getUniquenessGroup() |
|
boolean |
isDerived() @return Whether the property is derived or not |
|
boolean |
isIndex() @return Whether this property is index |
|
boolean |
isLazy() Whether to use lazy proxies for each association. |
|
boolean |
isNullable() @return Whether the property is nullable |
|
boolean |
isReference() @return Whether this property is a database reference such as a foreign key |
|
boolean |
isUnique() @return Whether the property should be unique |
|
boolean |
isUniqueWithinGroup() @return Whether the property is unique within a group |
|
void |
setAccessType(javax.persistence.AccessType accessType) |
|
void |
setCascade(java.lang.String cascade) |
|
void |
setDerived(boolean derived) |
|
void |
setEnumType(javax.persistence.EnumType enumType) |
|
void |
setEnumType(java.lang.String enumType) |
|
void |
setFetch(java.lang.String name) Makes it easier to configure the fetch strategy |
|
void |
setFetchStrategy(javax.persistence.FetchType fetchStrategy) Sets the strategy to use to fetch the property (lazy or eager) |
|
void |
setFormula(java.lang.String formula) |
|
void |
setGenerator(java.lang.String generator) Set the id generator name or class. |
|
void |
setInList(java.util.List<java.lang.String> inList) |
|
void |
setIndex(boolean index) Whether this property is index |
|
void |
setLazy(java.lang.Boolean lazy) @param lazy Set to true if lazy proxies should be used for each element of collection types |
|
void |
setMax(java.lang.Comparable max) |
|
void |
setMaxSize(java.lang.Number maxSize) |
|
void |
setMin(java.lang.Comparable min) |
|
void |
setMinSize(java.lang.Number minSize) |
|
void |
setName(java.lang.String propertyName) |
|
void |
setNullable(boolean nullable) |
|
void |
setRange(groovy.lang.ObjectRange range) |
|
void |
setReference(boolean reference) |
|
void |
setScale(int scale) |
|
void |
setSize(groovy.lang.IntRange maxSize) |
|
void |
setTargetName(java.lang.String targetName) |
|
void |
setUnique(boolean unique) |
|
void |
setUnique(java.lang.String name) |
|
void |
setUnique(java.util.List<java.lang.String> names) |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Cascading strategy for this property. Only makes sense if the property is an association or collection.
The formula used to build the property
Get the id generator.
The target to map to, could be a database column, document attribute, or hash key
Whether to use lazy proxies for each association. This has no effect if getFetchStrategy() returns FetchType.EAGER, however if FetchType is LAZY and lazy is set to true then for collection types each element of the collection will be a proxy. If lazy is false the collection will be fetched lazily, but fully initialized objects will be loaded for each element.
Makes it easier to configure the fetch strategy
name
- The name of the fetch strategySets the strategy to use to fetch the property (lazy or eager)
fetchStrategy
- The fetch strategy to useSet the id generator name or class.
generator
- name or classWhether this property is index
index
- Sets whether to index the property or not
lazy
- Set to true if lazy proxies should be used for each element of collection types