Package co.arago.hiro.client.rest

Class GraphAPI.QueryGremlinCommand

java.lang.Object

co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf<T,R>

co.arago.hiro.client.rest.AuthenticatedAPIHandler.SendBodyAPIRequestConf<T,R>

co.arago.hiro.client.rest.GraphAPI.QueryBodyConf<GraphAPI.QueryGremlinCommand,HiroVertexListMessage>

co.arago.hiro.client.rest.GraphAPI.QueryGremlinCommand

Enclosing class:

GraphAPI

public class GraphAPI.QueryGremlinCommand
extends GraphAPI.QueryBodyConf<GraphAPI.QueryGremlinCommand,HiroVertexListMessage>

query gremlin

API POST /api/graph/[version]/query/gremlin

See Also:

API Documentation, Gremlin query syntax

Field Summary

Fields inherited from class co.arago.hiro.client.rest.GraphAPI.QueryBodyConf

bodyMap

Fields inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.SendBodyAPIRequestConf

body

Fields inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf

fragment, headers, httpRequestTimeout, maxRetries, path, query

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QueryGremlinCommand(java.lang.String ogitId, java.lang.String query)

Method Summary

Modifier and Type	Method	Description
HiroVertexListMessage	execute()
protected GraphAPI.QueryGremlinCommand	self()

Methods inherited from class co.arago.hiro.client.rest.GraphAPI.QueryBodyConf

addToBody, createBody, setFields, setIncludeDeleted, setListMeta

Methods inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.SendBodyAPIRequestConf

setBody, setJsonBodyFromMap, setJsonBodyFromMessage

Methods inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf

setHttpHeaders, setHttpRequestTimeout, setMaxRetries, setUrlFragment, setUrlQuery

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryGremlinCommand

protected QueryGremlinCommand(java.lang.String ogitId,
                              java.lang.String query)

Parameters:

ogitId - The root ogitId to start the query from.

query - The query string, e.g. ogit\/_type: ogit\/Question.

Method Detail

self

protected GraphAPI.QueryGremlinCommand self()

Specified by:

self in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.QueryGremlinCommand,HiroVertexListMessage>

execute

public HiroVertexListMessage execute()
                              throws HiroException,
                                     java.io.IOException,
                                     java.lang.InterruptedException

Specified by:

execute in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.QueryGremlinCommand,HiroVertexListMessage>

Returns:

HiroVertexListMessage The Json Response

Throws:

HiroException - When the call returns a http status error.

java.io.IOException - When the call got an IO error.

java.lang.InterruptedException - When the call gets interrupted.