de.mguennewig.pobjects.metadata
Class Column

java.lang.Object
  extended by de.mguennewig.pobjects.metadata.Column
Direct Known Subclasses:
Field, FormEntry, Parameter

public abstract class Column
extends java.lang.Object

Defines a table attribute.

Author:
Michael Günnewig

Field Summary
static int GET_METHOD
          Name of the Java method that returns the value of the indicated column.
static int GET_METHOD_VISUAL
          Name of the Java method that returns the preferred string representation of the value returned by method GET_METHOD.
static int MEMBER_ATTR
          Name of the public Java member that holds a reference to the column descriptor.
static int MEMBER_ATTR_TYPE
          Name of the public Java member that holds a reference to the descriptor's type.
static int MEMBER_NAME
          Name of the private Java member that stores this column.
static int SET_METHOD
          Name of the Java method that assigns a new value to the indicated column.
 
Method Summary
 Description getDescription()
           
 int getIndex()
          Returns the index position in the surrounding table expression.
 java.lang.String getName()
          Returns the column name as seen by the application.
 java.lang.String getSchemaName()
          Returns the column name in the database schema.
 Type getType()
          Returns the type definition for this column
 java.lang.String name(int variant)
          Returns different names depending on variant for the code generator.
 void setDescription(Description descr)
           
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

GET_METHOD

public static final int GET_METHOD
Name of the Java method that returns the value of the indicated column.

See Also:
Constant Field Values

SET_METHOD

public static final int SET_METHOD
Name of the Java method that assigns a new value to the indicated column.

See Also:
Constant Field Values

GET_METHOD_VISUAL

public static final int GET_METHOD_VISUAL
Name of the Java method that returns the preferred string representation of the value returned by method GET_METHOD.

See Also:
Constant Field Values

MEMBER_NAME

public static final int MEMBER_NAME
Name of the private Java member that stores this column.

See Also:
Constant Field Values

MEMBER_ATTR

public static final int MEMBER_ATTR
Name of the public Java member that holds a reference to the column descriptor.

See Also:
Constant Field Values

MEMBER_ATTR_TYPE

public static final int MEMBER_ATTR_TYPE
Name of the public Java member that holds a reference to the descriptor's type. The member's type is the most specific extension of the base type Type that applies.

See Also:
Constant Field Values
Method Detail

getName

public final java.lang.String getName()
Returns the column name as seen by the application.


getSchemaName

public final java.lang.String getSchemaName()
Returns the column name in the database schema.


getDescription

public final Description getDescription()

setDescription

public final void setDescription(Description descr)

getType

public final Type getType()
Returns the type definition for this column


getIndex

public final int getIndex()
Returns the index position in the surrounding table expression.


name

public java.lang.String name(int variant)
Returns different names depending on variant for the code generator.

Returns:
variant return value
GET_METHOD get<Name>
GET_METHOD_VISUAL get<Name>ForVisual
SET_METHOD set<Name>
MEMBER_NAME <name>
MEMBER_ATTR attr<Name>
MEMBER_ATTR_TYPE atype<Name>
Throws:
java.lang.IllegalArgumentException - if variant is unknown.

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object