Package org.odpi.openmetadata.frameworks.integration.bitol.odcs

Class DataContractSchemaObject

java.lang.Object

org.odpi.openmetadata.frameworks.integration.bitol.odcs.DataContractSchemaElement

org.odpi.openmetadata.frameworks.integration.bitol.odcs.DataContractSchemaObject

public class DataContractSchemaObject
extends DataContractSchemaElement

This class represents a schema object (typically a table, view, topic or file) in an Open Data Contract Standard (ODCS) data contract. The schema object has a list of properties (columns/fields), relationships to other schema objects and data quality checks.

Constructor Summary

Constructors

Constructor	Description
DataContractSchemaObject()	Default 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.
BitolContext	getContext()	Return the AI and semantic context block for this schema object.
String	getDataGranularityDescription()	Return the description of the granularity of the data, for example the aggregation level.
String	getLogicalType()	Return the logical type of the schema object.
List<DataContractSchemaProperty>	getProperties()	Return the list of properties (columns/fields) of the schema object.
List<DataContractQualityRule>	getQuality()	Return the list of data quality checks for this schema object.
List<DataContractRelationship>	getRelationships()	Return the list of relationships from this schema object to other schema objects.
int	hashCode()	Return hash code based on properties.
void	setContext(BitolContext context)	Set up the AI and semantic context block for this schema object.
void	setDataGranularityDescription(String dataGranularityDescription)	Set up the description of the granularity of the data, for example the aggregation level.
void	setLogicalType(String logicalType)	Set up the logical type of the schema object.
void	setProperties(List<DataContractSchemaProperty> properties)	Set up the list of properties (columns/fields) of the schema object.
void	setQuality(List<DataContractQualityRule> quality)	Set up the list of data quality checks for this schema object.
void	setRelationships(List<DataContractRelationship> relationships)	Set up the list of relationships from this schema object to other schema objects.
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.integration.bitol.odcs.DataContractSchemaElement

getAuthoritativeDefinitions, getBusinessName, getCustomProperties, getDeprecated, getDescription, getId, getName, getPhysicalName, getPhysicalType, getSynonyms, getTags, setAuthoritativeDefinitions, setBusinessName, setCustomProperties, setDeprecated, setDescription, setId, setName, setPhysicalName, setPhysicalType, setSynonyms, setTags

Methods inherited from class java.lang.Object

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

Constructor Details

DataContractSchemaObject

public DataContractSchemaObject()

Default constructor

Method Details

getLogicalType

public String getLogicalType()

Return the logical type of the schema object. The only standard value is object.

Returns:

string type name

setLogicalType

public void setLogicalType(String logicalType)

Set up the logical type of the schema object. The only standard value is object.

Parameters:

logicalType - string type name

getDataGranularityDescription

public String getDataGranularityDescription()

Return the description of the granularity of the data, for example the aggregation level.

Returns:

string description

setDataGranularityDescription

public void setDataGranularityDescription(String dataGranularityDescription)

Set up the description of the granularity of the data, for example the aggregation level.

Parameters:

dataGranularityDescription - string description

getProperties

public List<DataContractSchemaProperty> getProperties()

Return the list of properties (columns/fields) of the schema object.

Returns:

list of properties

setProperties

public void setProperties(List<DataContractSchemaProperty> properties)

Set up the list of properties (columns/fields) of the schema object.

Parameters:

properties - list of properties

getRelationships

public List<DataContractRelationship> getRelationships()

Return the list of relationships from this schema object to other schema objects.

Returns:

list of relationships

setRelationships

public void setRelationships(List<DataContractRelationship> relationships)

Set up the list of relationships from this schema object to other schema objects.

Parameters:

relationships - list of relationships

getQuality

public List<DataContractQualityRule> getQuality()

Return the list of data quality checks for this schema object.

Returns:

list of quality rules

setQuality

public void setQuality(List<DataContractQualityRule> quality)

Set up the list of data quality checks for this schema object.

Parameters:

quality - list of quality rules

getContext

public BitolContext getContext()

Return the AI and semantic context block for this schema object.

Returns:

BitolContext

setContext

public void setContext(BitolContext context)

Set up the AI and semantic context block for this schema object.

Parameters:

context - BitolContext

toString

public String toString()

Standard toString method.

Overrides:

toString in class DataContractSchemaElement

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 DataContractSchemaElement

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return hash code based on properties.

Overrides:

hashCode in class DataContractSchemaElement

Returns:

int