Package org.odpi.openmetadata.accessservices.subjectarea.client.relationships

Class SubjectAreaGraphClient

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.client.relationships.SubjectAreaGraphClient

All Implemented Interfaces:

SubjectAreaGraph, org.odpi.openmetadata.commonservices.ffdc.rest.ResponseParameterization<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph>

public class SubjectAreaGraphClient
extends Object
implements SubjectAreaGraph, org.odpi.openmetadata.commonservices.ffdc.rest.ResponseParameterization<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph>

Constructor Summary

Constructors

Constructor	Description
SubjectAreaGraphClient(SubjectAreaRestClient client)

Method Summary

Modifier and Type	Method	Description
QueryBuilder	createGraphQuery(org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.NeighborhoodHistoricalFindRequest request)
org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph	getGraph(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.NeighborhoodHistoricalFindRequest request)	Get the graph of nodes and relationships radiating out from a node.
Class<? extends org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse>	responseType()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.odpi.openmetadata.commonservices.ffdc.rest.ResponseParameterization

getParameterizedType, resultType

Methods inherited from interface org.odpi.openmetadata.accessservices.subjectarea.client.relationships.SubjectAreaGraph

getGraph

Constructor Details

SubjectAreaGraphClient

public SubjectAreaGraphClient(SubjectAreaRestClient client)

Method Details

responseType

public Class<? extends org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse> responseType()

Specified by:

responseType in interface org.odpi.openmetadata.commonservices.ffdc.rest.ResponseParameterization<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph>

getGraph

public org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph getGraph(String userId,
 String guid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.NeighborhoodHistoricalFindRequest request)
                                                                                         throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Description copied from interface: SubjectAreaGraph

Get the graph of nodes and relationships radiating out from a node.

The results are scoped by types of relationships, types of nodes and classifications as well as level.

Specified by:

getGraph in interface SubjectAreaGraph

Parameters:

userId - userId under which the request is performed

guid - the starting point of the query.

request - NeighborhoodHistoricalFindRequest

Returns:

A graph of nodes.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

createGraphQuery

public QueryBuilder createGraphQuery(org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.NeighborhoodHistoricalFindRequest request)