Package org.odpi.openmetadata.adapters.connectors.integration.basicfiles.controls

Enum Class FilesPlaceholderProperty

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

  • Enum Constant Details

    • FOLDER_NAME

      public static final FilesPlaceholderProperty FOLDER_NAME
      The name of the leaf directory, without its enclosing directories.

    • DATA_SET_NAME

      public static final FilesPlaceholderProperty DATA_SET_NAME
      The display name of the data set.

    • FORMULA

      public static final FilesPlaceholderProperty FORMULA
      The formula used to populate the data set.

    • FORMULA_TYPE

      public static final FilesPlaceholderProperty FORMULA_TYPE
      The language/format used in the data set's formula.

    • FILE_SYSTEM_NAME

      public static final FilesPlaceholderProperty FILE_SYSTEM_NAME
      The full pathname of the file including the directory names, file name and file extension.

    • PATH_NAME

      public static final FilesPlaceholderProperty PATH_NAME
      The full pathname of the file including the directory names, file name and file extension.

    • FILE_NAME

      public static final FilesPlaceholderProperty FILE_NAME
      The short name of the file with its extension but without the directory names.

    • FILE_TYPE

      public static final FilesPlaceholderProperty FILE_TYPE
      The logical file type of the file.

    • FILE_EXTENSION

      public static final FilesPlaceholderProperty FILE_EXTENSION
      The postfix identifier in the file name that indicates the format of the file.

    • FILE_ENCODING

      public static final FilesPlaceholderProperty FILE_ENCODING
      The encoding scheme used on the file.

    • DEPLOYED_IMPLEMENTATION_TYPE

      public static final FilesPlaceholderProperty DEPLOYED_IMPLEMENTATION_TYPE
      The deployed implementation type for the file.

    • DESCRIPTION

      public static final FilesPlaceholderProperty DESCRIPTION
      The description of the resource to help a consumer understand its content and purpose.

    • PROGRAMMING_LANGUAGE

      public static final FilesPlaceholderProperty PROGRAMMING_LANGUAGE
      The programming language used to encode the file.

    • EMBEDDED_METADATA

      public static final FilesPlaceholderProperty EMBEDDED_METADATA
      Descriptive metadata values embedded within the file.

  • 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 FilesPlaceholderProperty[] 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 FilesPlaceholderProperty 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

    • getDataFilesPlaceholderPropertyTypes

      public static List<org.odpi.openmetadata.frameworks.governanceaction.controls.PlaceholderPropertyType> getDataFilesPlaceholderPropertyTypes()
      Retrieve all the defined placeholder properties for data files
      Returns:
      list of placeholder property types

    • getMediaFilesPlaceholderPropertyTypes

      public static List<org.odpi.openmetadata.frameworks.governanceaction.controls.PlaceholderPropertyType> getMediaFilesPlaceholderPropertyTypes()
      Retrieve all the defined placeholder properties for data files
      Returns:
      list of placeholder property types

    • getFolderPlaceholderPropertyTypes

      public static List<org.odpi.openmetadata.frameworks.governanceaction.controls.PlaceholderPropertyType> getFolderPlaceholderPropertyTypes()
      Retrieve all the defined placeholder properties for directories (file folder)
      Returns:
      list of placeholder property types

    • getDataSetPlaceholderPropertyTypes

      public static List<org.odpi.openmetadata.frameworks.governanceaction.controls.PlaceholderPropertyType> getDataSetPlaceholderPropertyTypes()
      Retrieve all the defined placeholder properties for directories (file folder)
      Returns:
      list of placeholder property types

    • getSoftwareFilesPlaceholderPropertyTypes

      public static List<org.odpi.openmetadata.frameworks.governanceaction.controls.PlaceholderPropertyType> getSoftwareFilesPlaceholderPropertyTypes()
      Retrieve all the defined placeholder properties for files associated with software
      Returns:
      list of placeholder property types

    • getPlaceholderType

      public org.odpi.openmetadata.frameworks.governanceaction.controls.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<FilesPlaceholderProperty>
      Returns:
      string showing enum value