Class DataProfileAnnotation
java.lang.Object
org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase
org.odpi.openmetadata.frameworks.discovery.properties.Annotation
org.odpi.openmetadata.frameworks.discovery.properties.DataFieldAnnotation
org.odpi.openmetadata.frameworks.discovery.properties.DataProfileAnnotation
- All Implemented Interfaces:
Serializable
DataProfileAnnotation holds properties that describe the characteristics of a specific field within a data source.
- See Also:
-
Field Summary
Fields inherited from class org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase
CURRENT_AUDIT_HEADER_VERSION
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorDataProfileAnnotation
(DataProfileAnnotation template) Copy clone constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.Return the average (mean) value of the values stored in the data field.Return the name of the data type that the discovery service believes the field is.Return the name of the data format that the discovery service believes the field is.int
Return the length of the data field that has been deduced from the data stored.int
Return the precision of the data field that has been deduced from the data stored.int
Return the inferred scale used in other properties.int
Return the length of the data field.Return the map of different profiling counts that have been calculated.Return a set of boolean flags describing different aspects of the data.Return the map of properties that make up the profile.Return a map of values to value count for the data field.Return the list of values found in the data field.Return the lowest value of the data stored in this data field.Return the upper value of the data stored in this data field.int
hashCode()
Create a hash code for this element type.void
setAverageValue
(String averageValue) Set up the average (mean) value of the values stored in the data field.void
setInferredDataType
(String inferredDataType) Set up the name of the data type that the discovery service believes the field is.void
setInferredFormat
(String inferredFormat) Set up the name of the data format that the discovery service believes the field is.void
setInferredLength
(int inferredLength) Set up the length of the data field that has been deduced from the data stored.void
setInferredPrecision
(int inferredPrecision) Set up the precision of the data field that has been deduced from the data stored.void
setInferredScale
(int inferredScale) Set up the inferred scale used in other properties.void
setLength
(int length) Set up the length of the data field.void
setProfileCounts
(Map<String, Long> profileCounts) Set up the map of different profiling counts that have been calculated.void
setProfileFlags
(Map<String, Boolean> profileFlags) Set up a set of boolean flags describing different aspects of the data.void
setProfileProperties
(Map<String, String> profileProperties) Set up the map of properties that make up the profile.void
setValueCount
(Map<String, Integer> valueCount) Set up a map of values to value count for the data field.void
setValueList
(List<String> valueList) Set up the list of values found in the data field.void
setValueRangeFrom
(String valueRangeFrom) Set up the lowest value of the data stored in this data field.void
setValueRangeTo
(String valueRangeTo) Set up the upper value of the data stored in this data field.toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.frameworks.discovery.properties.Annotation
getAdditionalProperties, getAnalysisStep, getAnnotationStatus, getAnnotationType, getConfidenceLevel, getExplanation, getExpression, getJsonProperties, getNumAttachedAnnotations, getReviewComment, getReviewDate, getSteward, getSummary, setAdditionalProperties, setAnalysisStep, setAnnotationStatus, setAnnotationType, setConfidenceLevel, setExplanation, setExpression, setJsonProperties, setNumAttachedAnnotations, setReviewComment, setReviewDate, setSteward, setSummary
Methods inherited from class org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase
getElementHeader, getExtendedProperties, getHeaderVersion, getTypeName, setElementHeader, setExtendedProperties, setHeaderVersion, setTypeName
-
Constructor Details
-
DataProfileAnnotation
public DataProfileAnnotation()Default constructor -
DataProfileAnnotation
Copy clone constructor- Parameters:
template
- object to copy
-
-
Method Details
-
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
Return the name of the data type that the discovery service believes the field is.- Returns:
- string name
-
setInferredDataType
Set up the name of the data type that the discovery service believes the field is.- Parameters:
inferredDataType
- string name
-
getInferredFormat
Return the name of the data format that the discovery service believes the field is.- Returns:
- string name
-
setInferredFormat
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
Return the map of properties that make up the profile.- Returns:
- property map
-
setProfileProperties
Set up the map of properties that make up the profile.- Parameters:
profileProperties
- property map
-
getProfileFlags
Return a set of boolean flags describing different aspects of the data.- Returns:
- map of flag names to flag values
-
setProfileFlags
Set up a set of boolean flags describing different aspects of the data.- Parameters:
profileFlags
- map of flag names to flag values
-
getProfileCounts
Return the map of different profiling counts that have been calculated.- Returns:
- map of count name to count value
-
setProfileCounts
Set up the map of different profiling counts that have been calculated.- Parameters:
profileCounts
- map of count name to count value
-
getValueList
Return the list of values found in the data field.- Returns:
- list of values
-
setValueList
Set up the list of values found in the data field.- Parameters:
valueList
- list of values
-
getValueCount
Return a map of values to value count for the data field.- Returns:
- map of values to value count
-
setValueCount
Set up a map of values to value count for the data field.- Parameters:
valueCount
- map of values to value count
-
getValueRangeFrom
Return the lowest value of the data stored in this data field.- Returns:
- string version of the value.
-
setValueRangeFrom
Set up the lowest value of the data stored in this data field.- Parameters:
valueRangeFrom
- string version of the value.
-
getValueRangeTo
Return the upper value of the data stored in this data field.- Returns:
- string version of the value.
-
setValueRangeTo
Set up the upper value of the data stored in this data field.- Parameters:
valueRangeTo
- string version of the value.
-
getAverageValue
Return the average (mean) value of the values stored in the data field.- Returns:
- string version of the value.
-
setAverageValue
Set up the average (mean) value of the values stored in the data field.- Parameters:
averageValue
- string version of the value.
-
toString
Standard toString method.- Overrides:
toString
in classDataFieldAnnotation
- Returns:
- print out of variables in a JSON-style
-
equals
Compare the values of the supplied object with those stored in the current object.- Overrides:
equals
in classAnnotation
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Create a hash code for this element type.- Overrides:
hashCode
in classAnnotation
- Returns:
- int hash code
-