Package org.smartparam.engine.core.parameter

Interface Parameter

All Known Implementing Classes:
Parameter
public interface Parameter

Interface for parameter that is loaded from storage and evaluated inside engine. Two logical parts are metadata (attributes) and matrix (entries).

Since:
1.0.0
Version:
1.0.2
Author:
Przemek Hertel, Adam Dubiel
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    char
    getArraySeparator()
    Separator used when storing array as level value, this is set globally per parameter.
    String
    getDigest()
    Returns parameter's digest which is a hashed info about given parameter
    Collection<ParameterEntry>
    getEntries()
    Returns collection of parameter entries representing (unordered) parameter matrix.
    int
    getId()
    Returns unique parameter id.
    int
    getInputLevels()
    Returns number of input levels (criteria levels).
    List<Level>
    getLevels()
    Returns ordered list of levels.
    Object
    getMetadata()
    Any additional data that user want to associate with this parameter.
    String
    getName()
    Returns unique name of parameter.
    boolean
    isCacheable()
    Whether parameter's search index is stored in cache.
    boolean
    isDictionary()
     
    boolean
    isNullable()
    Can parameter return null-value, which means that there might be no matching parameter row for given input levels values.

  • Method Details

    • getId

      int getId()
      Returns unique parameter id.
      Returns:
      parameter id

    • getName

      String getName()
      Returns unique name of parameter.
      Returns:
      parameter name

    • getLevels

      List<Level> getLevels()
      Returns ordered list of levels.
      Returns:
      list of levels

    • getInputLevels

      int getInputLevels()
      Returns number of input levels (criteria levels).
      Returns:
      number of input levels

    • getEntries

      Collection<ParameterEntry> getEntries()
      Returns collection of parameter entries representing (unordered) parameter matrix.
      Returns:
      parameter matrix

    • isCacheable

      boolean isCacheable()
      Whether parameter's search index is stored in cache.
      Returns:
      is cacheable

    • isNullable

      boolean isNullable()
      Can parameter return null-value, which means that there might be no matching parameter row for given input levels values.
      Returns:
      is nullable

    • getArraySeparator

      char getArraySeparator()
      Separator used when storing array as level value, this is set globally per parameter.
      Returns:
      separator value

    • getMetadata

      Object getMetadata()
      Any additional data that user want to associate with this parameter. This metadata will be stored with PreparedParameter in index cache.
      Returns:
      object

    • getDigest

      String getDigest()
      Returns parameter's digest which is a hashed info about given parameter
      Returns:
      digest hash as string

    • isDictionary

      boolean isDictionary()