org.exolab.castor.jdo.engine

Class JDOClassDescriptor

Implemented Interfaces:
ClassDescriptor

public class JDOClassDescriptor
extends ClassDescriptorImpl

JDO class descriptors. Extends ClassDescriptor to include the table name and other SQL-related information. All fields are of type JDOFieldDescriptor, identity field is not included in the returned field list, and contained fields are flattened out for efficiency (thus all fields are directly accessible).
Version:
$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:08:17 $
Author:
Assaf Arkin

Field Summary

Fields inherited from class org.exolab.castor.mapping.loader.ClassDescriptorImpl

_fields, _identities

Constructor Summary

JDOClassDescriptor(ClassDescriptor clsDesc, String tableName, KeyGeneratorDescriptor keyGenDesc, String cacheType, int cacheParam)

Method Summary

int
getCacheParam()
Returns the preferred mechanism for caching instance of this class
String
getCacheType()
Returns the preferred mechanism for caching instance of this class
ClassDescriptor
getDepends()
JDOFieldDescriptor
getField(String name)
Returns a JDOFieldDescriptor for the field with the name passed.
String[]
getIdentityColumnNames()
KeyGeneratorDescriptor
getKeyGeneratorDescriptor()
Returns the key generator specified for this class.
String
getTableName()
Returns the table name to which this object maps.
String
toString()

Methods inherited from class org.exolab.castor.mapping.loader.ClassDescriptorImpl

checkValidity, getAccessMode, getDepends, getExtends, getFields, getIdentities, getIdentity, getJavaClass, getMapping, setMapping, toString

Constructor Details

JDOClassDescriptor

public JDOClassDescriptor(ClassDescriptor clsDesc,
                          String tableName,
                          KeyGeneratorDescriptor keyGenDesc,
                          String cacheType,
                          int cacheParam)
            throws MappingException

Method Details

getCacheParam

public int getCacheParam()
Returns the preferred mechanism for caching instance of this class
Returns:
an int represent the param

getCacheType

public String getCacheType()
Returns the preferred mechanism for caching instance of this class
Returns:
a String represent the cache type

getDepends

public ClassDescriptor getDepends()
Overrides:
getDepends in interface ClassDescriptorImpl

getField

public JDOFieldDescriptor getField(String name)
Returns a JDOFieldDescriptor for the field with the name passed. Null if named field does not exist.
Parameters:
name - The name of the field to return
Returns:
The field if it exists, otherwise null.

getIdentityColumnNames

public String[] getIdentityColumnNames()
Returns:
The names of columns that the identity consists of.

getKeyGeneratorDescriptor

public KeyGeneratorDescriptor getKeyGeneratorDescriptor()
Returns the key generator specified for this class.
Returns:
The key generator descriptor

getTableName

public String getTableName()
Returns the table name to which this object maps.
Returns:
Table name

toString

public String toString()
Overrides:
toString in interface ClassDescriptorImpl

Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com