org.apache.torque.map
Class InheritanceMap

java.lang.Object
  org.apache.torque.map.InheritanceMap

public class InheritanceMap
extends java.lang.Object

InheritanceMap is used to model OM inheritance classes.

Version:

$Id$

Author:

Greg Monroe

Constructor Summary

InheritanceMap(ColumnMap column, java.lang.String key, java.lang.String className, java.lang.String ancestor)
Create an inheritance map object.

Method Summary

java.lang.String	getClassName() Returns the class name for this InheritanceMap.
ColumnMap	getColumn() Returns the column this inheritance map belongs to.
java.lang.String	getExtends() Returns the ancestor class for the class described by this InheritanceMap.
java.lang.String	getKey() Returns the key by which this inheritanceMap is activated.
void	setClassName(java.lang.String className) Sets the class name for this InheritanceMap.
void	setColumn(ColumnMap column) Sets the column this inheritance map belongs to.
void	setExtends(java.lang.String ancestor) Sets the ancestor class for the class described by this InheritanceMap.
void	setKey(java.lang.String key) Sets the key by which this inheritanceMap is activated.

Methods inherited from class java.lang.Object

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

Constructor Detail

InheritanceMap

public InheritanceMap(ColumnMap column,
                      java.lang.String key,
                      java.lang.String className,
                      java.lang.String ancestor)

Create an inheritance map object.

Parameters:

column - The column this inheritance map belongs to.

key - Key to determine which subclass applies

className - package.Name of sub class to use for record.

ancestor - package.Name of class that className extends.

Method Detail

getExtends

public java.lang.String getExtends()

Returns the ancestor class for the class described by this InheritanceMap.

Returns:

the ancestor class for the class described by this InheritanceMap.

setExtends

public void setExtends(java.lang.String ancestor)

Sets the ancestor class for the class described by this InheritanceMap.

Parameters:

ancestor - The ancestor for the class described by this InheritanceMap.

getClassName

public java.lang.String getClassName()

Returns the class name for this InheritanceMap.

Returns:

The class name for this InheritanceMap.

setClassName

public void setClassName(java.lang.String className)

Sets the class name for this InheritanceMap.

Parameters:

className - The className for this InheritanceMap.

getColumn

public ColumnMap getColumn()

Returns the column this inheritance map belongs to.

Returns:

the column this inheritance map belongs to.

setColumn

public void setColumn(ColumnMap column)

Sets the column this inheritance map belongs to.

Parameters:

column - the column this inheritance map belongs to.

getKey

public java.lang.String getKey()

Returns the key by which this inheritanceMap is activated.

Returns:

The key by which this inheritanceMap is activated.

setKey

public void setKey(java.lang.String key)

Sets the key by which this inheritanceMap is activated.

Parameters:

key - The key by which this inheritanceMap is activated.