org.exolab.castor.jdo.engine

Class JDOClassDescriptor

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.3 $ $Date: 2004/06/16 09:46:22 $

Author: Assaf Arkin

Constructor Summary
JDOClassDescriptor(ClassDescriptor clsDesc, String tableName, KeyGeneratorDescriptor keyGenDesc, String cacheType, int cacheParam)
Method Summary
intgetCacheParam()
Returns the preferred mechanism for caching instance of this class
StringgetCacheType()
Returns the preferred mechanism for caching instance of this class
ClassDescriptorgetDepends()
JDOFieldDescriptorgetField(String name)
Returns a JDOFieldDescriptor for the field with the name passed.
String[]getIdentityColumnNames()
KeyGeneratorDescriptorgetKeyGeneratorDescriptor()
Returns the key generator specified for this class.
StringgetTableName()
Returns the table name to which this object maps.
StringtoString()

Constructor Detail

JDOClassDescriptor

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

Method Detail

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()

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()
Intalio Inc. (C) 1999-2004. All rights reserved http://www.intalio.com