Package org.odpi.openmetadata.userinterface.uichassis.springboot.service

Class OpenLineageService

java.lang.Object

org.odpi.openmetadata.userinterface.uichassis.springboot.service.OpenLineageService

@Service
@EnableConfigurationProperties(LineageGraphDisplayService.class)
public class OpenLineageService
extends Object

This class responsibility is to interact with Open Lineage Services(OLS), process the returned response and return it in a format understood by view

Constructor Summary

Constructors

Constructor	Description
OpenLineageService(LineageWarehouseClientWarehouse lineageWarehouseClient, LineageGraphDisplayService lineageGraphDisplayService)

Method Summary

Modifier and Type	Method	Description
Graph	getElementHierarchy(String userId, ElementHierarchyRequest elementHierarchyRequest)	Returns a subraph representing the hierarchy of a certain node, based on the request
Graph	getEndToEndLineage(String userId, String guid, boolean includeProcesses)
LineageVertex	getEntityDetails(String userId, String guid)	Gets node details.
List<String>	getNodes(String userId, String type, String searchValue, int limit)	Gets nodes names of certain type with display name containing a certain value.
List<String>	getTypes(String userId)	Gets available entities types from lineage repository.
Graph	getUltimateDestination(String userId, String guid, boolean includeProcesses)
Graph	getUltimateSource(String userId, String guid, boolean includeProcesses)
Graph	getVerticalLineage(String userId, String guid, boolean includeProcesses)
List<LineageVertex>	search(String userId, LineageSearchRequest lineageSearchRequest)	Gets node details.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenLineageService

@Autowired
public OpenLineageService(LineageWarehouseClientWarehouse lineageWarehouseClient,
 LineageGraphDisplayService lineageGraphDisplayService)

Parameters:

lineageWarehouseClient - client to connect to open lineage services

lineageGraphDisplayService - the rules for display

Method Details

getUltimateSource

public Graph getUltimateSource(String userId,
 String guid,
 boolean includeProcesses)
                        throws InvalidParameterException,
PropertyServerException,
LineageWarehouseException

Parameters:

userId - id of the user triggering the request

guid - unique identifier if the asset

includeProcesses - if true includes processes in the response

Returns:

map of nodes and edges describing the ultimate sources for the asset

Throws:

InvalidParameterException - from the underlying client

PropertyServerException - from the underlying client

LineageWarehouseException - from the underlying client

getEndToEndLineage

public Graph getEndToEndLineage(String userId,
 String guid,
 boolean includeProcesses)
                         throws InvalidParameterException,
PropertyServerException,
LineageWarehouseException

Parameters:

userId - id of the user triggering the request

guid - unique identifier if the asset

includeProcesses - if true includes processes in the response

Returns:

map of nodes and edges describing the end to end flow

Throws:

InvalidParameterException - from the underlying client

PropertyServerException - from the underlying client

LineageWarehouseException - from the underlying client

getUltimateDestination

public Graph getUltimateDestination(String userId,
 String guid,
 boolean includeProcesses)
                             throws InvalidParameterException,
PropertyServerException,
LineageWarehouseException

Parameters:

userId - id of the user triggering the request

guid - unique identifier if the asset

includeProcesses - if true includes processes in the response

Returns:

map of nodes and edges describing the ultimate destinations of the asset

Throws:

InvalidParameterException - from the underlying client

PropertyServerException - from the underlying client

LineageWarehouseException - from the underlying client

getVerticalLineage

public Graph getVerticalLineage(String userId,
 String guid,
 boolean includeProcesses)
                         throws InvalidParameterException,
PropertyServerException,
LineageWarehouseException

Parameters:

userId - id of the user triggering the request

guid - unique identifier if the asset

includeProcesses - if true includes processes in the response

Returns:

map of nodes and edges describing the glossary terms linked to the asset

Throws:

InvalidParameterException - from the underlying client

PropertyServerException - from the underlying client

LineageWarehouseException - from the underlying client

getEntityDetails

public LineageVertex getEntityDetails(String userId,
 String guid)
                               throws InvalidParameterException,
PropertyServerException,
LineageWarehouseException

Gets node details.

Parameters:

userId - the user id

guid - the guid

Returns:

the node details

Throws:

InvalidParameterException - from the underlying client

PropertyServerException - from the underlying client

LineageWarehouseException - from the underlying client

search

public List<LineageVertex> search(String userId,
 LineageSearchRequest lineageSearchRequest)
                           throws InvalidParameterException,
PropertyServerException,
LineageWarehouseException

Gets node details.

Parameters:

userId - the user id

lineageSearchRequest - the body for search

Returns:

the node details

Throws:

InvalidParameterException - from the underlying client

PropertyServerException - from the underlying client

LineageWarehouseException - from the underlying client

getTypes

public List<String> getTypes(String userId)

Gets available entities types from lineage repository.

Parameters:

userId - user ID

Returns:

the available entities types

getNodes

public List<String> getNodes(String userId,
 String type,
 String searchValue,
 int limit)

Gets nodes names of certain type with display name containing a certain value.

Parameters:

userId - user ID

type - the type of the nodes name to search for

searchValue - the string to be contained in the qualified name of the node - case insensitive

limit - the maximum number of node names to retrieve

Returns:

the list of node names

getElementHierarchy

public Graph getElementHierarchy(String userId,
 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

Returns:

a subgraph containing all relevant paths,