org.odpi.openmetadata.accessservices.subjectarea.client

Class SubjectAreaGraphImpl

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl

org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaGraphImpl

All Implemented Interfaces:

SubjectAreaGraph

public class SubjectAreaGraphImpl
extends SubjectAreaBaseImpl
implements SubjectAreaGraph

SubjectAreaImpl is the OMAS client library implementation of the Subject Area OMAS. This interface provides graph interface for subject area experts.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor and Description
SubjectAreaGraphImpl(String serverName, String serverPlatformURLRoot) Constructor for no authentication.

Method Summary

Modifier and Type	Method and Description
Graph	getGraph(String userId, String guid, Date asOfTime, Set<NodeType> nodeFilter, Set<LineType> lineFilter, StatusFilter statusFilter, Integer level) Get the graph of nodes and Lines radiating out from a node.

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl

deleteEntityRESTCall, deleteRelationshipRESTCall, encodeQueryProperty, findRESTCall, getByIdRESTCall, getRelationships, postRESTCall, purgeEntityRESTCall, purgeRelationshipRESTCall, putRESTCall, restoreRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

callDeleteRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaGraphImpl

public SubjectAreaGraphImpl(String serverName,
                            String serverPlatformURLRoot)
                     throws InvalidParameterException

Constructor for no authentication.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

getGraph

public Graph getGraph(String userId,
                      String guid,
                      Date asOfTime,
                      Set<NodeType> nodeFilter,
                      Set<LineType> lineFilter,
                      StatusFilter statusFilter,
                      Integer level)
               throws UserNotAuthorizedException,
                      InvalidParameterException,
                      FunctionNotSupportedException,
                      MetadataServerUncontactableException,
                      UnexpectedResponseException,
                      PropertyServerException

Description copied from interface: SubjectAreaGraph

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

The results are scoped by types of Lines, 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.

asOfTime - Requests a historical query of the Lines for the node. Null means return the present values.

nodeFilter - Set of the names of the nodes to include in the query results. Null means include all nodes found, irrespective of their type.

lineFilter - Set of names of Lines to include in the query results. Null means include all Lines found, irrespective of their type.

statusFilter - By default only active instances are returned. Specify ALL to see all instance in any status.

level - the number of the Lines (relationships) out from the starting node that the query will traverse to gather results. If not specified then it defaults to 3.

Returns:

A graph of nodes.

Exceptions returned by the server

Throws:

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

InvalidParameterException - one of the parameters is null or invalid.

FunctionNotSupportedException - Function not supported

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

PropertyServerException - property server exception

Client library Exceptions