Package org.smartparam.engine.core.output

Interface ParamValue

All Superinterfaces:
Iterable<MultiValue>
All Known Implementing Classes:
EmptyParamValue, ParamValueImpl, ParamValueProxy
public interface ParamValue extends Iterable<MultiValue>

Container of parameter sub-matrix returned after querying the parameter.

Since:
1.0.0
Version:
1.0.2
Author:
Przemek Hertel

  • Method Details

    • row

      MultiValue row(int rowNo)
      Return resulting matrix row.
      Parameters:
      rowNo - row number
      Returns:
      resulting matrix row

    • row

      MultiValue row()
      Returns first row of matrix.
      Returns:
      first row of matrix

    • rows

      List<MultiValue> rows()
      Return all rows of matrix.
      Returns:
      all rows of matrix

    • getHolder

      ValueHolder getHolder(int rowNo, int colNo)
      Get cell of matrix.
      Parameters:
      rowNo - row number
      colNo - column number
      Returns:
      cell of matrix

    • get

      <T> T get(int rowNo, int colNo)
      Get object of type T from cell of matrix.
      Type Parameters:
      T - type T
      Parameters:
      rowNo - row number
      colNo - column number
      Returns:
      object of type T from cell of matrix

    • get

      <T> T get(int rowNo, int colNo, Class<T> clazz)
      Get object of given class from cell of matrix.
      Type Parameters:
      T - type T
      Parameters:
      rowNo - row number
      colNo - column number
      clazz - class
      Returns:
      object of given class from cell of matrix

    • getHolder

      ValueHolder getHolder(int rowNo, String name)
      Get cell of matrix using level name as column indicator.
      Parameters:
      rowNo - row number
      name - level name
      Returns:
      cell of matrix

    • get

      <T> T get(int rowNo, String name)
      Get object of type T from cell of matrix, where column is described by name.
      Type Parameters:
      T - type T
      Parameters:
      rowNo - row number
      name - level name
      Returns:
      cell of matrix

    • get

      <T> T get(int rowNo, String name, Class<T> clazz)
      Get object of given class from cell of matrix, where column is described by name.
      Type Parameters:
      T - type T
      Parameters:
      rowNo - row number
      name - level name
      clazz - class
      Returns:
      cell of matrix

    • getHolder

      ValueHolder getHolder(int colNo)
      Get value from first row and given column.
      Parameters:
      colNo - column
      Returns:
      value from first row and given column

    • get

      <T> T get(int colNo)
      Get object of type T from first row and column with given index.
      Type Parameters:
      T - type T
      Parameters:
      colNo - index
      Returns:
      object of type T

    • get

      <T> T get(int colNo, Class<T> clazz)
      Get object of given class from first row and column with given index.
      Type Parameters:
      T - type T
      Parameters:
      colNo - index
      clazz - class
      Returns:
      object of type T

    • getHolder

      ValueHolder getHolder(String name)
      Get value from first row using level name as column indicator.
      Parameters:
      name - level name
      Returns:
      value from first row

    • get

      <T> T get(String name)
      Get object of type T from first row and column with given name.
      Type Parameters:
      T - type T
      Parameters:
      name - name
      Returns:
      object of type T

    • get

      <T> T get(String name, Class<T> clazz)
      Get object of given class from first row and column with given name.
      Type Parameters:
      T - type T
      Parameters:
      name - name
      clazz - class
      Returns:
      object of given class.

    • getString

      String getString(String name)
      Get string from first row and column with given name.
      Parameters:
      name - name
      Returns:
      String value held in a column with given name of first row

    • getBigDecimal

      BigDecimal getBigDecimal(String name)
      Get BigDecimal from first row and column with given name.
      Parameters:
      name - name
      Returns:
      BigDecimal value held in a column with given name of first row

    • getDate

      Date getDate(String name)
      Get Date from first row and column with given name.
      Parameters:
      name - name
      Returns:
      Date value held in a column with given name of first row

    • getDatetime

      Date getDatetime(String name)
      Get Datetime from first row and column with given name.
      Parameters:
      name - name
      Returns:
      Date value held in a column with given name of first row

    • getLocalDate

      LocalDate getLocalDate(String name)
      Get LocalDate from first row and column with given name.
      Parameters:
      name - name
      Returns:
      LocalDate value held in a column with given name of first row

    • getLocalDatetime

      LocalDateTime getLocalDatetime(String name)
      Get LocalDateTime from first row and column with given name.
      Parameters:
      name - name
      Returns:
      LocalDateTime value held in a column with given name of first row

    • getInteger

      Integer getInteger(String name)
      Get Integer from first row and column with given name.
      Parameters:
      name - name
      Returns:
      Integer value held in a column with given name of first row

    • getLong

      Long getLong(String name)
      Get Long from first row and column with given name.
      Parameters:
      name - name
      Returns:
      Long value held in a column with given name of first row

    • getBoolean

      Boolean getBoolean(String name)
      Get Boolean from first row and column with given name.
      Parameters:
      name - name
      Returns:
      Boolean value held in a column with given name of first row

    • getEnum

      <T extends Enum<T>> T getEnum(String name, Class<T> enumClass)
      Get enum of given class from first row and column with given name.
      Type Parameters:
      T - type T
      Parameters:
      name - name
      enumClass - enum class
      Returns:
      enum value held in a column with given name of first row

    • getEnumSet

      <T extends Enum<T>> Set<T> getEnumSet(String name, Class<T> enumClass)
      Type Parameters:
      T - type T
      Parameters:
      name - level name as column indicator
      enumClass - enum of return object
      Returns:
      set with enums, which contains all values of enums from all rows (precised by name)

    • getHolder

      ValueHolder getHolder()
      Return first value from first row, useful if parameter returns only single value.
      Returns:
      value held in a column with given name of first row

    • get

      <T> T get()
      Return value from first column of first row as generic object.
      Type Parameters:
      T - type T
      Returns:
      generic object

    • get

      <T> T get(Class<T> clazz)
      Return value from first column of first row as object of given class.
      Type Parameters:
      T - type T
      Parameters:
      clazz - class
      Returns:
      object of given class

    • getString

      String getString()
      Return value from first column of first row as string.
      Returns:
      String value held in first cell of first row

    • getBigDecimal

      BigDecimal getBigDecimal()
      Return value from first column of first row as BigDecimal.
      Returns:
      BigDecimal value held in first cell of first row

    • getDate

      Date getDate()
      Return value from first column of first row as Date.
      Returns:
      Date value held in first cell of first row

    • getDatetime

      Date getDatetime()
      Return value from first column of first row as Datetime (java.util.Date)
      Returns:
      Date value held in first cell of first row

    • getLocalDate

      LocalDate getLocalDate()
      Return value from first column of first row as LocalDate.
      Returns:
      LocalDate value held in first cell of first row

    • getLocalDatetime

      LocalDateTime getLocalDatetime()
      Return value from first column of first row as LocalDateTime.
      Returns:
      LocalDateTime value held in first cell of first row

    • getInteger

      Integer getInteger()
      Return value from first column of first row as Integer.
      Returns:
      Integer value held in first cell of first row

    • getLong

      Long getLong()
      Return value from first column of first row as Long.
      Returns:
      Long value held in first cell of first row

    • getEnum

      <T extends Enum<T>> T getEnum(Class<T> enumClass)
      Return value from first column of first row as enum.
      Type Parameters:
      T - type T
      Parameters:
      enumClass - enum class
      Returns:
      enum value held in first cell of first row

    • getEnumSet

      <T extends Enum<T>> Set<T> getEnumSet(Class<T> enumClass)
      Type Parameters:
      T - type T
      Parameters:
      enumClass - enum of return object
      Returns:
      set with enums of all rows from first column.

    • size

      int size()
      Returns:
      number of rows

    • getMetadata

      Object getMetadata()
      Returns:
      metadata associated with this parameter
      Since:
      1.0.1

    • getBoolean

      Boolean getBoolean()
      Return bool value from first column of first row.
      Returns:
      Boolean value from first column of first row.

    • isEmpty

      boolean isEmpty()
      ParamValue is empty iff it has 0 rows
      Returns:
      boolean value

    • isBlank

      boolean isBlank()
      ParamValue is blank iff - it is empty - or each row is blank (see: MultiValue.isBlank)
      Returns:
      boolean value

    • stream

      Stream<MultiValue> stream()
      Returns:
      stream of matrix