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

Class StmtsDoc

java.lang.Object

io.nosqlbench.engine.api.activityconfig.yaml.StmtsDoc

All Implemented Interfaces:

io.nosqlbench.engine.api.util.Tagged, Iterable<StmtsBlock>

public class StmtsDoc
extends Object
implements io.nosqlbench.engine.api.util.Tagged, Iterable<StmtsBlock>

StmtsDoc creates a logical view of a statements doc that includes all inherited and overridden values for bindings, tags, and params.

Constructor Summary

Constructors

Constructor	Description
StmtsDoc(RawStmtsDoc rawStmtsDoc)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getBindings()
List<StmtsBlock>	getBlocks()
String	getDescription()
String	getName()
Map<String,Object>	getParams()
Scenarios	getScenarios()
List<OpTemplate>	getStmts()
Map<String,String>	getTags()
Iterator<StmtsBlock>	iterator()	Allow StmtsDoc to be used in iterable loops.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

StmtsDoc

public StmtsDoc(RawStmtsDoc rawStmtsDoc)

Method Details

getBlocks

public List<StmtsBlock> getBlocks()

Returns:

a usable list of blocks, including inherited bindings, params, and tags from the parent doc

getTags

public Map<String,String> getTags()

Specified by:

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

Returns:

a usable map of tags, including those inherited from the parent doc

getParams

public Map<String,Object> getParams()

Returns:

a usable map of parameters, including those inherited from the parent doc

getBindings

public Map<String,String> getBindings()

Returns:

a usable map of bindings, including those inherited from the parent doc

getName

public String getName()

Returns:

the name of this block

getStmts

public List<OpTemplate> getStmts()

Returns:

The list of all included statements for all included block in this document, including the inherited and overridden values from the this doc and the parent block.

iterator

public Iterator<StmtsBlock> iterator()

Allow StmtsDoc to be used in iterable loops.

Specified by:

iterator in interface Iterable<StmtsBlock>

Returns:

An iterator of StmtsBlock

getScenarios

public Scenarios getScenarios()

getDescription

public String getDescription()