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, ResponseParameterization<Graph>

public class SubjectAreaGraphClient
extends Object
implements SubjectAreaGraph, ResponseParameterization<Graph>

Field Summary

Fields

Modifier and Type	Field	Description
protected SubjectAreaRestClient	client

Constructor Summary

Constructors

Constructor	Description
SubjectAreaGraphClient(SubjectAreaRestClient client)

Method Summary

Modifier and Type	Method	Description
QueryBuilder	createGraphQuery(NeighborhoodHistoricalFindRequest request)
Graph	getGraph(String userId, String guid, NeighborhoodHistoricalFindRequest request)	Get the graph of nodes and relationships radiating out from a node.
Class<? extends GenericResponse>	responseType()

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

Field Detail

client

protected final SubjectAreaRestClient client

Constructor Detail

SubjectAreaGraphClient

public SubjectAreaGraphClient(SubjectAreaRestClient client)

Method Detail

responseType

public Class<? extends GenericResponse> responseType()

Specified by:

responseType in interface ResponseParameterization<Graph>

getGraph

public Graph getGraph(String userId,
                      String guid,
                      NeighborhoodHistoricalFindRequest request)
               throws InvalidParameterException,
                      PropertyServerException,
                      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:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

createGraphQuery

public QueryBuilder createGraphQuery(NeighborhoodHistoricalFindRequest request)