Package org.onyx.api

Class Action.SumBuilder

java.lang.Object

org.onyx.api.BaseQueryBuilder<Action.SumBuilder>

org.onyx.api.Action.SumBuilder

Enclosing class:

Action

public static class Action.SumBuilder
extends BaseQueryBuilder<Action.SumBuilder>

A builder class for querying actionsums in the ledger.

Field Summary

Fields inherited from class org.onyx.api.BaseQueryBuilder

next

Constructor Summary

Constructors

Constructor	Description
SumBuilder()

Method Summary

Modifier and Type	Method	Description
Action.SumBuilder	addGroupByField(String field)	Adds a field along which action values will be summed.
ActionSum.ItemIterable	getIterable(Client client)	Executes the query, returning an iterable over actionsums that match the query.
ActionSum.Page	getPage(Client client)	Executes the query, returning a page of actionsums that match the query.
ActionSum.Page	getPage(Client client, String cursor)	Executes the query, returning a page of actionsums that match the query beginning with provided cursor.
Action.SumBuilder	setGroupBy(List<String> groupBy)	Specifies the fields along which action values will be summed.

Methods inherited from class org.onyx.api.BaseQueryBuilder

addFilterParameter, setFilter, setFilterParameters, setPageSize

Methods inherited from class java.lang.Object

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

Constructor Details

SumBuilder

public SumBuilder()

Method Details

getPage

public ActionSum.Page getPage(Client client)
                       throws ChainException

Executes the query, returning a page of actionsums that match the query.

Specified by:

getPage in class BaseQueryBuilder<Action.SumBuilder>

Parameters:

client - ledger API connection object

Returns:

a page of actionsums

Throws:

ChainException

getPage

public ActionSum.Page getPage(Client client,
 String cursor)
                       throws ChainException

Executes the query, returning a page of actionsums that match the query beginning with provided cursor.

Parameters:

client - ledger API connection object

cursor - string representing encoded query object

Returns:

a page of actionsums

Throws:

ChainException

getIterable

public ActionSum.ItemIterable getIterable(Client client)
                                   throws ChainException

Executes the query, returning an iterable over actionsums that match the query.

Specified by:

getIterable in class BaseQueryBuilder<Action.SumBuilder>

Parameters:

client - ledger API connection object

Returns:

an iterable over actionsums

Throws:

ChainException

setGroupBy

public Action.SumBuilder setGroupBy(List<String> groupBy)

Specifies the fields along which action values will be summed.

Parameters:

groupBy - a list of action fields

Returns:

updated builder

addGroupByField

public Action.SumBuilder addGroupByField(String field)

Adds a field along which action values will be summed.

Parameters:

field - name of a action field

Returns:

updated builder