|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Objectorg.castor.core.nature.BaseNature
org.castor.cpa.jpa.natures.JPAFieldNature
public class JPAFieldNature
A BaseNature extension, that gives access to information derived from
field bound JPA annotations.
PropertyHolder| Field Summary | |
|---|---|
static java.lang.String |
CASCADE_TYPES
Property Key for javax.persistence.CascadeType array of a relation. |
static java.lang.String |
LOB
Property Key for javax.persistence.Lob. |
static java.lang.String |
STRING_ENUM_TYPE
Property Key for javax.persistence.Enumerated. |
static java.lang.String |
TEMPORAL_TYPE
Property Key for javax.persistence.Temporal. |
| Constructor Summary | |
|---|---|
JPAFieldNature(PropertyHolder holder)
Instantiate a JPAFieldNature to access the given
PropertyHolder. |
|
| Method Summary | |
|---|---|
javax.persistence.FetchType |
getBasicFetch()
|
CascadeType[] |
getCascadeTypes()
|
java.lang.String |
getColumnDefinition()
Returns the 'columnDefinition' value of the @Column annotation. |
java.lang.Boolean |
getColumnInsertable()
|
java.lang.Integer |
getColumnLength()
|
java.lang.String |
getColumnName()
Returns the name of the @Column annotation. |
java.lang.Boolean |
getColumnNullable()
|
java.lang.Integer |
getColumnPrecision()
|
java.lang.Integer |
getColumnScale()
|
java.lang.String |
getColumnTable()
|
java.lang.Boolean |
getColumnUnique()
|
java.lang.Boolean |
getColumnUpdatable()
|
FieldInfo |
getFieldInfo()
Get the underlying FieldInfo (the PropertyHolder). |
java.lang.String |
getGeneratedValueGenerator()
Get the javax.persistence.GeneratedValue#generator(). |
GenerationType |
getGeneratedValueStrategy()
Get the javax.persistence.GeneratedValue#strategy(). |
java.lang.String |
getId()
|
java.lang.String |
getJoinColumnColumnDefinition()
|
java.lang.Boolean |
getJoinColumnInsertable()
|
java.lang.String |
getJoinColumnName()
|
java.lang.Boolean |
getJoinColumnNullable()
|
java.lang.String |
getJoinColumnReferencedColumnName()
|
java.lang.String |
getJoinColumnTable()
|
java.lang.Boolean |
getJoinColumnUnique()
|
java.lang.Boolean |
getJoinColumnUpdatable()
|
java.lang.String |
getJoinTableCatalog()
|
JoinColumn[] |
getJoinTableInverseJoinColumns()
|
JoinColumn[] |
getJoinTableJoinColumns()
|
java.lang.String |
getJoinTableName()
|
java.lang.String |
getJoinTableSchema()
|
java.lang.Class<?> |
getRelationCollectionType()
|
java.lang.String |
getRelationMappedBy()
|
java.lang.Class<?> |
getRelationTargetEntity()
|
TemporalType |
getTemporalType()
|
boolean |
isBasicOptional()
|
boolean |
isId()
|
boolean |
isLob()
|
boolean |
isManyToMany()
|
boolean |
isManyToManyInverseCopy()
|
boolean |
isManyToOne()
|
boolean |
isOneToMany()
|
boolean |
isOneToOne()
|
boolean |
isRelationLazyFetch()
|
boolean |
isRelationOptional()
|
boolean |
isStringEnumType()
|
boolean |
isTransient()
|
void |
setBasicFetch(javax.persistence.FetchType fetch)
|
void |
setBasicOptional(boolean optional)
|
void |
setCascadeTypes(CascadeType[] cascadeTypes)
|
void |
setColumnDefinition(java.lang.String columnDefinition)
Sets the 'columnDefinition' value of the @Column annotation. |
void |
setColumnInsertable(boolean insertable)
|
void |
setColumnLength(int length)
|
void |
setColumnName(java.lang.String name)
Set the name value of the @Column annotation. |
void |
setColumnNullable(boolean nullable)
|
void |
setColumnPrecision(int precision)
|
void |
setColumnScale(int scale)
|
void |
setColumnTable(java.lang.String table)
|
void |
setColumnUnique(boolean unique)
|
void |
setColumnUpdatable(boolean updatable)
|
void |
setGeneratedValueGenerator(java.lang.String generator)
Set the javax.persistence.GeneratedValue#generator(). |
void |
setGeneratedValueStrategy(GenerationType strategy)
Set the javax.persistence.GeneratedValue#strategy(). |
void |
setId(boolean isId)
|
void |
setJoinColumnColumnDefinition(java.lang.String columnDefinition)
|
void |
setJoinColumnInsertable(boolean insertable)
|
void |
setJoinColumnName(java.lang.String name)
|
void |
setJoinColumnNullable(boolean nullable)
|
void |
setJoinColumnReferencedColumnName(java.lang.String referencedColumnName)
|
void |
setJoinColumnTable(java.lang.String table)
|
void |
setJoinColumnUnique(boolean unique)
|
void |
setJoinColumnUpdatable(boolean updatable)
|
void |
setJoinTableCatalog(java.lang.String catalog)
|
void |
setJoinTableInverseJoinColumns(JoinColumn[] inverseJoinColumns)
|
void |
setJoinTableJoinColumns(JoinColumn[] joinColumns)
|
void |
setJoinTableName(java.lang.String tablename)
|
void |
setJoinTableSchema(java.lang.String schema)
|
void |
setLob(boolean isLob)
|
void |
setManyToMany(boolean hasManyToMany)
|
void |
setManyToManyInverseCopy(boolean copySettingsInverse)
|
void |
setManyToOne(boolean hasManyToOne)
|
void |
setOneToMany(boolean hasOneToMany)
|
void |
setOneToOne(boolean hasOneToOne)
|
void |
setRelationCollectionType(java.lang.Class<?> collectionType)
|
void |
setRelationLazyFetch(boolean lazyFetch)
|
void |
setRelationMappedBy(java.lang.String mappedBy)
|
void |
setRelationOptional(boolean optional)
|
void |
setRelationTargetEntity(java.lang.Class<?> targetEntity)
|
void |
setStringEnumType(boolean isStringEnumType)
|
void |
setTemporalType(TemporalType temporalType)
|
void |
setTransient(boolean isTransient)
|
| Methods inherited from class org.castor.core.nature.BaseNature |
|---|
getBooleanPropertyDefaultFalse, getHolder, getProperty, getPropertyAsList, getPropertyAsMap, setProperty |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String TEMPORAL_TYPE
javax.persistence.Temporal.
public static final java.lang.String LOB
javax.persistence.Lob.
public static final java.lang.String STRING_ENUM_TYPE
javax.persistence.Enumerated.
public static final java.lang.String CASCADE_TYPES
javax.persistence.CascadeType array of a relation.
| Constructor Detail |
|---|
public JPAFieldNature(PropertyHolder holder)
JPAFieldNature to access the given
PropertyHolder.
holder - The underlying PropertyHolder (obviously a
FieldInfo).PropertyHolder| Method Detail |
|---|
public final java.lang.String getId()
Nature.getId()public FieldInfo getFieldInfo()
FieldInfo (the PropertyHolder).
FieldInfo. If the PropertyHolder
was not of type FieldInfo, null is returned.public final void setBasicFetch(javax.persistence.FetchType fetch)
fetch - The value of javax.persistence.Basic#fetch()BASIC_FETCHpublic final javax.persistence.FetchType getBasicFetch()
javax.persistence.Basic#fetch()BASIC_FETCHpublic final void setBasicOptional(boolean optional)
optional - The value of javax.persistence.Basic#optional()BASIC_OPTIONALpublic final boolean isBasicOptional()
javax.persistence.Basic#optional() was set to
true on the field.BASIC_OPTIONALpublic final void setColumnName(java.lang.String name)
name - The value of javax.persistence.Column#name()COLUMN_NAMEpublic final java.lang.String getColumnName()
javax.persistence.Column#name()COLUMN_NAMEpublic final void setColumnDefinition(java.lang.String columnDefinition)
columnDefinition - The value of
javax.persistence.Column#columnDefinition()COLUMN_DEFINITIONpublic final java.lang.String getColumnDefinition()
javax.persistence.Column#columnDefinition()COLUMN_DEFINITIONpublic final void setColumnLength(int length)
length - The value of javax.persistence.Column#length()COLUMN_LENGTHpublic final java.lang.Integer getColumnLength()
javax.persistence.Column#length()COLUMN_LENGTHpublic final void setColumnInsertable(boolean insertable)
insertable - The value of javax.persistence.Column#insertable()COLUMN_INSERTABLEpublic final java.lang.Boolean getColumnInsertable()
javax.persistence.Column#insertable()COLUMN_INSERTABLEpublic final void setColumnNullable(boolean nullable)
nullable - The value of javax.persistence.Column#nullable()COLUMN_NULLABLEpublic final java.lang.Boolean getColumnNullable()
javax.persistence.Column#nullable()COLUMN_NULLABLEpublic final void setColumnPrecision(int precision)
precision - The value of javax.persistence.Column#precision()COLUMN_PRECISIONpublic final java.lang.Integer getColumnPrecision()
javax.persistence.Column#precision()COLUMN_PRECISIONpublic final void setColumnScale(int scale)
scale - The value of javax.persistence.Column#scale()COLUMN_SCALEpublic final java.lang.Integer getColumnScale()
javax.persistence.Column#scale()COLUMN_SCALEpublic final void setColumnTable(java.lang.String table)
table - The value of javax.persistence.Column#table()COLUMN_TABLEpublic final java.lang.String getColumnTable()
javax.persistence.Column#table()COLUMN_TABLEpublic final void setColumnUnique(boolean unique)
unique - The value of javax.persistence.Column#unique()COLUMN_UNIQUEpublic final java.lang.Boolean getColumnUnique()
javax.persistence.Column#unique()COLUMN_UNIQUEpublic final void setColumnUpdatable(boolean updatable)
updatable - The value of javax.persistence.Column#updatable()COLUMN_UPDATABLEpublic final java.lang.Boolean getColumnUpdatable()
javax.persistence.Column#updatable()COLUMN_UPDATABLEpublic final void setId(boolean isId)
isId - If javax.persistence.Id was found on that property.IDpublic final boolean isId()
javax.persistence.Id was set on the property,
else false.IDpublic final void setTransient(boolean isTransient)
isTransient - if javax.persistence.Transient was found on that
property.TRANSIENTpublic final boolean isTransient()
javax.persistence.Transient was set on the
property, else falseTRANSIENTpublic void setJoinTableName(java.lang.String tablename)
tablename - The value of javax.persistence.JoinTable#name()JOINTABLE_NAMEpublic java.lang.String getJoinTableName()
javax.persistence.JoinTable#name()JOINTABLE_NAMEpublic void setJoinTableCatalog(java.lang.String catalog)
catalog - The value of javax.persistence.JoinTable#catalog()JOINTABLE_CATALOGpublic java.lang.String getJoinTableCatalog()
javax.persistence.JoinTable#catalog()JOINTABLE_CATALOGpublic void setJoinTableSchema(java.lang.String schema)
schema - The value of javax.persistence.JoinTable#schema()JOINTABLE_SCHEMApublic java.lang.String getJoinTableSchema()
javax.persistence.JoinTable#schema()#TABLE_SCHEMApublic void setJoinTableJoinColumns(JoinColumn[] joinColumns)
joinColumns - The value of javax.persistence.JoinTable#joinColumns()JOINTABLE_JOINCOLUMNSpublic JoinColumn[] getJoinTableJoinColumns()
javax.persistence.JoinTable#joinColumns()JOINTABLE_JOINCOLUMNSpublic void setJoinTableInverseJoinColumns(JoinColumn[] inverseJoinColumns)
inverseJoinColumns - The value of
javax.persistence.JoinTable#inverseJoinColumns()JOINTABLE_INVERSE_JOINCOLUMNSpublic JoinColumn[] getJoinTableInverseJoinColumns()
javax.persistence.JoinTable#inverseJoinColumns()JOINTABLE_INVERSE_JOINCOLUMNSpublic final void setJoinColumnName(java.lang.String name)
name - The value of javax.persistence.JoinColumn#name().JOINCOLUMN_NAMEpublic final java.lang.String getJoinColumnName()
javax.persistence.JoinColumn#name().JOINCOLUMN_NAMEpublic final void setJoinColumnReferencedColumnName(java.lang.String referencedColumnName)
referencedColumnName - The value of
javax.persistence.JoinColumn#referencedColumnName().JOINCOLUMN_REFERENCEDCOLUMNNAMEpublic final java.lang.String getJoinColumnReferencedColumnName()
javax.persistence.JoinColumn#referencedColumnName().JOINCOLUMN_REFERENCEDCOLUMNNAMEpublic final void setJoinColumnUnique(boolean unique)
unique - The value of javax.persistence.JoinColumn#unique().JOINCOLUMN_UNIQUEpublic final java.lang.Boolean getJoinColumnUnique()
javax.persistence.JoinColumn#unique().JOINCOLUMN_UNIQUEpublic final void setJoinColumnNullable(boolean nullable)
nullable - The value of javax.persistence.JoinColumn#nullable().JOINCOLUMN_NULLABLEpublic final java.lang.Boolean getJoinColumnNullable()
javax.persistence.JoinColumn#nullable().JOINCOLUMN_NULLABLEpublic final void setJoinColumnInsertable(boolean insertable)
insertable - The value of javax.persistence.JoinColumn#insertable()
.JOINCOLUMN_INSERTABLEpublic final java.lang.Boolean getJoinColumnInsertable()
javax.persistence.JoinColumn#insertable().JOINCOLUMN_INSERTABLEpublic final void setJoinColumnUpdatable(boolean updatable)
updatable - The value of javax.persistence.JoinColumn#updatable().JOINCOLUMN_UPDATABLEpublic final java.lang.Boolean getJoinColumnUpdatable()
javax.persistence.JoinColumn#updatable().JOINCOLUMN_UPDATABLEpublic final void setJoinColumnColumnDefinition(java.lang.String columnDefinition)
columnDefinition - The value of
javax.persistence.JoinColumn#columnDefinition().JOINCOLUMN_COLUMNDEFINITIONpublic final java.lang.String getJoinColumnColumnDefinition()
javax.persistence.JoinColumn#columnDefinition().JOINCOLUMN_COLUMNDEFINITIONpublic final void setJoinColumnTable(java.lang.String table)
table - The value of javax.persistence.JoinColumn#table().JOINCOLUMN_TABLEpublic final java.lang.String getJoinColumnTable()
javax.persistence.JoinColumn#table().JOINCOLUMN_TABLEpublic void setOneToOne(boolean hasOneToOne)
hasOneToOne - if javax.persistence.OneToOne was found on that
property.ONETOONEpublic boolean isOneToOne()
javax.persistence.OneToOne was set on the property,
else false.ONETOONEpublic void setManyToOne(boolean hasManyToOne)
hasManyToOne - if javax.persistence.ManyToOne was found on that
property.MANYTOONEpublic boolean isManyToOne()
javax.persistence.ManyToOne was set on the property,
else false.MANYTOONEpublic void setOneToMany(boolean hasOneToMany)
hasOneToMany - if javax.persistence.OneToMany was found on that
property.ONETOMANYpublic boolean isOneToMany()
javax.persistence.OneToMany was set on the property,
else false.ONETOMANYpublic void setManyToMany(boolean hasManyToMany)
hasManyToMany - if javax.persistence.ManyToMany was found on that
property.MANYTOMANYpublic boolean isManyToMany()
javax.persistence.ManyToOne was set on the property,
else false.MANYTOMANYpublic void setManyToManyInverseCopy(boolean copySettingsInverse)
copySettingsInverse - set this to true if a ManyToMany related field shall copy all
JoinTable relevant information from the other side of
the relation (inverting the JoinColumn settings).MANYTOMANY_INVERSECOPYpublic boolean isManyToManyInverseCopy()
JoinTable relevant information from the other side of the
relation (inverting the JoinColumn settings).MANYTOMANY_INVERSECOPYpublic void setRelationTargetEntity(java.lang.Class<?> targetEntity)
targetEntity - The value of javax.persistence.OneToOne#targetEntity()
, javax.persistence.OneToMany#targetEntity(),
javax.persistence.ManyToOne#targetEntity(),
javax.persistence.ManyToMany#targetEntity(), depending
to the relation type.RELATION_TARGETENTITYpublic java.lang.Class<?> getRelationTargetEntity()
javax.persistence.OneToOne#targetEntity(),
javax.persistence.OneToMany#targetEntity(),
javax.persistence.ManyToOne#targetEntity(),
javax.persistence.ManyToMany#targetEntity(), depending on
the relation type. Returns null iff no relational annotation was
set on the field.RELATION_TARGETENTITYpublic void setRelationLazyFetch(boolean lazyFetch)
lazyFetch - true if javax.persistence.OneToOne#fetch() ,
javax.persistence.OneToMany#fetch(),
javax.persistence.ManyToOne#fetch(),
javax.persistence.ManyToMany#fetch() is set to
javax.persistence.FetchType#LAZY, depending on the
relation type.RELATION_LAZYFETCHpublic boolean isRelationLazyFetch()
javax.persistence.OneToOne#fetch() ,
javax.persistence.OneToMany#fetch(),
javax.persistence.ManyToOne#fetch(),
javax.persistence.ManyToMany#fetch() is set to
javax.persistence.FetchType#LAZY, depending on the
relation type.RELATION_LAZYFETCHpublic void setRelationMappedBy(java.lang.String mappedBy)
mappedBy - The content of javax.persistence.OneToMany#mappedBy(),
javax.persistence.ManyToMany#mappedBy(), depending on
the relation type.RELATION_MAPPEDBYpublic java.lang.String getRelationMappedBy()
javax.persistence.OneToMany#mappedBy(),
javax.persistence.ManyToMany#mappedBy(), depending on the
relation type. If no (or an empty) String was set, null is
returned!RELATION_MAPPEDBYpublic java.lang.Class<?> getRelationCollectionType()
javax.persistence.OneToMany,
javax.persistence.ManyToMany, depending on the relation
type. Returns null iff none of the above relational annotations
was set on the field.RELATION_COLLECTIONTYPEpublic void setRelationCollectionType(java.lang.Class<?> collectionType)
collectionType - Set the type of Collection being used by
javax.persistence.OneToMany,
javax.persistence.ManyToMany, depending on the
relation type.RELATION_COLLECTIONTYPEpublic void setRelationOptional(boolean optional)
optional - Set the value of javax.persistence.OneToOne#optional()
, javax.persistence.ManyToOne#optional(), depending on
the relation type.RELATION_OPTIONALpublic boolean isRelationOptional()
javax.persistence.OneToOne#optional(),
javax.persistence.ManyToOne#optional() was set to true,
depending on the relation type.RELATION_OPTIONALpublic void setGeneratedValueStrategy(GenerationType strategy)
javax.persistence.GeneratedValue#strategy().
strategy - The primary key generation strategy that the persistence
provider must use to generate the annotated entity primary key.GENERATEDVALUE_STRATEGYpublic GenerationType getGeneratedValueStrategy()
javax.persistence.GeneratedValue#strategy().
GENERATEDVALUE_STRATEGYpublic void setGeneratedValueGenerator(java.lang.String generator)
javax.persistence.GeneratedValue#generator().
generator - The name of the primary key generator to use as specified
in the SequenceGenerator or TableGenerator annotation.GENERATEDVALUE_GENERATORpublic java.lang.String getGeneratedValueGenerator()
javax.persistence.GeneratedValue#generator().
GENERATEDVALUE_STRATEGYpublic TemporalType getTemporalType()
javax.persistence.TemporalType of field.TEMPORAL_TYPEpublic void setTemporalType(TemporalType temporalType)
temporalType - set the javax.persistence.TemporalType of field.TEMPORAL_TYPEpublic boolean isLob()
javax.persistence.Lob was set on the
property, else falseLOBpublic void setLob(boolean isLob)
isLob - if javax.persistence.Lob was found on that
property.LOBpublic boolean isStringEnumType()
javax.persistence.Enumerated with value
javax.persistence.EnumType STRING was set on the
property, else falseSTRING_ENUM_TYPEpublic void setStringEnumType(boolean isStringEnumType)
isStringEnumType - if javax.persistence.Enumerated with value
javax.persistence.EnumType STRING was found on that
property.STRING_ENUM_TYPEpublic CascadeType[] getCascadeTypes()
javax.persistence.CascadeType array of relation.CASCADE_TYPESpublic void setCascadeTypes(CascadeType[] cascadeTypes)
cascadeTypes - set the javax.persistence.CascadeType array of relation.CASCADE_TYPES
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||