Package stroom.query.api.v2

Class ResultRequest.Builder

java.lang.Object

stroom.query.api.v2.ResultRequest.Builder

Enclosing class:

ResultRequest

public static class ResultRequest.Builder
extends java.lang.Object

Builder for constructing a ResultRequest

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ResultRequest.Builder	addMappings(TableSettings... values)
ResultRequest.Builder	addOpenGroups(java.lang.String... values)
ResultRequest	build()
ResultRequest.Builder	componentId(java.lang.String value)
ResultRequest.Builder	fetch(ResultRequest.Fetch value)
ResultRequest.Builder	requestedRange(OffsetRange value)
ResultRequest.Builder	resultStyle(ResultRequest.ResultStyle value)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

componentId

public ResultRequest.Builder componentId(java.lang.String value)

Parameters:

value - The ID of the component that will receive the results corresponding to this ResultRequest

Returns:

The ResultRequest.Builder, enabling method chaining

requestedRange

public ResultRequest.Builder requestedRange(OffsetRange value)

Parameters:

value - Set the requested range of the results.

Returns:

The ResultRequest.Builder, enabling method chaining

addMappings

public ResultRequest.Builder addMappings(TableSettings... values)

Parameters:

values - Adding a set of TableSettings which are used to map the raw results to the output

Returns:

The ResultRequest.Builder, enabling method chaining

addOpenGroups

public ResultRequest.Builder addOpenGroups(java.lang.String... values)

Parameters:

values - TODO

Returns:

The ResultRequest.Builder, enabling method chaining

resultStyle

public ResultRequest.Builder resultStyle(ResultRequest.ResultStyle value)

Parameters:

value - The style of results required. FLAT will provide a FlatResult object, while TABLE will provide a TableResult object

Returns:

The ResultRequest.Builder, enabling method chaining

fetch

public ResultRequest.Builder fetch(ResultRequest.Fetch value)

Parameters:

value - The fetch mode for the query. NONE means fetch no data, ALL means fetch all known results, CHANGES means fetch only those records not see in previous requests

Returns:

The ResultRequest.Builder, enabling method chaining

build

public ResultRequest build()