Package org.apache.drill.exec.server.options

Class OptionValue

java.lang.Object

org.apache.drill.exec.server.options.OptionValue

All Implemented Interfaces:

Comparable<OptionValue>

public class OptionValue
extends Object
implements Comparable<OptionValue>

An option value is used internally by an OptionManager to store a run-time setting. This setting, for example, could affect a query in an execution stage. Instances of this class are JSON serializable and can be stored in a persistent store (see SystemOptionManager.options), or in memory (see InMemoryOptionManager.options).

OptionValue.AccessibleScopes defines the scopes at which the option can be set. If it can be set at System level or Session level or so on. Whereas OptionValue.OptionScope defines the scope at which the option is being set. If the option is being set at the BOOT time the scope of the option is BOOT. If it is set at SYSTEM level the scope is SYSTEM. Although they look similar there is a fine level which differentiates both of them which is at which level of hierarchy they can be set and at what at level of hierarchy they were actually set.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OptionValue.AccessibleScopes	Defines where an option can be configured.
static enum	OptionValue.Kind
static enum	OptionValue.OptionScope	This defines where an option was actually configured.

Field Summary

Fields

Modifier and Type	Field	Description
final OptionValue.AccessibleScopes	accessibleScopes
final Boolean	bool_val
final Double	float_val
static final String	JSON_ACCESSIBLE_SCOPES
static final String	JSON_BOOL_VAL
static final String	JSON_FLOAT_VAL
static final String	JSON_INTEGER_VAL
static final String	JSON_KIND
static final String	JSON_NAME
static final String	JSON_NUM_VAL
static final String	JSON_SCOPE
static final String	JSON_STRING_VAL
final OptionValue.Kind	kind
final String	name
final Long	num_val
final OptionValue.OptionScope	scope
final String	string_val

Method Summary

Modifier and Type	Method	Description
int	compareTo(OptionValue o)
static OptionValue	create(OptionValue.AccessibleScopes accessibleScopes, String name, boolean bool, OptionValue.OptionScope scope)
static OptionValue	create(OptionValue.AccessibleScopes accessibleScopes, String name, double val, OptionValue.OptionScope scope)
static OptionValue	create(OptionValue.AccessibleScopes accessibleScopes, String name, long val, OptionValue.OptionScope scope)
static OptionValue	create(OptionValue.AccessibleScopes type, String name, Object val, OptionValue.OptionScope scope, OptionValue.Kind kind)
static OptionValue	create(OptionValue.AccessibleScopes accessibleScopes, String name, String val, OptionValue.OptionScope scope)
static OptionValue	create(OptionValue.Kind kind, OptionValue.AccessibleScopes accessibleScopes, String name, String val, OptionValue.OptionScope scope)
boolean	equals(Object obj)
boolean	equalsIgnoreType(Object obj)
String	getName()
OptionValue.OptionScope	getScope()
Object	getValue()
Object	getValueMinScope(OptionValue.OptionScope minScope)	Gets the value of this option if it exists at a scope at least as narrow as the given scope.
int	hashCode()
PersistedOptionValue	toPersisted()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_KIND

public static final String JSON_KIND

See Also:

• Constant Field Values

JSON_ACCESSIBLE_SCOPES

public static final String JSON_ACCESSIBLE_SCOPES

See Also:

• Constant Field Values

JSON_NAME

public static final String JSON_NAME

See Also:

• Constant Field Values

JSON_NUM_VAL

public static final String JSON_NUM_VAL

See Also:

• Constant Field Values

JSON_STRING_VAL

public static final String JSON_STRING_VAL

See Also:

• Constant Field Values

JSON_BOOL_VAL

public static final String JSON_BOOL_VAL

See Also:

• Constant Field Values

JSON_FLOAT_VAL

public static final String JSON_FLOAT_VAL

See Also:

• Constant Field Values

JSON_INTEGER_VAL

public static final String JSON_INTEGER_VAL

See Also:

• Constant Field Values

JSON_SCOPE

public static final String JSON_SCOPE

See Also:

• Constant Field Values

name

public final String name

kind

public final OptionValue.Kind kind

accessibleScopes

public final OptionValue.AccessibleScopes accessibleScopes

num_val

public final Long num_val

string_val

public final String string_val

bool_val

public final Boolean bool_val

float_val

public final Double float_val

scope

public final OptionValue.OptionScope scope

Method Details

create

public static OptionValue create(OptionValue.AccessibleScopes accessibleScopes,
 String name,
 long val,
 OptionValue.OptionScope scope)

create

public static OptionValue create(OptionValue.AccessibleScopes accessibleScopes,
 String name,
 boolean bool,
 OptionValue.OptionScope scope)

create

public static OptionValue create(OptionValue.AccessibleScopes accessibleScopes,
 String name,
 String val,
 OptionValue.OptionScope scope)

create

public static OptionValue create(OptionValue.AccessibleScopes accessibleScopes,
 String name,
 double val,
 OptionValue.OptionScope scope)

create

public static OptionValue create(OptionValue.Kind kind,
 OptionValue.AccessibleScopes accessibleScopes,
 String name,
 String val,
 OptionValue.OptionScope scope)

create

public static OptionValue create(OptionValue.AccessibleScopes type,
 String name,
 Object val,
 OptionValue.OptionScope scope,
 OptionValue.Kind kind)

getName

public String getName()

getValue

public Object getValue()

getValueMinScope

public Object getValueMinScope(OptionValue.OptionScope minScope)

Gets the value of this option if it exists at a scope at least as narrow as the given scope.

Parameters:

minScope - scope which the option's scope should be narrower than

Returns:

null if the option does not exist at a scope at least as narrow as minScope

getScope

public OptionValue.OptionScope getScope()

toPersisted

public PersistedOptionValue toPersisted()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equalsIgnoreType

public boolean equalsIgnoreType(Object obj)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(OptionValue o)

Specified by:

compareTo in interface Comparable<OptionValue>

toString

public String toString()

Overrides:

toString in class Object