Class StmtsDocList

java.lang.Object
io.nosqlbench.engine.api.activityconfig.yaml.StmtsDocList
All Implemented Interfaces:
java.lang.Iterable<StmtsDoc>

public class StmtsDocList
extends java.lang.Object
implements java.lang.Iterable<StmtsDoc>
  • Constructor Summary

    Constructors 
    Constructor Description
    StmtsDocList​(RawStmtsDocList rawStmtsDocList)  
  • Method Summary

    Modifier and Type Method Description
    void addTemplateVariable​(java.lang.String key, java.lang.String defaultValue)  
    io.nosqlbench.nb.api.config.standard.NBConfigModel getConfigModel()  
    java.lang.String getDescription()  
    java.util.Map<java.lang.String,​java.lang.String> getDocBindings()
    Return the list of all bindings combined across all docs, not including the block or statement level bindings.
    Scenarios getDocScenarios()  
    java.util.List<StmtsDoc> getStmtDocs()  
    java.util.List<StmtsDoc> getStmtDocs​(java.lang.String tagFilter)  
    java.util.List<io.nosqlbench.engine.api.activityconfig.yaml.OpTemplate> getStmts()  
    java.util.List<io.nosqlbench.engine.api.activityconfig.yaml.OpTemplate> getStmts​(java.lang.String tagFilterSpec)  
    java.util.Map<java.lang.String,​java.lang.String> getTemplateVariables()  
    java.util.Iterator<StmtsDoc> iterator()  

    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

  • Method Details

    • getStmtDocs

      public java.util.List<StmtsDoc> getStmtDocs​(java.lang.String tagFilter)
    • getStmtDocs

      public java.util.List<StmtsDoc> getStmtDocs()
    • getStmts

      public java.util.List<io.nosqlbench.engine.api.activityconfig.yaml.OpTemplate> getStmts()
    • getStmts

      public java.util.List<io.nosqlbench.engine.api.activityconfig.yaml.OpTemplate> getStmts​(java.lang.String tagFilterSpec)
      Parameters:
      tagFilterSpec - a comma-separated tag filter spec
      Returns:
      The list of all included statements for all included blocks of in this document, including the inherited and overridden values from the this doc and the parent block.
    • iterator

      public java.util.Iterator<StmtsDoc> iterator()
      Specified by:
      iterator in interface java.lang.Iterable<StmtsDoc>
    • getDocBindings

      public java.util.Map<java.lang.String,​java.lang.String> getDocBindings()
      Return the list of all bindings combined across all docs, not including the block or statement level bindings.
      Returns:
      A map of all bindings at the doc level.
    • getDocScenarios

      public Scenarios getDocScenarios()
      Returns:
      the list of named scenarios for the first document in the list.
    • getDescription

      public java.lang.String getDescription()
      Returns:
      the description of the first document in the list.
    • getTemplateVariables

      public java.util.Map<java.lang.String,​java.lang.String> getTemplateVariables()
    • addTemplateVariable

      public void addTemplateVariable​(java.lang.String key, java.lang.String defaultValue)
    • getConfigModel

      public io.nosqlbench.nb.api.config.standard.NBConfigModel getConfigModel()