Package org.odpi.openmetadata.frameworks.surveyaction.measurements

Enum Class FileDirectoryMetric

java.lang.Object
java.lang.Enum<FileDirectoryMetric>
org.odpi.openmetadata.frameworks.surveyaction.measurements.FileDirectoryMetric
All Implemented Interfaces:
Serializable, Comparable<FileDirectoryMetric>, Constable, SurveyMetric
public enum FileDirectoryMetric extends Enum<FileDirectoryMetric> implements SurveyMetric
FileDirectoryMetric describes the metrics for a directory (folder) that are captured by the Folder Survey Action Service.

  • Enum Constant Details

    • FILE_COUNT

      public static final FileDirectoryMetric FILE_COUNT
      Number of files found under the surveyed directory (and all subdirectories).

    • TOTAL_FILE_SIZE

      public static final FileDirectoryMetric TOTAL_FILE_SIZE
      Total number of bytes from all files found under the surveyed directory (and all subdirectories).

    • SUB_DIRECTORY_COUNT

      public static final FileDirectoryMetric SUB_DIRECTORY_COUNT
      Number of subdirectories found under the surveyed directory.

    • READABLE_FILE_COUNT

      public static final FileDirectoryMetric READABLE_FILE_COUNT
      Number of files and directories found under the surveyed directory.

    • WRITEABLE_FILE_COUNT

      public static final FileDirectoryMetric WRITEABLE_FILE_COUNT
      Number of files and directories found under the surveyed directory that can be written to.

    • EXECUTABLE_FILE_COUNT

      public static final FileDirectoryMetric EXECUTABLE_FILE_COUNT
      Number of files and directories found under the surveyed that can be executed.

    • HIDDEN_FILE_COUNT

      public static final FileDirectoryMetric HIDDEN_FILE_COUNT
      Number of files under the surveyed directory are hidden from standard users.

    • FILE_NAME_COUNT

      public static final FileDirectoryMetric FILE_NAME_COUNT
      Number of different file names found under the surveyed directory.

    • FILE_EXTENSION_COUNT

      public static final FileDirectoryMetric FILE_EXTENSION_COUNT
      Number of different file extensions found under the surveyed directory.

    • FILE_TYPE_COUNT

      public static final FileDirectoryMetric FILE_TYPE_COUNT
      Number of different file types detected when classifying the files under the surveyed directory.

    • ASSET_TYPE_COUNT

      public static final FileDirectoryMetric ASSET_TYPE_COUNT
      Number of different file asset types detected when classifying the files under the surveyed directory.

    • DEPLOYED_IMPL_TYPE_COUNT

      public static final FileDirectoryMetric DEPLOYED_IMPL_TYPE_COUNT
      Number of different file deployed implementation types detected when classifying the files under the surveyed directory.

    • UNCLASSIFIED_FILE_COUNT

      public static final FileDirectoryMetric UNCLASSIFIED_FILE_COUNT
      Number of files under the surveyed directory that could not be classified using the existing reference data.

    • INACCESSIBLE_FILE_COUNT

      public static final FileDirectoryMetric INACCESSIBLE_FILE_COUNT
      Number of files under the surveyed folder that could not be accessed even to extract their basic properties.

    • LAST_FILE_CREATION_TIME

      public static final FileDirectoryMetric LAST_FILE_CREATION_TIME
      The last time that a file was created in the surveyed directory (or any subdirectory).

    • LAST_FILE_MODIFIED_TIME

      public static final FileDirectoryMetric LAST_FILE_MODIFIED_TIME
      The last time that a file was created in the surveyed directory (or any subdirectory).

    • LAST_FILE_ACCESSED_TIME

      public static final FileDirectoryMetric LAST_FILE_ACCESSED_TIME
      The last time that a file was accessed in the surveyed directory (or any subdirectory).

  • Field Details

    • propertyName

      public final String propertyName

    • dataType

      public final String dataType

    • displayName

      public final String displayName

    • description

      public final String description

  • Method Details

    • values

      public static FileDirectoryMetric[] 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 FileDirectoryMetric 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

    • getPropertyName

      public String getPropertyName()
      Return the property name used to store the measurement.
      Specified by:
      getPropertyName in interface SurveyMetric
      Returns:
      name

    • getDataType

      public String getDataType()
      Return the data type of the property used to store the measure.
      Specified by:
      getDataType in interface SurveyMetric
      Returns:
      data type name

    • getDisplayName

      public String getDisplayName()
      Return the name of the metric.
      Specified by:
      getDisplayName in interface SurveyMetric
      Returns:
      string name

    • getDescription

      public String getDescription()
      Return the description of the metric.
      Specified by:
      getDescription in interface SurveyMetric
      Returns:
      text

    • getMetrics

      public static List<FileDirectoryMetric> getMetrics()
      Return the defined metrics as a list
      Returns:
      list

    • toString

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