org.exolab.castor.jdo.engine

Class JDOClassDescriptor

java.lang.Object

org.exolab.castor.mapping.loader.ClassDescriptorImpl

org.exolab.castor.jdo.engine.JDOClassDescriptor

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

Author:

Assaf Arkin

Field Summary

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

_fields, _identities

Constructor Summary

Constructors

Constructor and Description
JDOClassDescriptor(ClassDescriptor clsDesc, KeyGeneratorDescriptor keyGenDesc)

Method Summary

Modifier and Type	Method and Description
void	addNamedQuery(java.lang.String name, java.lang.String namedQuery) Adds a new named query for the given name for future usage (through Database.getNamedQuery()).
java.util.Properties	getCacheParams()
JDOFieldDescriptor	getField(java.lang.String name) Returns a JDOFieldDescriptor for the field with the name passed.
java.lang.String[]	getIdentityColumnNames()
KeyGeneratorDescriptor	getKeyGeneratorDescriptor() Returns the key generator specified for this class.
java.lang.String	getNamedQuery(java.lang.String name) Returns the OQL statement from a named query instance associated with the given name
java.lang.String	getTableName() Returns the table name to which this object maps.
java.lang.String	toString()

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

addExtendedBy, checkValidity, getAccessMode, getDepends, getExtendedBy, getExtends, getFields, getIdentities, getIdentity, getJavaClass, getMapping, isExtended, isExtending

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JDOClassDescriptor

public JDOClassDescriptor(ClassDescriptor clsDesc,
                          KeyGeneratorDescriptor keyGenDesc)
                   throws MappingException

Throws:

MappingException

Method Detail

getTableName

public java.lang.String getTableName()

Returns the table name to which this object maps.

Returns:

Table name

getCacheParams

public java.util.Properties getCacheParams()

getField

public JDOFieldDescriptor getField(java.lang.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.

getKeyGeneratorDescriptor

public KeyGeneratorDescriptor getKeyGeneratorDescriptor()

Returns the key generator specified for this class.

Returns:

The key generator descriptor

getIdentityColumnNames

public java.lang.String[] getIdentityColumnNames()

Returns:

The names of columns that the identity consists of.

toString

public java.lang.String toString()

Overrides:

toString in class ClassDescriptorImpl

getNamedQuery

public java.lang.String getNamedQuery(java.lang.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

addNamedQuery

public void addNamedQuery(java.lang.String name,
                          java.lang.String namedQuery)
                   throws QueryException

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