Module com.darkcollective.relix.lang.ast
Package com.darkcollective.relix.lang.ast.source

Enum Class ColumnDirection

java.lang.Object
java.lang.Enum<ColumnDirection>
com.darkcollective.relix.lang.ast.source.ColumnDirection
All Implemented Interfaces:
Serializable, Comparable<ColumnDirection>, Constable
public enum ColumnDirection extends Enum<ColumnDirection>
Indicates whether a column spec describes an input parameter or an output value.

IN columns carry values from the query (predicate push-down) into the data source request. OUT columns carry values from the response back to the query.

When the direction is omitted in the source schema, it defaults to OUT.

  • Enum Constant Details

    • IN

      public static final ColumnDirection IN
      The column is an input parameter — an equality predicate on this column in the query is pushed into the HTTP request (URL query param, path param, or header).

    • OUT

      public static final ColumnDirection OUT
      The column is an output value — its content is extracted from the response and returned as part of the relation's tuples.

  • Method Details

    • values

      public static ColumnDirection[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ColumnDirection valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null