Interface Describer

All Known Implementing Classes:
CodeVisitor, DescriberImpl

public interface Describer
Describes a plan (tree of Code or Applicable objects).
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Provided as a callback while describing a node.
  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    Registers an action to be performed each time the query is started.
    int
    register(String name, int i)
    Registers a (name, ordinal) combination, and returns how many occurrences of the same name with a different ordinal have been seen before.
     
  • Method Details

    • start

      Describer start(String name, Consumer<Describer.Detail> detail)
    • register

      int register(String name, int i)
      Registers a (name, ordinal) combination, and returns how many occurrences of the same name with a different ordinal have been seen before.

      For example:

      • register("a", 0) returns 0;
      • register("b", 3) returns 0;
      • register("b", 2) returns 1;
      • register("b", 3) returns 0;
      • register("a", 42) returns 1.
      See Also:
    • addStartAction

      default void addStartAction(Runnable runnable)
      Registers an action to be performed each time the query is started.