Class FieldDescriptorJDONature
java.lang.Object
org.castor.core.nature.BaseNature
org.exolab.castor.jdo.engine.nature.FieldDescriptorJDONature
- All Implemented Interfaces:
Nature
JDO-specific nature for
Augments
To access persistence-specific data of a
FieldDescriptor
.Augments
FieldDescriptor
to include persistence-specific data such as
e.g. the column names, types and other SQL-related information.To access persistence-specific data of a
FieldDescriptor
, use the
following code fragment to ...
- check for this nature
- apply this nature to the
FieldDescriptor
in question. - access e.g. the column name.
FieldDescriptor fieldDescriptor = ...; ... if (fieldDescriptor.hasNature(FieldDescriptorJDONature.class.getName()) { 1) FieldDescriptorJDONature nature = new FieldDescriptorJDONature(fieldDescriptor); 2) ... String columnName = nature.getColumnName; 3) }
- Since:
- 1.2.1
- Author:
- Werner Guttmann
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the cascading types for the given field.Returns the convertor from the field type to an external type.getId()
Returns the fully qualified name of the Nature.String[]
Returns the SQL many key of the field.Returns the SQL many table of the field.String[]
Returns the SQL (column) name of the field.int[]
Returns the SQL type of this field.boolean
Returns true if dirty checking is required for this field.boolean
Returns true if field access is read only.boolean
Returns true if transient is set for this field.void
setCascading
(String cascading) Sets the cascading values for the given field.void
setDirtyCheck
(boolean dirtyCheck) Sets whether dirty checking is required for this field.void
setManyKey
(String[] manyKey) Sets the SQL many key of the field.void
setManyTable
(String manyTable) Sets the SQL many table of the field.void
setReadOnly
(boolean readOnly) Sets whether field access if read-only.void
setSQLName
(String[] sqlName) Sets the SQL (column) name of the field.void
setSQLType
(int[] sqlType) Sets the SQL type of this field.void
setTransient
(boolean isTransient) Sets whether this field should be transient.void
setTypeConvertor
(TypeConvertor typeConvertor) Sets theTypeConvertor
used for converting from field types to external types.Methods inherited from class org.castor.core.nature.BaseNature
getBooleanPropertyDefaultFalse, getHolder, getProperty, getPropertyAsList, getPropertyAsMap, setProperty
-
Constructor Details
-
FieldDescriptorJDONature
Creates an instance ofFieldDescriptorJDONature
.- Parameters:
holder
- ThePropertyHolder
to 'view upon'.
-
-
Method Details
-
getId
Returns the fully qualified name of the Nature.- Returns:
- qualified name of the nature.
- See Also:
-
getSQLName
Returns the SQL (column) name of the field.- Returns:
- The SQL (column) name.
-
setSQLName
Sets the SQL (column) name of the field.- Parameters:
sqlName
- The SQL (column) name.
-
getManyKey
Returns the SQL many key of the field.- Returns:
- The SQL many key.
-
setManyKey
Sets the SQL many key of the field.- Parameters:
manyKey
- The SQL (many key.
-
getManyTable
Returns the SQL many table of the field.- Returns:
- The SQL many table.
-
setManyTable
Sets the SQL many table of the field.- Parameters:
manyTable
- The SQL many table.
-
isReadonly
public boolean isReadonly()Returns true if field access is read only.- Returns:
- True if field access is read-only.
-
setReadOnly
public void setReadOnly(boolean readOnly) Sets whether field access if read-only.- Parameters:
readOnly
- True if field access is read-only.
-
isDirtyCheck
public boolean isDirtyCheck()Returns true if dirty checking is required for this field.- Returns:
- True if dirty checking required
-
setDirtyCheck
public void setDirtyCheck(boolean dirtyCheck) Sets whether dirty checking is required for this field.- Parameters:
dirtyCheck
- True if dirty checking is required for this field.
-
getConvertor
Returns the convertor from the field type to an external type.- Returns:
- Convertor from field type
-
setTypeConvertor
Sets theTypeConvertor
used for converting from field types to external types.- Parameters:
typeConvertor
-TypeConvertor
to be used.
-
getSQLType
public int[] getSQLType()Returns the SQL type of this field.- Returns:
- The SQL type of this field
-
setSQLType
public void setSQLType(int[] sqlType) Sets the SQL type of this field.- Parameters:
sqlType
- The SQL type of this field.
-
isTransient
public boolean isTransient()Returns true if transient is set for this field.- Returns:
- True if this field should be transient.
-
setTransient
public void setTransient(boolean isTransient) Sets whether this field should be transient.- Parameters:
lazy
- True if this field should be transient.
-
getCascading
Returns the cascading types for the given field.- Returns:
- The cascading values.
-
setCascading
Sets the cascading values for the given field.- Parameters:
cascading
- The cascading values to be set.
-