Package org.odpi.openmetadata.adapters.connectors.datastore.csvfile.controls

Enum Class CSVFileConfigurationProperty

java.lang.Object
java.lang.Enum<CSVFileConfigurationProperty>
org.odpi.openmetadata.adapters.connectors.datastore.csvfile.controls.CSVFileConfigurationProperty
All Implemented Interfaces:
Serializable, Comparable<CSVFileConfigurationProperty>, Constable
public enum CSVFileConfigurationProperty extends Enum<CSVFileConfigurationProperty>
CSVFileConfigurationProperty provides definitions for the configuration properties used with the CSV File connectors.

  • Enum Constant Details

    • COLUMN_NAMES

      public static final CSVFileConfigurationProperty COLUMN_NAMES
      The list of column names to use for the data stored in the file. This is when the column names are not stored in the first line of the file.

    • DELIMITER_CHARACTER

      public static final CSVFileConfigurationProperty DELIMITER_CHARACTER
      The character to use as the delimiter between data values in each column.

    • QUOTE_CHARACTER

      public static final CSVFileConfigurationProperty QUOTE_CHARACTER
      The character used to use as the quote character

    • DIRECTORY_PATH_NAME

      public static final CSVFileConfigurationProperty DIRECTORY_PATH_NAME
      The pathname of the .

    • TABLE_NAME

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

    • TABLE_DESCRIPTION

      public static final CSVFileConfigurationProperty 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

    • isPlaceholder

      public final boolean isPlaceholder

  • Method Details

    • values

      public static CSVFileConfigurationProperty[] 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 CSVFileConfigurationProperty 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 request parameter.
      Returns:
      string name

    • getDescription

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

    • getDataType

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

    • getExample

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

    • isPlaceholder

      public boolean isPlaceholder()
      Return whether this value is also used as a placeholder property.
      Returns:
      boolean

    • getCSVFileStoreConfigPropertyNames

      public static List<String> getCSVFileStoreConfigPropertyNames()
      Get recognizedConfigurationProperties for the CSVFileStore resource connector.
      Returns:
      list of property names

    • getCSVFileStoreConfigConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getCSVFileStoreConfigConfigurationPropertyTypes()
      Retrieve the defined configuration properties for the CSVFileStore resource connector.
      Returns:
      list of configuration property types

    • getCSVTabularDataSetConfigPropertyNames

      public static List<String> getCSVTabularDataSetConfigPropertyNames()
      Get recognizedConfigurationProperties for the CSV tabular data set resource connector.
      Returns:
      list of property names

    • getCSVTabularDataSetConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getCSVTabularDataSetConfigurationPropertyTypes()
      Retrieve the defined configuration properties for the CSV tabular data set connector
      Returns:
      list of configuration property types

    • getCSVTabularDataSetCollectionConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getCSVTabularDataSetCollectionConfigurationPropertyTypes()
      Retrieve the defined configuration properties for the CSV tabular data set collection connector
      Returns:
      list of configuration property types

    • getCSVTabularDataSetCollectionConfigPropertyNames

      public static List<String> getCSVTabularDataSetCollectionConfigPropertyNames()
      Get recognizedConfigurationProperties for the CSV tabular data set collection resource connector.
      Returns:
      list of property names

    • getAllConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getAllConfigurationPropertyTypes()
      Retrieve all the defined configuration properties
      Returns:
      list of configuration property types

    • getConfigurationPropertyType

      public ConfigurationPropertyType getConfigurationPropertyType()
      Return a summary of this enum to use in a connector provider.
      Returns:
      request parameter type

    • toString

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