Package org.odpi.openmetadata.governanceservers.openlineage.handlers

Class OpenLineageHandler

java.lang.Object

org.odpi.openmetadata.governanceservers.openlineage.handlers.OpenLineageHandler

public class OpenLineageHandler
extends Object

Constructor Summary

Constructors

Constructor	Description
OpenLineageHandler(OpenLineageQueryService openLineageQueryService)

Method Summary

Modifier and Type	Method	Description
LineageResponse	getElementHierarchy(ElementHierarchyRequest elementHierarchyRequest)	Returns a subraph representing the hierarchy of a certain node, based on the request
LineageVertexResponse	getEntityDetails(String guid)	Gets entity details.
LineageNodeNamesResponse	getNodes(NodeNamesSearchCriteria searchCriteria)	Gets nodes names of certain type with display name containing a certain value - case insensitive
LineageTypesResponse	getTypes()	Gets available entities types from lineage repository.
LineageResponse	lineage(Scope scope, String guid, boolean includeProcesses)	Returns a lineage subgraph.
LineageSearchResponse	search(LineageSearchRequest request)	Gets entity details.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenLineageHandler

public OpenLineageHandler(OpenLineageQueryService openLineageQueryService)

Method Detail

lineage

public LineageResponse lineage(Scope scope,
                               String guid,
                               boolean includeProcesses)
                        throws OpenLineageException

Returns a lineage subgraph.

Parameters:

scope - source-and-destination, end-to-end, ultimate-source, ultimate-destination, glossary.

guid - The guid of the node of which the lineage is queried from.

includeProcesses -

Returns:

A subgraph containing all relevant paths, in graphSON format.

Throws:

OpenLineageException

getEntityDetails

public LineageVertexResponse getEntityDetails(String guid)

Gets entity details.

Parameters:

guid - the guid

Returns:

the entity details

search

public LineageSearchResponse search(LineageSearchRequest request)

Gets entity details.

Parameters:

request - the request

Returns:

the entity details

getTypes

public LineageTypesResponse getTypes()

Gets available entities types from lineage repository.

Returns:

the available entities types

getNodes

public LineageNodeNamesResponse getNodes(NodeNamesSearchCriteria searchCriteria)

Gets nodes names of certain type with display name containing a certain value - case insensitive

Parameters:

searchCriteria - contains the type of the node names to search for, a search string being part of the display name of the nodes, the maximum number of node names to retrieve

Returns:

the node names that match criteria

getElementHierarchy

public LineageResponse getElementHierarchy(ElementHierarchyRequest elementHierarchyRequest)

Returns a subraph representing the hierarchy of a certain node, based on the request

Parameters:

elementHierarchyRequest - contains the guid of the queried node and the hierarchyType of the display name of the nodes, the maximum number of node names to retrieve

Returns:

nodes and edges representing the element hierarchy