Package org.odpi.openmetadata.frameworks.surveyaction.properties

Class ResourceProfileAnnotation

java.lang.Object
org.odpi.openmetadata.frameworks.surveyaction.properties.PropertyBase
org.odpi.openmetadata.frameworks.surveyaction.properties.Annotation
org.odpi.openmetadata.frameworks.surveyaction.properties.DataFieldAnnotation
org.odpi.openmetadata.frameworks.surveyaction.properties.ResourceProfileAnnotation
public class ResourceProfileAnnotation extends DataFieldAnnotation
DataProfileAnnotation holds properties that describe the characteristics of a specific field within a data source.

  • Constructor Details

    • ResourceProfileAnnotation

      public ResourceProfileAnnotation()
      Default constructor

    • ResourceProfileAnnotation

      public ResourceProfileAnnotation(ResourceProfileAnnotation template)
      Copy clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getProfilePropertyNames

      public List<String> getProfilePropertyNames()
      Return the list of property values filled out in this annotation.
      Returns:
      list of property names

    • setProfilePropertyNames

      public void setProfilePropertyNames(List<String> profilePropertyNames)
      Set up the list of property values filled out in this annotation.
      Parameters:
      profilePropertyNames - list of property names

    • getLength

      public int getLength()
      Return the length of the data field. Assumes static predefined lengths.
      Returns:
      integer

    • setLength

      public void setLength(int length)
      Set up the length of the data field. Assumes static predefined lengths.
      Parameters:
      length - integer

    • getInferredDataType

      public String getInferredDataType()
      Return the name of the data type that the discovery service believes the field is.
      Returns:
      string name

    • setInferredDataType

      public void setInferredDataType(String inferredDataType)
      Set up the name of the data type that the discovery service believes the field is.
      Parameters:
      inferredDataType - string name

    • getInferredFormat

      public String getInferredFormat()
      Return the name of the data format that the discovery service believes the field is.
      Returns:
      string name

    • setInferredFormat

      public void setInferredFormat(String inferredFormat)
      Set up the name of the data format that the discovery service believes the field is.
      Parameters:
      inferredFormat - string name

    • getInferredLength

      public int getInferredLength()
      Return the length of the data field that has been deduced from the data stored.
      Returns:
      integer

    • setInferredLength

      public void setInferredLength(int inferredLength)
      Set up the length of the data field that has been deduced from the data stored.
      Parameters:
      inferredLength - integer

    • getInferredPrecision

      public int getInferredPrecision()
      Return the precision of the data field that has been deduced from the data stored.
      Returns:
      integer

    • setInferredPrecision

      public void setInferredPrecision(int inferredPrecision)
      Set up the precision of the data field that has been deduced from the data stored.
      Parameters:
      inferredPrecision - integer

    • getInferredScale

      public int getInferredScale()
      Return the inferred scale used in other properties.
      Returns:
      integer

    • setInferredScale

      public void setInferredScale(int inferredScale)
      Set up the inferred scale used in other properties.
      Parameters:
      inferredScale - integer

    • getProfileStartDate

      public Date getProfileStartDate()
      Return the time that the profiler started gathering data.
      Returns:
      date

    • setProfileStartDate

      public void setProfileStartDate(Date profileStartDate)
      Set Up the time that the profiler started gathering data.
      Parameters:
      profileStartDate - date

    • getProfileEndDate

      public Date getProfileEndDate()
      Return the time that the profiler stopped gathering data.
      Returns:
      date

    • setProfileEndDate

      public void setProfileEndDate(Date profileEndDate)
      Set up the time that the profiler stopped gathering data.
      Parameters:
      profileEndDate - date

    • getProfileProperties

      public Map<String,String> getProfileProperties()
      Return the map of properties that make up the profile.
      Returns:
      property map

    • setProfileProperties

      public void setProfileProperties(Map<String,String> profileProperties)
      Set up the map of properties that make up the profile.
      Parameters:
      profileProperties - property map

    • getProfileFlags

      public Map<String,Boolean> getProfileFlags()
      Return a set of boolean flags describing different aspects of the data.
      Returns:
      map of flag names to flag values

    • setProfileFlags

      public void setProfileFlags(Map<String,Boolean> profileFlags)
      Set up a set of boolean flags describing different aspects of the data.
      Parameters:
      profileFlags - map of flag names to flag values

    • getProfileDates

      public Map<String,Date> getProfileDates()
      Return a set of relevant dates describing different aspects of the data.
      Returns:
      map of names to date values

    • setProfileDates

      public void setProfileDates(Map<String,Date> profileDates)
      Set up a set of relevant dates describing different aspects of the data.
      Parameters:
      profileDates - map of names to date values

    • getProfileCounts

      public Map<String,Long> getProfileCounts()
      Return the map of different profiling counts that have been calculated.
      Returns:
      map of count name to count value

    • setProfileCounts

      public void setProfileCounts(Map<String,Long> profileCounts)
      Set up the map of different profiling counts that have been calculated.
      Parameters:
      profileCounts - map of count name to count value

    • getProfileDoubles

      public Map<String,Double> getProfileDoubles()
      Return the map of different large profiling counts that have been calculated.
      Returns:
      map of count name to count value

    • setProfileDoubles

      public void setProfileDoubles(Map<String,Double> profileDoubles)
      Set up the map of different large profiling counts that have been calculated.
      Parameters:
      profileDoubles - map of count name to count value

    • getValueList

      public List<String> getValueList()
      Return the list of values found in the data field.
      Returns:
      list of values

    • setValueList

      public void setValueList(List<String> valueList)
      Set up the list of values found in the data field.
      Parameters:
      valueList - list of values

    • getValueCount

      public Map<String,Integer> getValueCount()
      Return a map of values to value count for the data field.
      Returns:
      map of values to value count

    • setValueCount

      public void setValueCount(Map<String,Integer> valueCount)
      Set up a map of values to value count for the data field.
      Parameters:
      valueCount - map of values to value count

    • getValueRangeFrom

      public String getValueRangeFrom()
      Return the lowest value of the data stored in this data field.
      Returns:
      string version of the value.

    • setValueRangeFrom

      public void setValueRangeFrom(String valueRangeFrom)
      Set up the lowest value of the data stored in this data field.
      Parameters:
      valueRangeFrom - string version of the value.

    • getValueRangeTo

      public String getValueRangeTo()
      Return the upper value of the data stored in this data field.
      Returns:
      string version of the value.

    • setValueRangeTo

      public void setValueRangeTo(String valueRangeTo)
      Set up the upper value of the data stored in this data field.
      Parameters:
      valueRangeTo - string version of the value.

    • getAverageValue

      public String getAverageValue()
      Return the average (mean) value of the values stored in the data field.
      Returns:
      string version of the value.

    • setAverageValue

      public void setAverageValue(String averageValue)
      Set up the average (mean) value of the values stored in the data field.
      Parameters:
      averageValue - string version of the value.

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class DataFieldAnnotation
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class Annotation
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Create a hash code for this element type.
      Overrides:
      hashCode in class Annotation
      Returns:
      int hash code