Java Doc for ColumnMap.java in  » Database-ORM » Torque » org » apache » torque » map » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Note that this information should be set via the MapBuilder class and not changed by applications. The set methods are only public because this class needs them.
author:
   John D. McNally
author:
   Greg Monroe
version:
   $Id: ColumnMap.java 473821 2006-11-11 22:37:25Z tv $

Constructor Summary
public	ColumnMap(String name, TableMap containingTable)      Constructor.

Method Summary
public  void	addInheritanceMap(InheritanceMap map)      Add an associated inheritance mapping.
public  String	getColumnName()      Get the name of a column.
public  String	getDefault()      A string representing the default value defined for this column.
public  String	getDescription()      Returns the column description info.
public  String	getFullyQualifiedName()      Get the table name + column name.
public  String	getInheritance()      Gets the inheritance type used.
public  InheritanceMap	getInheritanceMap(String key)      Get the inheritance map with the specified key. Parameters:   key - the key of the inheritance map.
public  InheritanceMap[]	getInheritanceMaps()
public  String	getInputValidator()      Returns the input validator class name.
public  String	getJavaName()      Gets the Java Name for this column as defined in XML or created by generator code.
public  String	getJavaNamingMethod()      Returns the Java naming method for this column.
public  String	getJavaType()      Returns the java type of this column.
public  int	getPosition()      Returns the position (one based) of this column in the table.
public  String	getRelatedColumnName()      Get the column name that this column is related to.
public  String	getRelatedName()      Get the table.column that this column is related to.
public  String	getRelatedTableName()      Get the table name that this column is related to.
public  int	getScale()      Gets the scale set for this column (if any) as set in the XML database definition.
public  int	getSize()      The "precision" value from the XML size="<precision>[,<scale>]" attribute.
public  TableMap	getTable()      Returns the map for the table this column belongs to.
public  String	getTableName()      Get the name of the table this column is in.
public  String	getTorqueType()      Get the name of the Torque type of this column.
public  Object	getType()      Get the type of this column.
public  boolean	isAutoIncrement()      Returns whether this column is an autoincrement column.
public  boolean	isForeignKey()
public  boolean	isNotNull()
public  boolean	isPk()      Returns whether this column is a primary key.
public  boolean	isPrimaryKey()
public  boolean	isProtected()      Returns whether getters and setters are generated with the access modifier "protected" rather than "public".
public  boolean	isUseInheritance()      Returns whether this column uses inheritance subclasses.
public  boolean	isUsePrimitive()      Returns whether this colum uses primitive values rather than objects.
protected  String	normalizeName(String name)      Makes sure that the column names don't include table prefixes.
public  void	setAutoIncrement(boolean autoIncrement)      Sets whether this column is an autoincrement column.
public  void	setDefault(String defaultValue)      Sets the default value for this column.
public  void	setDescription(String description)      Sets the description for this column.
public  void	setForeignKey(String fullyQualifiedName)      Set the foreign key for this column.
public  void	setForeignKey(String tableName, String columnName)      Set the foreign key for this column.
public  void	setInheritance(String inheritanceType)      Sets the inheritance type.
public  void	setInputValidator(String inputValidator)      Sets the input validator class name.
public  void	setJavaName(String name)      Sets the Java Name for this column.
public  void	setJavaNamingMethod(String javaNamingMethod)      Sets the java naming method for this column.
public  void	setJavaType(String javaType)      Sets the java type of this column.
public  void	setNotNull(boolean nn)      Set if this column may be null.
public  void	setPk(boolean pk)      Sets whether this column is a primary key.
public  void	setPosition(int position)      Sets the position (one based) of this column in the table.
public  void	setPrimaryKey(boolean pk)      Set if this column is a primary key or not.
public  void	setProtected(boolean isProtected)      Sets whether getters and setters should be generated with the access modifier "protected" rather than "public".
public  void	setScale(int scale)
public  void	setSize(int size)      Set the size of this column.
public  void	setTorqueType(String torqueType)      Set the Torque type of this column.
public  void	setType(Object type)      Set the type of this column.
public  void	setUseInheritance(boolean useInheritance)      Sets whether this column uses inheritance subclasses.
public  void	setUsePrimitive(boolean usePrimitive)      Sets whether this colum uses primitive values rather than objects.

Constructor Detail

ColumnMap
public ColumnMap(String name, TableMap containingTable)(Code)
	Constructor. Parameters:   name - The name of the column. Parameters:   containingTable - TableMap of the table this column is in.