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: 6297 $ $Date: 2006-04-10 16:39:24 -0600 (Mon, 10 Apr 2006) $

Author: Assaf Arkin

Constructor Summary
	JDOClassDescriptor(ClassDescriptor clsDesc, KeyGeneratorDescriptor keyGenDesc)

Method Summary
void	addNamedQuery(String name, String namedQuery) Adds a new named query for the given name for future usage (through Database.getNamedQuery()).
Properties	getCacheParams()
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	getNamedQuery(String name) Returns the OQL statement from a named query instance associated with the given name
String	getTableName() Returns the table name to which this object maps.
String	toString()

Constructor Detail

JDOClassDescriptor

public JDOClassDescriptor(ClassDescriptor clsDesc, KeyGeneratorDescriptor keyGenDesc)

Method Detail

addNamedQuery

public void addNamedQuery(String name, String namedQuery)

Adds a new named query for the given name for future usage (through Database.getNamedQuery()).

Parameters: name Name of the named query. namedQuery Named query to be associated with the given name

Throws: QueryException If there's already a named query for the given name

getCacheParams

public Properties getCacheParams()

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

getNamedQuery

public String getNamedQuery(String name)

Returns the OQL statement from a named query instance associated with the given name

Parameters: name Name of the named query

Returns: the OQL statement from a named query instance associated with the given name

getTableName

public String getTableName()

Returns the table name to which this object maps.

Returns: Table name

toString

public String toString()