org.graylog.plugins.views.search

Class ValueParameter

java.lang.Object

org.graylog.plugins.views.search.ValueParameter

All Implemented Interfaces:

Parameter

public abstract class ValueParameter
extends Object
implements Parameter

Parameters describe variable inputs to queries.

They consist of a declaration and a binding. Parameters without a binding are called "free" or "unbound" parameters. In order to execute a query all of its non-optional parameters must have a binding associated with them, i.e. be "bound".

The caller is expected to provide a ValueParameter object when binding previously declared parameters. In that case the declaration elements do not need to be repeated, only its name property.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValueParameter.Builder

Nested classes/interfaces inherited from interface org.graylog.plugins.views.search.Parameter

Parameter.Binding, Parameter.BindingHandler<B extends Parameter.Binding,P extends Parameter>, Parameter.Factory<TYPE extends Parameter>

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_NAME

Fields inherited from interface org.graylog.plugins.views.search.Parameter

TYPE_FIELD

Constructor Summary

Constructors

Constructor and Description
ValueParameter()

Method Summary

Modifier and Type	Method and Description
static ValueParameter	any(String name)
ValueParameter	applyExecutionState(com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.fasterxml.jackson.databind.JsonNode state)
static ValueParameter.Builder	builder()
abstract ValueParameter.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graylog.plugins.views.search.Parameter

binding, dataType, defaultValue, description, name, optional, title, type

Field Detail

TYPE_NAME

public static final String TYPE_NAME

See Also:

Constant Field Values

Constructor Detail

ValueParameter

public ValueParameter()

Method Detail

builder

public static ValueParameter.Builder builder()

any

public static ValueParameter any(String name)

toBuilder

public abstract ValueParameter.Builder toBuilder()

applyExecutionState

public ValueParameter applyExecutionState(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                          com.fasterxml.jackson.databind.JsonNode state)

Specified by:

applyExecutionState in interface Parameter