Class DataProfileAnnotation

  • All Implemented Interfaces:
    java.io.Serializable

    public class DataProfileAnnotation
    extends DataFieldAnnotation
    DataProfileAnnotation holds properties that describe the characteristics of a specific field within a data source.
    See Also:
    Serialized Form
    • Constructor Detail

      • DataProfileAnnotation

        public DataProfileAnnotation()
        Default constructor
      • DataProfileAnnotation

        public DataProfileAnnotation​(DataProfileAnnotation template)
        Copy clone constructor
        Parameters:
        template - object to copy
    • Method Detail

      • 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 java.lang.String getInferredDataType()
        Return the name of the data type that the discovery service believes the field is.
        Returns:
        string name
      • setInferredDataType

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

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

        public void setInferredFormat​(java.lang.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
      • getProfileProperties

        public java.util.Map<java.lang.String,​java.lang.String> getProfileProperties()
        Return the map of properties that make up the profile.
        Returns:
        property map
      • setProfileProperties

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

        public java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.Boolean> profileFlags)
        Set up a set of boolean flags describing different aspects of the data.
        Parameters:
        profileFlags - map of flag names to flag values
      • getProfileCounts

        public java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.Long> profileCounts)
        Set up the map of different profiling counts that have been calculated.
        Parameters:
        profileCounts - map of count name to count value
      • getValueList

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

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

        public java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.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 java.lang.String getValueRangeFrom()
        Return the lowest value of the data stored in this data field.
        Returns:
        string version of the value.
      • setValueRangeFrom

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

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

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

        public java.lang.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​(java.lang.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 java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class DataFieldAnnotation
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.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