Package com.semedy.reasoner.api.builtin

Class CachedConnector

java.lang.Object
com.semedy.reasoner.api.builtin.CachedConnector
All Implemented Interfaces:
Builtin, Connector
Direct Known Subclasses:
TestMultiRelationalCached
public abstract class CachedConnector extends Object implements Connector
Author:
angele

  • Constructor Details

    • CachedConnector

      public CachedConnector()

  • Method Details

    • evaluationFinished

      public void evaluationFinished() throws BuiltinException, InterruptedException
      Description copied from interface: Builtin
      call back function. Is called when the whole evaluation has been finished
      Specified by:
      evaluationFinished in interface Builtin
      Throws:
      BuiltinException
      InterruptedException

    • isEvaluable

      public abstract boolean isEvaluable(BitSet grounds, BitSet variableInstantiations, Object[] args) throws BuiltinException
      Description copied from interface: Builtin
      is builtin evaluable with a certain instantiation of variables
      Specified by:
      isEvaluable in interface Builtin
      Parameters:
      grounds - , which arguments are ground
      variableInstantiations - , which variables are instantiated
      args - , the arguments
      Returns:
      was it evaluable
      Throws:
      BuiltinException

    • init

      public abstract void init(Object[] args)
      Description copied from interface: Builtin
      initialize the builtin
      Specified by:
      init in interface Builtin
      Parameters:
      args - , the builtin arguments

    • setSymbolTable

      public abstract void setSymbolTable(SymbolTable symbolTable)
      Description copied from interface: Builtin
      set the symbol table
      Specified by:
      setSymbolTable in interface Builtin
      Parameters:
      symbolTable - , the symbol table

    • setProperties

      public abstract void setProperties(Properties prp)
      Description copied from interface: Builtin
      set the sytem properties
      Specified by:
      setProperties in interface Builtin
      Parameters:
      prp - , properties

    • getWeight

      public abstract long getWeight(BitSet grounds, BitSet variableInstantiations, Object[] args)
      Description copied from interface: Builtin
      the weight of the builtin. Determines when the builtin is executed in a rule
      Specified by:
      getWeight in interface Builtin
      Parameters:
      grounds - , ground arguments
      variableInstantiations - , instantiated variables
      args - , arguments of the builtin
      Returns:
      the weight of the builtin (influences the position in the rule)

    • objectGeneratingArguments

      public abstract BitSet objectGeneratingArguments(BitSet grounds, BitSet variableInstantiations, Object[] args) throws BuiltinException
      Description copied from interface: Builtin
      In which argument position are new objects created
      Specified by:
      objectGeneratingArguments in interface Builtin
      Parameters:
      grounds - , ground argument positions
      variableInstantiations - , instantiated variables
      args - , arguments of the literal
      Returns:
      each bit indicates the argument position where new objects are created
      Throws:
      BuiltinException

    • getName

      public abstract String getName()
      Description copied from interface: Builtin
      get the name of the builtin
      Specified by:
      getName in interface Builtin
      Returns:
      the name of the built-in

    • getArity

      public abstract int getArity()
      Description copied from interface: Builtin
      get the arity of the builtin
      Specified by:
      getArity in interface Builtin
      Returns:
      the arity of the built-in

    • getType

      public abstract BuiltinType getType()
      Description copied from interface: Builtin
      get the type of the builtin
      Specified by:
      getType in interface Builtin
      Returns:
      the type of the built-in

    • isInternal

      public abstract boolean isInternal()
      Description copied from interface: Builtin
      is it a builtin for internal use only
      Specified by:
      isInternal in interface Builtin
      Returns:

    • getArgumentDescriptions

      public abstract String[] getArgumentDescriptions()
      Description copied from interface: Builtin
      get descriptions for the different arguments
      Specified by:
      getArgumentDescriptions in interface Builtin
      Returns:
      a description of the arguments of the built-in

    • getDescription

      public abstract String getDescription()
      Description copied from interface: Builtin
      get a description for the builtin
      Specified by:
      getDescription in interface Builtin
      Returns:
      a description of the built-in

    • readsSymbolTable

      public abstract boolean readsSymbolTable()
      Description copied from interface: Builtin
      does the builtin read the symbol table
      Specified by:
      readsSymbolTable in interface Builtin
      Returns:
      true if it reads the symbol table

    • writesSymbolTable

      public abstract boolean writesSymbolTable()
      Description copied from interface: Builtin
      does the builtin write into the symbol table
      Specified by:
      writesSymbolTable in interface Builtin
      Returns:
      true if it writes to the symbol table

    • cloneBuiltin

      public abstract Builtin cloneBuiltin()
      Description copied from interface: Builtin
      clone the builtin
      Specified by:
      cloneBuiltin in interface Builtin
      Returns:
      the cloned built-in

    • clear

      public abstract void clear()
      Description copied from interface: Builtin
      frees up allocated resources
      Specified by:
      clear in interface Builtin

    • start

      public abstract void start(BitSet grounds, BuiltinReceiver receiver) throws ReasoningException, InterruptedException, IOException
      Description copied from interface: Connector
      Start feeding the built-in with input values. Grounds indicates the ground arguments;
      receiver catches the results of the evaluation
      Specified by:
      start in interface Connector
      Parameters:
      grounds - , the arguments which are ground
      receiver - , the receiver receiving the results
      Throws:
      ReasoningException
      InterruptedException
      IOException

    • input

      public abstract void input(long[] input)
      Description copied from interface: Connector
      Feed the built-in with an input tuple.
      The built-in may produce at any time results,
      may be during feeding or may be after calling stop
      Specified by:
      input in interface Connector
      Parameters:
      input - encoded input tuple

    • stop

      public abstract void stop() throws SemReasonerException
      Description copied from interface: Connector
      stop feeding the built-in with input values
      Specified by:
      stop in interface Connector
      Throws:
      SemReasonerException