org.odpi.openmetadata.governanceservers.openlineage.maingraph

Class MainGraphConnectorBase

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.governanceservers.openlineage.maingraph.MainGraphConnectorBase

All Implemented Interfaces:

MainGraph, OpenLineageGraph

public abstract class MainGraphConnectorBase
extends ConnectorBase
implements MainGraph

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

ConnectorBase.ProtectedConnection

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, isActive, securedProperties

Constructor Summary

Constructors

Constructor and Description
MainGraphConnectorBase()

Method Summary

Modifier and Type	Method and Description
abstract void	dumpMainGraph() Write an entire graph to disc in the Egeria root folder, in the .GraphMl format.
abstract String	exportMainGraph() Write the maingraph to JSON (GraphSON) format.
abstract Object	getMainGraph() Allows the BufferGraphConnector to obtain an instance of mainGraph.
abstract void	initializeGraphDB() Initialize the mainGraph database.
abstract LineageResponse	lineage(Scope scope, View view, String guid, String displayNameMustContain, boolean includeProcesses) Returns a lineage subgraph.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

disconnect, equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, isActive, start, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.odpi.openmetadata.governanceservers.openlineage.OpenLineageGraph

start

Constructor Detail

MainGraphConnectorBase

public MainGraphConnectorBase()

Method Detail

initializeGraphDB

public abstract void initializeGraphDB()
                                throws OpenLineageException

Initialize the mainGraph database.

Specified by:

initializeGraphDB in interface MainGraph

Throws:

OpenLineageException

lineage

public abstract LineageResponse lineage(Scope scope,
                                        View view,
                                        String guid,
                                        String displayNameMustContain,
                                        boolean includeProcesses)
                                 throws OpenLineageException

Returns a lineage subgraph.

Specified by:

lineage in interface MainGraph

Parameters:

scope - The specific lineage query.

view - The view queried by the user.

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

displayNameMustContain - Used to filter out nodes which displayname does not contain this value.

includeProcesses - Will filter out all processes and subprocesses from the response if false.

Returns:

A subgraph containing all relevant paths, in graphSON format.

Throws:

OpenLineageException

dumpMainGraph

public abstract void dumpMainGraph()

Write an entire graph to disc in the Egeria root folder, in the .GraphMl format.

Specified by:

dumpMainGraph in interface MainGraph

exportMainGraph

public abstract String exportMainGraph()

Write the maingraph to JSON (GraphSON) format.

Specified by:

exportMainGraph in interface MainGraph

Returns:

The queried graph, in graphSON format.

getMainGraph

public abstract Object getMainGraph()

Allows the BufferGraphConnector to obtain an instance of mainGraph. Is of type Object so that OpenLineageServerOperationalServices will not require a dependency on Janusgraph.

Specified by:

getMainGraph in interface MainGraph

Returns:

main graph object