Enum Class ColumnAttributeName

java.lang.Object
java.lang.Enum<ColumnAttributeName>
org.apache.torque.templates.transformer.om.ColumnAttributeName
All Implemented Interfaces:
Serializable, Comparable<ColumnAttributeName>, Constable, SourceAttributeName

public enum ColumnAttributeName extends Enum<ColumnAttributeName> implements SourceAttributeName
Contains the attributes for a column source element which are not defined in the Torque schema.
  • Enum Constant Details

    • PRIMITIVE_TYPE

      public static final ColumnAttributeName PRIMITIVE_TYPE
      Whether the column is a primitive column.
    • NUMBER_TYPE

      public static final ColumnAttributeName NUMBER_TYPE
      Whether the column is a number column.
    • PEER_COLUMN_NAME

      public static final ColumnAttributeName PEER_COLUMN_NAME
      The name of constant for the column name in the peer class.
    • QUALIFIED_COLUMN_NAME

      public static final ColumnAttributeName QUALIFIED_COLUMN_NAME
      The fully qualified name of the column, i. e. prefixed with the database schema name if a schema name was given.
    • POSITION

      public static final ColumnAttributeName POSITION
      The column index, 1 based. First column 1, second column 2 etc.
    • FIELD_OBJECT_TYPE

      public static final ColumnAttributeName FIELD_OBJECT_TYPE
      The object (non-primitive) type for a field.
    • RESULT_SET_GETTER

      public static final ColumnAttributeName RESULT_SET_GETTER
      The getter to get the column from a result set.
    • SAMPLE_OBJECT

      public static final ColumnAttributeName SAMPLE_OBJECT
      An instance of the object for the type map.
    • ENUM_CLASS_NAME

      public static final ColumnAttributeName ENUM_CLASS_NAME
      The unqualified name of the enum type of the column.
    • ENUM_PACKAGE

      public static final ColumnAttributeName ENUM_PACKAGE
      The package of the enum type of the column.
    • ENUM_VALUE_CLASS_NAME

      public static final ColumnAttributeName ENUM_VALUE_CLASS_NAME
      The unqualified class name of the value contained in enum type of the column.
    • GENERATE_ENUM

      public static final ColumnAttributeName GENERATE_ENUM
      Whether to generate an enum type for the column (nb: predefined enums can be defined which need not be generated).
    • IS_ENUM

      public static final ColumnAttributeName IS_ENUM
      Whether this column is an enum.
  • Method Details

    • values

      public static ColumnAttributeName[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ColumnAttributeName valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getName

      public String getName()
      Returns the name of the referenced source element attribute.
      Specified by:
      getName in interface SourceAttributeName
      Returns:
      the name of the referenced source element attribute.
    • toString

      public String toString()
      Overrides:
      toString in class Enum<ColumnAttributeName>