|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.castor.core.nature.BaseNature
org.exolab.castor.jdo.engine.nature.ClassDescriptorJDONature
public class ClassDescriptorJDONature
JDO-specific nature for ClassDescriptor
.
Augments ClassDescriptor
to include persistence-specific data such as
e.g. the table name, cache parameter, key generators, access mode and other
SQL-related information.
To access persistence-specific data of a ClassDescriptor
, use the
following code fragment to ...
ClassDescriptor
in question.ClassDescriptor classDescriptor = ...; ... if (classDescriptor.hasNature(ClassDescriptorJDONature.class.getName()) { 1) ClassDescriptorJDONature nature = new ClassDescriptorJDONature(classDescriptor); 2) ... String tableName = nature.getTableName(); 3) }
Constructor Summary | |
---|---|
ClassDescriptorJDONature(PropertyHolder holder)
Creates an instance of ClassDescriptorJDONature . |
Method Summary | |
---|---|
void |
addCacheParam(java.lang.String key,
java.lang.String value)
Adds a cache parameter to this ClassDescriptor . |
void |
addExtended(ClassDescriptor classDesc)
Adds a ClassDescriptor that extends this class. |
void |
addNamedQuery(java.lang.String name,
java.lang.String query)
Adds a named query to this ClassDescriptor . |
AccessMode |
getAccessMode()
Returns the access mode to which this object maps. |
java.util.Properties |
getCacheParams()
Returns the cache parameters defined for this ClassDescriptor . |
java.util.Collection<ClassDescriptor> |
getExtended()
Returns a collection of ClassDescriptor s that extend this class (descriptor). |
FieldDescriptor |
getField(java.lang.String name)
Returns the FieldDescriptor for the given name. |
java.lang.String |
getId()
|
KeyGeneratorDescriptor |
getKeyGeneratorDescriptor()
Get key generator specified for this class. |
java.util.Map |
getNamedQueries()
Get map of named query strings associated with their names. |
java.lang.String |
getTableName()
Returns the table name to which this object maps. |
void |
setAccessMode(AccessMode accessMode)
Sets the access mode to which this ClassDescriptor maps. |
void |
setKeyGeneratorDescriptor(KeyGeneratorDescriptor keyGenDesc)
Set key generator specified for this class. |
void |
setTableName(java.lang.String tableName)
|
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 |
Constructor Detail |
---|
public ClassDescriptorJDONature(PropertyHolder holder)
ClassDescriptorJDONature
.
holder
- The PropertyHolder
to 'view upon'.Method Detail |
---|
public java.lang.String getId()
Nature.getId()
public void setTableName(java.lang.String tableName)
public java.lang.String getTableName()
public void setAccessMode(AccessMode accessMode)
ClassDescriptor
maps.
accessMode
- The access mode to be used.public AccessMode getAccessMode()
public void setKeyGeneratorDescriptor(KeyGeneratorDescriptor keyGenDesc)
keyGenDesc
- Key generator descriptor.public KeyGeneratorDescriptor getKeyGeneratorDescriptor()
public void addCacheParam(java.lang.String key, java.lang.String value)
ClassDescriptor
.
key
- The cache parameter key.value
- The cache parameter value.public java.util.Properties getCacheParams()
ClassDescriptor
.
public void addNamedQuery(java.lang.String name, java.lang.String query)
ClassDescriptor
.
name
- The name of the named query.query
- The query stringpublic java.util.Map getNamedQueries()
public FieldDescriptor getField(java.lang.String name)
FieldDescriptor
for the given name.
name
- A field name.
FieldDescriptor
.public void addExtended(ClassDescriptor classDesc)
ClassDescriptor
that extends this class.
classDesc
- A ClassDescriptor
that extends this class.public java.util.Collection<ClassDescriptor> getExtended()
ClassDescriptor
s that extend this class (descriptor).
ClassDescriptor
s that extend this class.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |