Package stroom.query.api.v2

Class ExpressionTerm.Builder

java.lang.Object

stroom.query.api.v2.ExpressionItem.Builder<ExpressionTerm,ExpressionTerm.Builder>

stroom.query.api.v2.ExpressionTerm.Builder

Enclosing class:

ExpressionTerm

public static class ExpressionTerm.Builder
extends ExpressionItem.Builder<ExpressionTerm,ExpressionTerm.Builder>

Builder for constructing a ExpressionTerm

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(java.lang.Boolean enabled)

Method Summary

Modifier and Type	Method	Description
ExpressionTerm	build()
ExpressionTerm.Builder	condition(ExpressionTerm.Condition value)
ExpressionTerm.Builder	docRef(java.lang.String type, java.lang.String uuid, java.lang.String name)	A shortcut method for specifying the entity DocRef inline
ExpressionTerm.Builder	docRef(DocRef value)	Add a entity term to the builder, e.g fieldX|IS_DOC_REF|docRefToDictionaryY Term is enabled by default.
ExpressionTerm.Builder	field(java.lang.String value)
protected ExpressionTerm.Builder	self()
ExpressionTerm.Builder	value(java.lang.String value)

Methods inherited from class stroom.query.api.v2.ExpressionItem.Builder

enabled, getEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(java.lang.Boolean enabled)

Method Detail

field

public ExpressionTerm.Builder field(java.lang.String value)

Parameters:

value - The name of the field that is being evaluated in this predicate term"

Returns:

The ExpressionTerm.Builder, enabling method chaining

condition

public ExpressionTerm.Builder condition(ExpressionTerm.Condition value)

Parameters:

value - The condition of the predicate term

Returns:

The ExpressionTerm.Builder, enabling method chaining

value

public ExpressionTerm.Builder value(java.lang.String value)

Parameters:

value - The value that the field value is being evaluated against. Not required if a dictionary is supplied

Returns:

The ExpressionTerm.Builder, enabling method chaining

docRef

public ExpressionTerm.Builder docRef(DocRef value)

Add a entity term to the builder, e.g fieldX|IS_DOC_REF|docRefToDictionaryY Term is enabled by default. Not all data sources support entity terms and only certain conditions are supported for an entity term.

Parameters:

value - The DocRef for the entity that this predicate is using for its evaluation

Returns:

The ExpressionTerm.Builder, enabling method chaining

docRef

public ExpressionTerm.Builder docRef(java.lang.String type,
                                     java.lang.String uuid,
                                     java.lang.String name)

A shortcut method for specifying the entity DocRef inline

Parameters:

type - The element type

uuid - The UUID of the dictionary

name - The name of the dictionary

Returns:

this builder, with the completed entity added,

build

public ExpressionTerm build()

Specified by:

build in class ExpressionItem.Builder<ExpressionTerm,ExpressionTerm.Builder>

self

protected ExpressionTerm.Builder self()

Specified by:

self in class ExpressionItem.Builder<ExpressionTerm,ExpressionTerm.Builder>