Package co.arago.hiro.client.rest

Class GraphAPI.QueryVerticesCommand

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.QueryVerticesCommand,HiroVertexListMessage>

co.arago.hiro.client.rest.GraphAPI.QueryVerticesCommand

Enclosing class:

GraphAPI

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

query vertices

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

See Also:

API Documentation, ElasticSearch 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	QueryVerticesCommand(java.lang.String query)

Method Summary

Modifier and Type	Method	Description
HiroVertexListMessage	execute()
protected GraphAPI.QueryVerticesCommand	self()
GraphAPI.QueryVerticesCommand	setCount(java.lang.Boolean count)	Set count
GraphAPI.QueryVerticesCommand	setLimit(java.lang.Integer limit)	Set limit
GraphAPI.QueryVerticesCommand	setOffset(java.lang.Integer offset)	Set offset
GraphAPI.QueryVerticesCommand	setOrder(java.lang.String order)	Set order

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

QueryVerticesCommand

protected QueryVerticesCommand(java.lang.String query)

Parameters:

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

Method Detail

setLimit

public GraphAPI.QueryVerticesCommand setLimit(java.lang.Integer limit)

Set limit

Parameters:

limit - limit of entries to return

Returns:

this

setOffset

public GraphAPI.QueryVerticesCommand setOffset(java.lang.Integer offset)

Set offset

Parameters:

offset - offset where to start returning entries

Returns:

this

setOrder

public GraphAPI.QueryVerticesCommand setOrder(java.lang.String order)

Set order

Parameters:

order - order by a field asc|desc, e.g. ogit/name desc.

Returns:

this

setCount

public GraphAPI.QueryVerticesCommand setCount(java.lang.Boolean count)

Set count

Parameters:

count - return number of matching elements

Returns:

this

self

protected GraphAPI.QueryVerticesCommand self()

Specified by:

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

execute

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

Specified by:

execute in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.QueryVerticesCommand,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.