Package stroom.query.api.v2

Class TableSettings.Builder

java.lang.Object

stroom.query.api.v2.TableSettings.Builder

Enclosing class:

TableSettings

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

Builder for constructing a tableSettings

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TableSettings.Builder	addFields(java.util.Collection<Field> values)	Convenience function for adding multiple fields that are already in a collection.
TableSettings.Builder	addFields(Field... values)
TableSettings.Builder	addMaxResults(java.lang.Integer... values)
TableSettings.Builder	addMaxResults(java.util.Collection<java.lang.Integer> values)	Add a collection of max result values
TableSettings	build()
TableSettings.Builder	extractionPipeline(java.lang.String type, java.lang.String uuid, java.lang.String name)	Shortcut function for creating the extractionPipeline DocRef in one go
TableSettings.Builder	extractionPipeline(DocRef value)
TableSettings.Builder	extractValues(java.lang.Boolean value)
TableSettings.Builder	queryId(java.lang.String value)
TableSettings.Builder	showDetail(java.lang.Boolean 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

queryId

public TableSettings.Builder queryId(java.lang.String value)

Parameters:

value - The ID for the query that wants these results

Returns:

The TableSettings.Builder, enabling method chaining

addFields

public TableSettings.Builder addFields(Field... values)

Parameters:

values - Add expected fields to the output table

Returns:

The TableSettings.Builder, enabling method chaining

addFields

public TableSettings.Builder addFields(java.util.Collection<Field> values)

Convenience function for adding multiple fields that are already in a collection.

Parameters:

values - The fields to add

Returns:

this builder, with the fields added.

addMaxResults

public TableSettings.Builder addMaxResults(java.lang.Integer... values)

Parameters:

values - The max result value

Returns:

The TableSettings.Builder, enabling method chaining

addMaxResults

public TableSettings.Builder addMaxResults(java.util.Collection<java.lang.Integer> values)

Add a collection of max result values

Parameters:

values - The list of max result values

Returns:

this builder

extractValues

public TableSettings.Builder extractValues(java.lang.Boolean value)

Parameters:

value - TODO - unknown purpose

Returns:

The TableSettings.Builder, enabling method chaining

extractionPipeline

public TableSettings.Builder extractionPipeline(DocRef value)

Parameters:

value - The reference to the extraction pipeline that will be used on the results

Returns:

The TableSettings.Builder, enabling method chaining

extractionPipeline

public TableSettings.Builder extractionPipeline(java.lang.String type,
                                                java.lang.String uuid,
                                                java.lang.String name)

Shortcut function for creating the extractionPipeline DocRef in one go

Parameters:

type - The type of the extractionPipeline

uuid - The UUID of the extractionPipeline

name - The name of the extractionPipeline

Returns:

this builder, with the completed extractionPipeline added.

showDetail

public TableSettings.Builder showDetail(java.lang.Boolean value)

Parameters:

value - When grouping is used a value of true indicates that the results will include the full detail of any results aggregated into a group as well as their aggregates. A value of false will only include the aggregated values for each group. Defaults to false.

Returns:

The TableSettings.Builder, enabling method chaining

build

public TableSettings build()