Package org.apache.torque.templates.transformer.om

## Enum ColumnChildElementName

- java.lang.Object
- - java.lang.Enum<ColumnChildElementName>
  - - org.apache.torque.templates.transformer.om.ColumnChildElementName

- All Implemented Interfaces:
    `Serializable`, `Comparable<ColumnChildElementName>`, `SourceElementName`

      public enum ColumnChildElementName
      extends Enum<ColumnChildElementName>
      implements SourceElementName

  Contains the child elements for a column source element which are not defined in the Torque schema. These elements might be created in the transformation

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant | Description
    --- | ---
    `REFERENCED_COLUMN` | The element containing the column which is referenced by the parent column element in a foreign-key relation.
    `REFERENCING_COLUMN` | The element containing the column which references the parent column element in a foreign-key relation.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `String` | `getName()` | Returns the name of the referenced source element.
    `String` | `toString()` |
    `static ColumnChildElementName` | `valueOf​(String name)` | Returns the enum constant of this type with the specified name.
    `static ColumnChildElementName[]` | `values()` | Returns an array containing the constants of this enum type, in the order they are declared.

    - ### Methods inherited from class java.lang.Enum

      `clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf`

    - ### Methods inherited from class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### REFERENCED_COLUMN

          public static final ColumnChildElementName REFERENCED_COLUMN

      The element containing the column which is referenced by the parent column element in a foreign-key relation.

    - #### REFERENCING_COLUMN

          public static final ColumnChildElementName REFERENCING_COLUMN

      The element containing the column which references the parent column element in a foreign-key relation.

  - ### Method Detail

    - #### values

          public static ColumnChildElementName[] values()

      Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

          for (ColumnChildElementName c : ColumnChildElementName.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

    - #### valueOf

          public static ColumnChildElementName valueOf​(String name)

      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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.
      Specified by:
        `getName` in interface `SourceElementName`
      Returns:
        the name of the referenced source element.

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Enum<ColumnChildElementName>`