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:

org.exolab.castor.mapping.ClassDescriptor

public class JDOClassDescriptor

extends org.exolab.castor.mapping.loader.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: 7099 $ $Date: 2006-04-10 16:39:24 -0600 (Mon, 10 Apr 2006) $

Author:

Assaf Arkin, Ralf Joachim

Constructor Summary

JDOClassDescriptor()

Method Summary

protected void	addCacheParam(java.lang.String key, java.lang.String value)
protected void	addNamedQuery(java.lang.String name, java.lang.String query)
org.exolab.castor.mapping.AccessMode	getAccessMode()
java.util.Properties	getCacheParams()
JDOFieldDescriptor	getField(java.lang.String name) Returns a JDOFieldDescriptor for the field with the name passed.
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.
protected void	setAccessMode(org.exolab.castor.mapping.AccessMode accessMode)
protected void	setKeyGeneratorDescriptor(KeyGeneratorDescriptor keyGenDesc) Set key generator specified for this class.
protected void	setTableName(java.lang.String tableName)
java.lang.String	toString()

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

addExtended, getDepends, getExtended, getExtends, getFields, getIdentities, getIdentity, getJavaClass, getMapping, setDepends, setExtends, setFields, setIdentities, setJavaClass, setMapping

Methods inherited from class java.lang.Object

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

Constructor Detail

JDOClassDescriptor

public JDOClassDescriptor()

Method Detail

setTableName

protected void setTableName(java.lang.String tableName)

getTableName

public java.lang.String getTableName()

Returns the table name to which this object maps.

Returns:

Table name

setAccessMode

protected void setAccessMode(org.exolab.castor.mapping.AccessMode accessMode)

getAccessMode

public org.exolab.castor.mapping.AccessMode getAccessMode()

addCacheParam

protected void addCacheParam(java.lang.String key,
                             java.lang.String value)

getCacheParams

public java.util.Properties getCacheParams()

addNamedQuery

protected void addNamedQuery(java.lang.String name,
                             java.lang.String query)

getNamedQueries

public java.util.Map getNamedQueries()

Get map of named query strings associated with their names.

Returns:

Map of named query strings associated with their names.

setKeyGeneratorDescriptor

protected void setKeyGeneratorDescriptor(KeyGeneratorDescriptor keyGenDesc)

Set key generator specified for this class.

Parameters:

keyGenDesc - Key generator descriptor.

getKeyGeneratorDescriptor

public KeyGeneratorDescriptor getKeyGeneratorDescriptor()

Get key generator specified for this class.

Returns:

Key generator descriptor.

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 - Name of the field to return.

Returns:

Field if it exists, otherwise null.

toString

public java.lang.String toString()