Package org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.graph

Class GlossaryAuthorViewGraphClient

java.lang.Object

org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.graph.GlossaryAuthorViewGraphClient

All Implemented Interfaces:

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

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

The class acts as a wrapper class for calling the REST services for Glossary Author Graph related services.

Constructor Summary

Constructors

Constructor	Description
GlossaryAuthorViewGraphClient(GlossaryAuthorViewRestClient client)

Method Summary

Modifier and Type	Method	Description
org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph	create(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph graph)	Create a Graph.
org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder	createGraphQuery(org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.NeighborhoodHistoricalFindRequest request)
void	delete(String userId, String guid)	Delete a Graph.
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph>	find(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Find graphs
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph>	findAll(String userId)	Find Category
org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph	getByGUID(String userId, String guid)	Get a Graph.
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>	getCategories(String userId, String graphGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)	Find Category for a graph
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>	getCategoryChildren(String userId, String parentGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a Category
org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig	getConfig(String userId)	Get config for server
org.odpi.openmetadata.adminservices.configuration.properties.ViewServiceConfig	getGlossaryAuthViewServiceConfig(String userId)	Get service config for a particular view Service
org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph	getGraph(String userId, String guid, Date asOfTime, Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.NodeType> nodeFilter, Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.RelationshipType> relationshipFilter, org.odpi.openmetadata.accessservices.subjectarea.properties.enums.StatusFilter statusFilter)	Get graph for a particular node guid
org.odpi.openmetadata.viewservices.glossaryauthor.properties.GraphStatistics	getGraphStatistics(String userId, String guid, Date asOfTime, Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.NodeType> nodeFilter, Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.RelationshipType> relationshipFilter, org.odpi.openmetadata.accessservices.subjectarea.properties.enums.StatusFilter statusFilter)	Get graphStats for a particular guid
List<org.odpi.openmetadata.adminservices.configuration.properties.ViewServiceConfig>	getViewServiceConfigs(String userId)	Get list of view service config on the server
Class<? extends org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse>	responseType()
org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph	restore(String userId, String guid)	Restore a soft-deleted Graph.
org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph	update(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph graph, boolean isReplace)	Update a Graph.

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

Constructor Details

GlossaryAuthorViewGraphClient

public GlossaryAuthorViewGraphClient(GlossaryAuthorViewRestClient client)

Method Details

create

public org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph create(String userId,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph graph)
                                                                                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewGraph

Create a Graph.

The result is the Graph object

Specified by:

create in interface GlossaryAuthorViewGraph

Parameters:

userId - userId under which the request is performed

graph - Graph object to be created

Returns:

The Graph

Throws:

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

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

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

update

public org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph update(String userId,
 String guid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph graph,
 boolean isReplace)
                                                                                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewGraph

Update a Graph.

The result is the updated Glossary object

Specified by:

update in interface GlossaryAuthorViewGraph

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be updated

graph - Glossary object with updated values

isReplace - If the object is to be replaced

Returns:

The updated Graph

Throws:

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

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

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

delete

public void delete(String userId,
 String guid)
            throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Description copied from interface: GlossaryAuthorViewGraph

Delete a Graph.

The result Void object

Specified by:

delete in interface GlossaryAuthorViewGraph

Parameters:

userId - userId under which the request is performed

guid - guid of Graph object to be retrieved

Throws:

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

restore

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

Description copied from interface: GlossaryAuthorViewGraph

Restore a soft-deleted Graph.

The result is the restored Graph object

Specified by:

restore in interface GlossaryAuthorViewGraph

Parameters:

userId - userId under which the request is performed

guid - guid of Graph object to be restored

Returns:

The restored Graph

Throws:

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

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

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

getCategoryChildren

public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> getCategoryChildren(String userId,
 String parentGuid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
 boolean exactValue,
 boolean ignoreCase)
                                                                                                                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: GlossaryAuthorViewGraph

Extract children within a Category

Specified by:

getCategoryChildren in interface GlossaryAuthorViewGraph

Parameters:

userId - calling user

parentGuid - Category GUID

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

exactValue - exactValue - when false values with trailing characters will match.

ignoreCase - ignore the case when matching.

Returns:

list of Categories

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.

findAll

public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph> findAll(String userId)
                                                                                              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: GlossaryAuthorViewGraph

Find Category

Specified by:

findAll in interface GlossaryAuthorViewGraph

Parameters:

userId - calling user

Returns:

Categories belonging to Userid

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.

getByGUID

public org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph getByGUID(String userId,
 String guid)
                                                                                          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: GlossaryAuthorViewGraph

Get a Graph.

The result is the requested Graph object

Specified by:

getByGUID in interface GlossaryAuthorViewGraph

Parameters:

userId - userId under which the request is performed

guid - guid of Graph object to be retrieved

Returns:

The requested Graph

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.

find

public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph> find(String userId,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
 boolean exactValue,
 boolean ignoreCase)
                                                                                           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: GlossaryAuthorViewGraph

Find graphs

Specified by:

find in interface GlossaryAuthorViewGraph

Parameters:

userId - calling user

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

exactValue - exactValue - when false values with trailing characters will match.

ignoreCase - ignore the case when matching.

Returns:

list of Categories

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.

getCategories

public List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> getCategories(String userId,
 String graphGuid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
                                                                                                          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: GlossaryAuthorViewGraph

Find Category for a graph

Specified by:

getCategories in interface GlossaryAuthorViewGraph

Parameters:

userId - calling user

graphGuid - graph id

findRequest - nformation object for find calls. This include pageSize to limit the number of elements returned.

Returns:

Categories belonging to graph

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.

getConfig

public org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig getConfig(String userId)
                                                                                        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: GlossaryAuthorViewGraph

Get config for server

Specified by:

getConfig in interface GlossaryAuthorViewGraph

Parameters:

userId - calling user

Returns:

Config for view server

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.

getGlossaryAuthViewServiceConfig

public org.odpi.openmetadata.adminservices.configuration.properties.ViewServiceConfig getGlossaryAuthViewServiceConfig(String userId)
                                                                                                                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: GlossaryAuthorViewGraph

Get service config for a particular view Service

Specified by:

getGlossaryAuthViewServiceConfig in interface GlossaryAuthorViewGraph

Parameters:

userId - calling user

Returns:

Config for view server

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.

getGraphStatistics

public org.odpi.openmetadata.viewservices.glossaryauthor.properties.GraphStatistics getGraphStatistics(String userId,
 String guid,
 Date asOfTime,
 Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.NodeType> nodeFilter,
 Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.RelationshipType> relationshipFilter,
 org.odpi.openmetadata.accessservices.subjectarea.properties.enums.StatusFilter statusFilter)
                                                                                                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: GlossaryAuthorViewGraph

Get graphStats for a particular guid

Specified by:

getGraphStatistics in interface GlossaryAuthorViewGraph

Parameters:

userId - calling user

guid - Guid for a node.

asOfTime - Requests a historical query of the relationships for the entity. Null means return the present values.

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

relationshipFilter - Set of relationship names to include in the query results. Null means include all relationships found, irrespective of their type.

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

Returns:

A graph statistics of nodeTypes.

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.

getGraph

public org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph getGraph(String userId,
 String guid,
 Date asOfTime,
 Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.NodeType> nodeFilter,
 Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.RelationshipType> relationshipFilter,
 org.odpi.openmetadata.accessservices.subjectarea.properties.enums.StatusFilter statusFilter)
                                                                                         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: GlossaryAuthorViewGraph

Get graph for a particular node guid

Specified by:

getGraph in interface GlossaryAuthorViewGraph

Parameters:

userId - calling user

guid - the starting point of the query.

asOfTime - Requests a historical query of the relationships for the entity. Null means return the present values.

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

relationshipFilter - Set of relationship names to include in the query results. Null means include all relationships found, irrespective of their type.

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

Returns:

A graph of nodeTypes.

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 org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder createGraphQuery(org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.NeighborhoodHistoricalFindRequest request)

getViewServiceConfigs

public List<org.odpi.openmetadata.adminservices.configuration.properties.ViewServiceConfig> getViewServiceConfigs(String userId)
                                                                                                           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: GlossaryAuthorViewGraph

Get list of view service config on the server

Specified by:

getViewServiceConfigs in interface GlossaryAuthorViewGraph

Parameters:

userId - calling user

Returns:

Config for view server

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.

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>