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

Class OpenLineageFacet

java.lang.Object
org.odpi.openmetadata.frameworks.integration.openlineage.OpenLineageFacet
Direct Known Subclasses:
OpenLineageDataSetFacet, OpenLineageInputDataSetInputFacet, OpenLineageJobFacet, OpenLineageOutputDataSetOutputFacet, OpenLineageRunFacet
public abstract class OpenLineageFacet extends Object
This class represents the common header for facets in the OpenLineage standard spec https://openlineage.io/spec/2-0-2/OpenLineage.json#/$defs/BaseFacet. Every facet carries the URI of the producer that created it and the URL of the schema that describes it. Any properties in the JSON that are not modelled by the subclass are held in additionalProperties so they survive a round trip through these beans.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenLineageFacet(URI schemaURL)
    Constructor that sets up the schema URL for the facet.

  • 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.
    URI
    get_producer()
    Return the URI identifying the producer of this metadata.
    URI
    get_schemaURL()
    Return the JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this facet.
    Map<String,Object>
    getAdditionalProperties()
    Return any properties of the facet that are not modelled by the bean.
    int
    hashCode()
    Return hash code based on properties.
    void
    set_producer(URI producer)
    Set up the URI identifying the producer of this metadata.
    void
    set_schemaURL(URI schemaURL)
    Set up the JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this facet.
    void
    setAdditionalProperties(Map<String,Object> additionalProperties)
    Set up any properties of the facet that are not modelled by the bean.
    void
    setAdditionalProperty(String propertyName, Object propertyValue)
    Add a property that is not modelled by the bean.
    String
    toString()
    Standard toString method.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OpenLineageFacet

      public OpenLineageFacet(URI schemaURL)
      Constructor that sets up the schema URL for the facet.
      Parameters:
      schemaURL - URL of the JSON schema that describes this facet

  • Method Details

    • get_producer

      public URI get_producer()
      Return the URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha.
      Returns:
      URI

    • set_producer

      public void set_producer(URI producer)
      Set up the URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha.
      Parameters:
      producer - URI

    • get_schemaURL

      public URI get_schemaURL()
      Return the JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this facet.
      Returns:
      URI

    • set_schemaURL

      public void set_schemaURL(URI schemaURL)
      Set up the JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this facet.
      Parameters:
      schemaURL - URI

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return any properties of the facet that are not modelled by the bean. They are serialized as top-level properties of the facet alongside the modelled properties.
      Returns:
      map of property name to value

    • setAdditionalProperties

      public void setAdditionalProperties(Map<String,Object> additionalProperties)
      Set up any properties of the facet that are not modelled by the bean.
      Parameters:
      additionalProperties - map of property name to value

    • setAdditionalProperty

      public void setAdditionalProperty(String propertyName, Object propertyValue)
      Add a property that is not modelled by the bean. Jackson calls this for each unrecognized property found in the JSON.
      Parameters:
      propertyName - name of the property
      propertyValue - value of the property

    • 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