org.graylog.plugins.views.search

Class Parameter

java.lang.Object

org.graylog.plugins.views.search.Parameter

public abstract class Parameter
extends Object

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 Parameter 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 interface	Parameter.Binding
static interface	Parameter.BindingHandler<B extends Parameter.Binding>
static class	Parameter.Builder

Constructor Summary

Constructors

Constructor and Description
Parameter()

Method Summary

Modifier and Type	Method and Description
static Parameter	any(String name)
Parameter	applyExecutionState(com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.fasterxml.jackson.databind.JsonNode state)
abstract Parameter.Binding	binding()
static Parameter.Builder	builder()
abstract String	dataType()
abstract Object	defaultValue()
abstract String	description()
abstract String	name()
abstract boolean	optional()
abstract String	title()
abstract Parameter.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter()

Method Detail

name

public abstract String name()

title

@Nullable
public abstract String title()

description

@Nullable
public abstract String description()

dataType

public abstract String dataType()

defaultValue

@Nullable
public abstract Object defaultValue()

optional

public abstract boolean optional()

binding

@Nullable
public abstract Parameter.Binding binding()

builder

public static Parameter.Builder builder()

any

public static Parameter any(String name)

toBuilder

public abstract Parameter.Builder toBuilder()

applyExecutionState

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