Package org.odpi.openmetadata.frameworks.discovery.properties

Class SchemaAnalysisAnnotation

java.lang.Object

org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase

org.odpi.openmetadata.frameworks.discovery.properties.Annotation

org.odpi.openmetadata.frameworks.discovery.properties.SchemaAnalysisAnnotation

All Implemented Interfaces:

Serializable

public class SchemaAnalysisAnnotation
extends Annotation

SchemaAnalysisAnnotation is used to describe the results of reviewing the structure of the content of an asset. This structure is expressed as what is called a schema. Of then the schema describes a set of nested data fields that each have a name and a type.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor	Description
SchemaAnalysisAnnotation()	Default constructor
SchemaAnalysisAnnotation(SchemaAnalysisAnnotation template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
int	getDiscoveredDataFields()	Return the number of discovered data fields in this schema.
String	getSchemaName()	Return the name of the schema - this will be used in the creation of the schema object and reflects the content associated with the asset.
String	getSchemaTypeName()	Return the name of the schema type for this asset.
int	hashCode()	Create a hash code for this element type.
void	setDiscoveredDataFields(int discoveredDataFields)	Set up the number of discovered data fields in this schema.
void	setSchemaName(String schemaName)	Set up the name of the schema - this will be used in the creation of the schema object and reflects the content associated with the asset.
void	setSchemaTypeName(String schemaTypeName)	Set up the name of the schema type for this asset.
String	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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SchemaAnalysisAnnotation

public SchemaAnalysisAnnotation()

Default constructor

SchemaAnalysisAnnotation

public SchemaAnalysisAnnotation(SchemaAnalysisAnnotation template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

getSchemaName

public String getSchemaName()

Return the name of the schema - this will be used in the creation of the schema object and reflects the content associated with the asset. The schema that is created/validated is unique to the asset.

Returns:

name of schema

setSchemaName

public void setSchemaName(String schemaName)

Set up the name of the schema - this will be used in the creation of the schema object and reflects the content associated with the asset. The schema that is created/validated is unique to the asset.

Parameters:

schemaName - name of schema

getSchemaTypeName

public String getSchemaTypeName()

Return the name of the schema type for this asset.

Returns:

name

setSchemaTypeName

public void setSchemaTypeName(String schemaTypeName)

Set up the name of the schema type for this asset.

Parameters:

schemaTypeName - name

getDiscoveredDataFields

public int getDiscoveredDataFields()

Return the number of discovered data fields in this schema.

Returns:

integer

setDiscoveredDataFields

public void setDiscoveredDataFields(int discoveredDataFields)

Set up the number of discovered data fields in this schema.

Parameters:

discoveredDataFields - integer

toString

public String toString()

Standard toString method.

Overrides:

toString in class Annotation

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