Package org.odpi.openmetadata.adapters.connectors.db2luw.controls

Enum Class DB2LUWPlaceholderProperty

java.lang.Object
java.lang.Enum<DB2LUWPlaceholderProperty>
org.odpi.openmetadata.adapters.connectors.db2luw.controls.DB2LUWPlaceholderProperty
All Implemented Interfaces:
Serializable, Comparable<DB2LUWPlaceholderProperty>, Constable
public enum DB2LUWPlaceholderProperty extends Enum<DB2LUWPlaceholderProperty>
PlaceholderProperty provides some standard definitions for placeholder properties used to pass properties to services that use templates.

  • Enum Constant Details

    • DATABASE_NAME

      public static final DB2LUWPlaceholderProperty DATABASE_NAME
      The name of the database being catalogued. Unlike PostgreSQL (which can connect without naming a specific database, defaulting to a system database), Db2 for Linux, UNIX and Windows always requires a database name in its JDBC URL, and there is no cross-database catalog view visible from a single connection (unlike Oracle's CDB root or PostgreSQL's pg_database) - so this placeholder is also used to identify the database the server-level connection itself connects through.

    • DATABASE_DESCRIPTION

      public static final DB2LUWPlaceholderProperty DATABASE_DESCRIPTION
      The description of the database being catalogued.

    • DATABASE_USER_ID

      public static final DB2LUWPlaceholderProperty DATABASE_USER_ID
      The userId to store in the userId attribute of the connection.

    • DATABASE_PASSWORD

      public static final DB2LUWPlaceholderProperty DATABASE_PASSWORD
      The password to store in the clearPassword attribute of the connection.

    • SCHEMA_NAME

      public static final DB2LUWPlaceholderProperty SCHEMA_NAME
      The name of the schema being catalogued.

    • SCHEMA_DESCRIPTION

      public static final DB2LUWPlaceholderProperty SCHEMA_DESCRIPTION
      The description of the schema being catalogued.

    • TABLE_NAME

      public static final DB2LUWPlaceholderProperty TABLE_NAME
      The name of the database table being catalogued.

    • TABLE_DESCRIPTION

      public static final DB2LUWPlaceholderProperty TABLE_DESCRIPTION
      The description of the table being catalogued.

  • Field Details

    • name

      public final String name

    • description

      public final String description

    • dataType

      public final String dataType

    • example

      public final String example

  • Method Details

    • values

      public static DB2LUWPlaceholderProperty[] 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 DB2LUWPlaceholderProperty 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()
      Return the name of the placeholder property.
      Returns:
      string name

    • getPlaceholder

      public String getPlaceholder()
      Return the placeholder to use when building templates.
      Returns:
      placeholder property

    • getDescription

      public String getDescription()
      Return the description of the placeholder property.
      Returns:
      text

    • getDataType

      public String getDataType()
      Return the data type for the placeholder property.
      Returns:
      data type name

    • getExample

      public String getExample()
      Return an example of the placeholder property to help users understand how to set it up.
      Returns:
      example

    • getDB2LUWServerPlaceholderPropertyTypes

      public static List<PlaceholderPropertyType> getDB2LUWServerPlaceholderPropertyTypes()
      Retrieve all the defined placeholder properties
      Returns:
      list of placeholder property types

    • getDB2LUWDatabasePlaceholderPropertyTypes

      public static List<PlaceholderPropertyType> getDB2LUWDatabasePlaceholderPropertyTypes()
      Retrieve all the defined placeholder properties
      Returns:
      list of placeholder property types

    • getDB2LUWSchemaPlaceholderPropertyTypes

      public static List<PlaceholderPropertyType> getDB2LUWSchemaPlaceholderPropertyTypes()
      Retrieve all the defined placeholder properties
      Returns:
      list of placeholder property types

    • getDB2LUWTablePlaceholderPropertyTypes

      public static List<PlaceholderPropertyType> getDB2LUWTablePlaceholderPropertyTypes()
      Retrieve all the defined placeholder properties
      Returns:
      list of placeholder property types

    • getPlaceholderType

      public PlaceholderPropertyType getPlaceholderType()
      Return a summary of this enum to use in a service provider.
      Returns:
      placeholder property type

    • toString

      public String toString()
      Output of this enum class and main value.
      Overrides:
      toString in class Enum<DB2LUWPlaceholderProperty>
      Returns:
      string showing enum value