Package org.odpi.openmetadata.frameworks.integration.openlineage

Class OpenLineageDataSetFacets

java.lang.Object

org.odpi.openmetadata.frameworks.integration.openlineage.OpenLineageDataSetFacets

public class OpenLineageDataSetFacets
extends Object

This class represents the map of dataset facets for a dataset. The standard facets from the OpenLineage spec, and the custom facets registered in the OpenLineage registry, are held in named properties. Any other facets (custom facets, or standard facets not yet modelled) are held in the additionalProperties map, keyed by their facet name, so that nothing is lost on a round trip through these beans. The map key of each facet in the JSON is the facet's key from the OpenLineage spec.

Constructor Summary

Constructors

Constructor	Description
OpenLineageDataSetFacets()	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.
Map<String,OpenLineageDataSetFacet>	getAdditionalProperties()	Return any additional facets that are not modelled as named properties.
OpenLineageCatalogDataSetFacet	getCatalog()	Return the catalog facet.
OpenLineageColumnLineageDataSetFacet	getColumnLineage()	Return the columnLineage facet.
OpenLineageDataQualityMetricsDataSetFacet	getDataQualityMetrics()	Return the dataQualityMetrics facet.
OpenLineageDataSetTypeDataSetFacet	getDatasetType()	Return the datasetType facet.
OpenLineageDataSourceDataSetFacet	getDataSource()	Return the dataSource facet.
OpenLineageDocumentationDataSetFacet	getDocumentation()	Return the documentation facet.
OpenLineageHierarchyDataSetFacet	getHierarchy()	Return the hierarchy facet.
OpenLineageLifecycleStateChangeDataSetFacet	getLifecycleStateChange()	Return the lifecycleStateChange facet.
OpenLineageLineageDataSetFacet	getLineage()	Return the lineage facet.
OpenLineageOwnershipDataSetFacet	getOwnership()	Return the ownership facet.
OpenLineageSchemaDataSetFacet	getSchema()	Return the schema facet.
OpenLineageStorageDataSetFacet	getStorage()	Return the storage facet.
OpenLineageSymlinksDataSetFacet	getSymlinks()	Return the symlinks facet.
OpenLineageTagsDataSetFacet	getTags()	Return the tags facet.
OpenLineageDataSetVersionDataSetFacet	getVersion()	Return the version facet.
int	hashCode()	Return hash code based on properties.
void	setAdditionalProperties(Map<String,OpenLineageDataSetFacet> additionalProperties)	Set up any additional facets that are not modelled as named properties.
void	setAdditionalProperty(String facetName, OpenLineageDataSetFacet facet)	Add a facet that is not modelled as a named property.
void	setCatalog(OpenLineageCatalogDataSetFacet catalog)	Set up the catalog facet.
void	setColumnLineage(OpenLineageColumnLineageDataSetFacet columnLineage)	Set up the columnLineage facet.
void	setDataQualityMetrics(OpenLineageDataQualityMetricsDataSetFacet dataQualityMetrics)	Set up the dataQualityMetrics facet.
void	setDatasetType(OpenLineageDataSetTypeDataSetFacet datasetType)	Set up the datasetType facet.
void	setDataSource(OpenLineageDataSourceDataSetFacet dataSource)	Set up the dataSource facet.
void	setDocumentation(OpenLineageDocumentationDataSetFacet documentation)	Set up the documentation facet.
void	setHierarchy(OpenLineageHierarchyDataSetFacet hierarchy)	Set up the hierarchy facet.
void	setLifecycleStateChange(OpenLineageLifecycleStateChangeDataSetFacet lifecycleStateChange)	Set up the lifecycleStateChange facet.
void	setLineage(OpenLineageLineageDataSetFacet lineage)	Set up the lineage facet.
void	setOwnership(OpenLineageOwnershipDataSetFacet ownership)	Set up the ownership facet.
void	setSchema(OpenLineageSchemaDataSetFacet schema)	Set up the schema facet.
void	setStorage(OpenLineageStorageDataSetFacet storage)	Set up the storage facet.
void	setSymlinks(OpenLineageSymlinksDataSetFacet symlinks)	Set up the symlinks facet.
void	setTags(OpenLineageTagsDataSetFacet tags)	Set up the tags facet.
void	setVersion(OpenLineageDataSetVersionDataSetFacet version)	Set up the version facet.
String	toString()	Standard toString method.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenLineageDataSetFacets

public OpenLineageDataSetFacets()

Default constructor

Method Details

getDocumentation

public OpenLineageDocumentationDataSetFacet getDocumentation()

Return the documentation facet.

Returns:

facet bean

setDocumentation

public void setDocumentation(OpenLineageDocumentationDataSetFacet documentation)

Set up the documentation facet.

Parameters:

documentation - facet bean

getDataSource

public OpenLineageDataSourceDataSetFacet getDataSource()

Return the dataSource facet.

Returns:

facet bean

setDataSource

public void setDataSource(OpenLineageDataSourceDataSetFacet dataSource)

Set up the dataSource facet.

Parameters:

dataSource - facet bean

getSchema

public OpenLineageSchemaDataSetFacet getSchema()

Return the schema facet.

Returns:

facet bean

setSchema

public void setSchema(OpenLineageSchemaDataSetFacet schema)

Set up the schema facet.

Parameters:

schema - facet bean

getCatalog

public OpenLineageCatalogDataSetFacet getCatalog()

Return the catalog facet.

Returns:

facet bean

setCatalog

public void setCatalog(OpenLineageCatalogDataSetFacet catalog)

Set up the catalog facet.

Parameters:

catalog - facet bean

getColumnLineage

public OpenLineageColumnLineageDataSetFacet getColumnLineage()

Return the columnLineage facet.

Returns:

facet bean

setColumnLineage

public void setColumnLineage(OpenLineageColumnLineageDataSetFacet columnLineage)

Set up the columnLineage facet.

Parameters:

columnLineage - facet bean

getDatasetType

public OpenLineageDataSetTypeDataSetFacet getDatasetType()

Return the datasetType facet.

Returns:

facet bean

setDatasetType

public void setDatasetType(OpenLineageDataSetTypeDataSetFacet datasetType)

Set up the datasetType facet.

Parameters:

datasetType - facet bean

getVersion

public OpenLineageDataSetVersionDataSetFacet getVersion()

Return the version facet.

Returns:

facet bean

setVersion

public void setVersion(OpenLineageDataSetVersionDataSetFacet version)

Set up the version facet.

Parameters:

version - facet bean

getLifecycleStateChange

public OpenLineageLifecycleStateChangeDataSetFacet getLifecycleStateChange()

Return the lifecycleStateChange facet.

Returns:

facet bean

setLifecycleStateChange

public void setLifecycleStateChange(OpenLineageLifecycleStateChangeDataSetFacet lifecycleStateChange)

Set up the lifecycleStateChange facet.

Parameters:

lifecycleStateChange - facet bean

getOwnership

public OpenLineageOwnershipDataSetFacet getOwnership()

Return the ownership facet.

Returns:

facet bean

setOwnership

public void setOwnership(OpenLineageOwnershipDataSetFacet ownership)

Set up the ownership facet.

Parameters:

ownership - facet bean

getStorage

public OpenLineageStorageDataSetFacet getStorage()

Return the storage facet.

Returns:

facet bean

setStorage

public void setStorage(OpenLineageStorageDataSetFacet storage)

Set up the storage facet.

Parameters:

storage - facet bean

getSymlinks

public OpenLineageSymlinksDataSetFacet getSymlinks()

Return the symlinks facet.

Returns:

facet bean

setSymlinks

public void setSymlinks(OpenLineageSymlinksDataSetFacet symlinks)

Set up the symlinks facet.

Parameters:

symlinks - facet bean

getTags

public OpenLineageTagsDataSetFacet getTags()

Return the tags facet.

Returns:

facet bean

setTags

public void setTags(OpenLineageTagsDataSetFacet tags)

Set up the tags facet.

Parameters:

tags - facet bean

getHierarchy

public OpenLineageHierarchyDataSetFacet getHierarchy()

Return the hierarchy facet.

Returns:

facet bean

setHierarchy

public void setHierarchy(OpenLineageHierarchyDataSetFacet hierarchy)

Set up the hierarchy facet.

Parameters:

hierarchy - facet bean

getLineage

public OpenLineageLineageDataSetFacet getLineage()

Return the lineage facet.

Returns:

facet bean

setLineage

public void setLineage(OpenLineageLineageDataSetFacet lineage)

Set up the lineage facet.

Parameters:

lineage - facet bean

getDataQualityMetrics

public OpenLineageDataQualityMetricsDataSetFacet getDataQualityMetrics()

Return the dataQualityMetrics facet.

Returns:

facet bean

setDataQualityMetrics

public void setDataQualityMetrics(OpenLineageDataQualityMetricsDataSetFacet dataQualityMetrics)

Set up the dataQualityMetrics facet.

Parameters:

dataQualityMetrics - facet bean

getAdditionalProperties

public Map<String,OpenLineageDataSetFacet> getAdditionalProperties()

Return any additional facets that are not modelled as named properties. They are serialized as top-level facet entries alongside the named facets.

Returns:

map of facet name to facet

setAdditionalProperties

public void setAdditionalProperties(Map<String,OpenLineageDataSetFacet> additionalProperties)

Set up any additional facets that are not modelled as named properties.

Parameters:

additionalProperties - map of facet name to facet

setAdditionalProperty

public void setAdditionalProperty(String facetName,
 OpenLineageDataSetFacet facet)

Add a facet that is not modelled as a named property. Jackson calls this for each unrecognized facet found in the JSON.

Parameters:

facetName - name (key) of the facet

facet - facet bean

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

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 Object

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return hash code based on properties.

Overrides:

hashCode in class Object

Returns:

int