Class SubjectAreaGraphHandler
java.lang.Object
org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaHandler
org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaGraphHandler
The SubjectAreaRESTServicesInstance provides the org.odpi.openmetadata.accessservices.subjectarea.server-side implementation of the SubjectArea Open Metadata
Access Service (OMAS). This interface provides glossary authoring interfaces for subject area experts.
-
Field Summary
Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaHandler
genericHandler, invalidParameterHandler, mappersFactory, maxPageSize
-
Constructor Summary
ConstructorDescriptionSubjectAreaGraphHandler
(OpenMetadataAPIGenericHandler genericHandler, int maxPageSize) Construct the Subject Area Graph Handler needed to operate within a single server instance. -
Method Summary
Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaHandler
convertOmrsToOmas, findNodes, getAllRelationshipForEntity, getAllRelationshipsForEntity, getMaxPageSize, getNodesFromEntityDetails, getRelationshipsForEntityByType, getRelationshipsFromRelationships, sanitiseFindRequest, sanitiseFindRequest, setNodeEffectivity, setRelationshipEffectivity, setUniqueQualifiedNameIfBlank, validateGlossarySummaryDuringCreation
-
Constructor Details
-
SubjectAreaGraphHandler
Construct the Subject Area Graph Handler needed to operate within a single server instance.- Parameters:
genericHandler
- generic handlermaxPageSize
- maximum page size
-
-
Method Details
-
getGraph
public SubjectAreaOMASAPIResponse<Graph> getGraph(String userId, String guid, Date asOfTime, String nodeFilterStr, String relationshipFilterStr, StatusFilter statusFilter, Integer level) Get the graph of nodes and relationships radiating out from a node.Return the nodes and relationships that radiate out from the supplied node (identified by a GUID). The results are scoped by types of relationships, types of nodes and classifications as well as level.
- Parameters:
userId
- userId under which the request is performedguid
- the starting point of the query.nodeFilterStr
- Comma separated list of node names to include in the query results. Null means include all entities found, irrespective of their type.relationshipFilterStr
- comma separated list of relationship names to include in the query results. Null means include all relationships found, irrespective of their type.asOfTime
- Requests a historical query of the relationships for the entity. Null means return the present values.statusFilter
- By default only active instances are returned. Specify ALL to see all instance in any status.level
- the number of the relationships (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 nodeTypes.
- UnrecognizedGUIDException the supplied guid was not recognised
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- MetadataServerUncontactableException not able to communicate with a Metadata respository service.
- InvalidParameterException one of the parameters is null or invalid.
- FunctionNotSupportedException Function not supported this indicates that a find was issued but the repository does not implement find functionality in some way.
-