Package io.nosqlbench.engine.api.activityconfig.yaml

Class OpData

java.lang.Object

io.nosqlbench.engine.api.activityconfig.yaml.OpTemplate

io.nosqlbench.engine.api.activityconfig.yaml.OpData

All Implemented Interfaces:

io.nosqlbench.engine.api.util.Tagged

public class OpData
extends OpTemplate

Field Summary

Fields inherited from class io.nosqlbench.engine.api.activityconfig.yaml.OpTemplate

FIELD_BINDINGS, FIELD_DESC, FIELD_NAME, FIELD_OP, FIELD_PARAMS, FIELD_TAGS

Constructor Summary

Constructors

Constructor	Description
OpData()
OpData(String desc, String name, Map<String,String> tags, Map<String,String> bindings, Map<String,Object> params, Map<String,Object> op)
OpData(Map<String,Object> opdata)

Method Summary

Modifier and Type	Method	Description
OpData	applyFields(Map<String,Object> opdata)
Map<String,String>	getBindings()
String	getDesc()
String	getName()
Optional<Map<String,Object>>	getOp()
Map<String,Object>	getParams()
Optional<String>	getStmt()	Legacy support for String form statements.
Map<String,String>	getTags()	Return a map of tags for this statement.

Methods inherited from class io.nosqlbench.engine.api.activityconfig.yaml.OpTemplate

asData, assertConsumed, getOptionalStringParam, getOptionalStringParam, getParam, getParamOrDefault, getParamReader, getParamsAsValueType, getParsed, getParsed, remainingFields, removeParamOrDefault, size

Methods inherited from class java.lang.Object

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

Constructor Details

OpData

public OpData(String desc,
 String name,
 Map<String,String> tags,
 Map<String,String> bindings,
 Map<String,Object> params,
 Map<String,Object> op)

OpData

public OpData()

OpData

public OpData(Map<String,Object> opdata)

Method Details

applyFields

public OpData applyFields(Map<String,Object> opdata)

getDesc

public String getDesc()

Specified by:

getDesc in class OpTemplate

Returns:

a description for the op template, or an empty string

getName

public String getName()

Specified by:

getName in class OpTemplate

Returns:

a name for the op template, user-specified or auto-generated

getTags

public Map<String,String> getTags()

Description copied from class: OpTemplate

Return a map of tags for this statement. Implementations are required to add a tag for "name" automatically when this value is set during construction.

Specified by:

getTags in interface io.nosqlbench.engine.api.util.Tagged

Specified by:

getTags in class OpTemplate

Returns:

A map of assigned tags for the op, with the name added as an auto-tag.

getBindings

public Map<String,String> getBindings()

Specified by:

getBindings in class OpTemplate

getParams

public Map<String,Object> getParams()

Specified by:

getParams in class OpTemplate

getOp

public Optional<Map<String,Object>> getOp()

Specified by:

getOp in class OpTemplate

getStmt

public Optional<String> getStmt()

Description copied from class: OpTemplate

Legacy support for String form statements. This is left here as a convenience method, however it is changed to an Optional to force caller refactorings.

Overrides:

getStmt in class OpTemplate

Returns:

An optional string version of the op, empty if there is no 'stmt' property in the op fields, or no op fields at all.