Enum Class InteGraalKeywords

java.lang.Object
java.lang.Enum<InteGraalKeywords>
fr.inria.rules.integraal.configuration.keywords.InteGraalKeywords
All Implemented Interfaces:
Serializable, Comparable<InteGraalKeywords>, Constable
public enum InteGraalKeywords extends Enum<InteGraalKeywords>
The InteGraalKeywords enum provides a set of keywords and categorizations that defines the realm of possibilities with InteGraal. These include:
  • Algorithms: This section defines various algorithms for executing key operations within InteGraal, e.g., Knowledge Base Chase, Ontology-Mediated Query Rewriting, Rule Compilation, and Query Answering.
  • For each algorithm, it also includes the set of its supported Parameters.
  • Finally, it includes options for the algorithms' result options, such as Answer Types (e.g., list vs count-based results).
  • Internal Storage Configuration: This section outlines the parameters for setting the storage of a factbase in InteGraal.
  • Supported File Extensions: Defines the various file formats supported by the system, notably formats for factbases, query bases, rule bases, and mapping bases.
  • Monitoring Operations: Specifies key operations that can be monitored within the system, such as loading factbases, rulebases, and query workloads, or running a specific algorithm.

This enumeration is meant to represent all features of InteGraal and is primarily (but not only) used by the component builder.

Author:
Federico Ulliana, Michel Leclère

  • Enum Constant Details

    • ALGORITHMS

      public static final InteGraalKeywords ALGORITHMS
      Closed parameters

    • ANSWERS

      public static final InteGraalKeywords ANSWERS
      Answer type keyword family.

    • IMAGES

      public static final InteGraalKeywords IMAGES
      Image type keyword family.

    • COMPILATION

      public static final InteGraalKeywords COMPILATION
      Rule-compilation strategy keyword family.

    • SCHEDULER

      public static final InteGraalKeywords SCHEDULER
      Chase scheduler keyword family.

    • EVALUATOR

      public static final InteGraalKeywords EVALUATOR
      Chase evaluator keyword family.

    • APPLIER

      public static final InteGraalKeywords APPLIER
      Chase rule-applier keyword family.

    • TRANSFORMER

      public static final InteGraalKeywords TRANSFORMER
      Chase transformer keyword family.

    • COMPUTER

      public static final InteGraalKeywords COMPUTER
      Chase computer keyword family.

    • CHECKER

      public static final InteGraalKeywords CHECKER
      Chase trigger-checker keyword family.

    • NAMER

      public static final InteGraalKeywords NAMER
      Existential naming strategy keyword family.

    • CHASEHALTER

      public static final InteGraalKeywords CHASEHALTER
      Chase halting condition keyword family.

    • INTERSTEPTREATMENT

      public static final InteGraalKeywords INTERSTEPTREATMENT
      Inter-step treatment keyword family.

    • HYBRIDTYPES

      public static final InteGraalKeywords HYBRIDTYPES
      Hybrid reasoning type keyword family.

    • DBTYPE

      public static final InteGraalKeywords DBTYPE
      Database type keyword family.

    • DRIVERTYPE

      public static final InteGraalKeywords DRIVERTYPE
      Database driver type keyword family.

    • DBMSDRIVERPARAMETERS

      public static final InteGraalKeywords DBMSDRIVERPARAMETERS
      DBMS driver parameter keyword family.

    • STORAGELAYOUT

      public static final InteGraalKeywords STORAGELAYOUT
      Storage layout keyword family.

    • FACTBASE

      public static final InteGraalKeywords FACTBASE
      Fact-base file extension keyword family.

    • QUERYBASE

      public static final InteGraalKeywords QUERYBASE
      Query-base file extension keyword family.

    • RULEBASE

      public static final InteGraalKeywords RULEBASE
      Rule-base file extension keyword family.

    • MAPPINGBASE

      public static final InteGraalKeywords MAPPINGBASE
      Mapping-base file extension keyword family.

    • MONITORINGOPERATIONS

      public static final InteGraalKeywords MONITORINGOPERATIONS
      Monitoring operation keyword family.

    • MAX

      public static final InteGraalKeywords MAX
      Open parameters

    • RANK

      public static final InteGraalKeywords RANK
      Maximum reasoning rank parameter.

    • TIMEOUT

      public static final InteGraalKeywords TIMEOUT
      Timeout parameter.

    • INTERRUPT

      public static final InteGraalKeywords INTERRUPT
      Interrupt flag parameter.

    • URL

      public static final InteGraalKeywords URL
      DBMS URL parameter.

    • PORT

      public static final InteGraalKeywords PORT
      DBMS port parameter.

    • DATABASE_NAME

      public static final InteGraalKeywords DATABASE_NAME
      Database name parameter.

    • USER_NAME

      public static final InteGraalKeywords USER_NAME
      Database user name parameter.

    • USER_PASSWORD

      public static final InteGraalKeywords USER_PASSWORD
      Database user password parameter.

    • CLEAR_DB

      public static final InteGraalKeywords CLEAR_DB
      Database clearing mode parameter.

    • EXPLANATION

      public static final InteGraalKeywords EXPLANATION
      Explanation category parameter.

    • EXPLAINER_VERBOSITY

      public static final InteGraalKeywords EXPLAINER_VERBOSITY
      Explainer verbosity parameter.

    • EXPLAINER_SOLVER

      public static final InteGraalKeywords EXPLAINER_SOLVER
      Explainer solver parameter.

    • EXPLAINER_GRI_COMPUTATION

      public static final InteGraalKeywords EXPLAINER_GRI_COMPUTATION
      Graph-of-rule-instances computation parameter.

    • EXPLAINER_GRI_TYPE

      public static final InteGraalKeywords EXPLAINER_GRI_TYPE
      Graph-of-rule-instances storage parameter.

    • EXPLANATION_SUPPORT_TYPE

      public static final InteGraalKeywords EXPLANATION_SUPPORT_TYPE
      Explanation support type parameter.

    • EXPLANATION_GMUS_SOLVER_TREHSOLD

      public static final InteGraalKeywords EXPLANATION_GMUS_SOLVER_TREHSOLD
      GMUS solver threshold parameter.

    • EXPLANATION_MARCO_PATH_EXECUTBLE

      public static final InteGraalKeywords EXPLANATION_MARCO_PATH_EXECUTBLE
      MARCO executable path parameter.

  • Method Details

    • values

      public static InteGraalKeywords[] 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 InteGraalKeywords 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

    • findKeyword

      public static InteGraalKeywords findKeyword(String s)
      Finds the keyword associated with the given string.
      Parameters:
      s - The string representation of the keyword.
      Returns:
      The corresponding InteGraalKeywords enum.
      Throws:
      IllegalArgumentException - If the keyword is unknown.

    • checkAndGetEnumerationValue

      public static Object checkAndGetEnumerationValue(String s, InteGraalKeywords type)
      Checks an enumeration value against the expected keyword family and returns the resolved constant.
      Parameters:
      s - the raw string value to resolve
      type - the keyword describing the target enumeration
      Returns:
      the resolved enumeration constant

    • checkValueType

      public static void checkValueType(Object s, InteGraalKeywords type)
      Checks that a runtime value matches the declared type of a keyword.
      Parameters:
      s - the value to validate
      type - the keyword carrying the expected value type

    • getValueType

      public static Object getValueType(String s, InteGraalKeywords inteGraalKeyword)
      Converts a raw string into the runtime type expected by a keyword.
      Parameters:
      s - the raw string representation
      inteGraalKeyword - the keyword describing the target type
      Returns:
      the parsed value

    • getType

      public Class<?> getType()
      Gets the class type associated with the keyword.
      Returns:
      The class type.

    • getParentEnum

      public Optional<InteGraalKeywords> getParentEnum()
      Returns the parent enumeration keyword when this keyword is nested under another family.
      Returns:
      A possibly empty optional containing the parent enumeration.

    • isEnumeration

      public boolean isEnumeration()
      True iff the keyword values are defined by an enumeration
      Returns:
      The class type.

    • findValue

      public Object findValue(String s)
      Finds the value associated with the keyword from the given string.
      Parameters:
      s - The string representation of the value.
      Returns:
      The corresponding value.
      Throws:
      IllegalArgumentException - If the value is invalid for the keyword.