org.eclipse.incquery.runtime.evm.api

## Class RuleSpecification<EventAtom>

- java.lang.Object
- - org.eclipse.incquery.runtime.evm.api.RuleSpecification<EventAtom>

-     public class RuleSpecification<EventAtom>
      extends java.lang.Object

  A rule specification specifies how the set of individual rule activations and their states are computed, what jobs (operations) to perform when an activation is executed, and how events affect the state of the activations based on a life-cycle model.
  Author:
    Abel Hegedus

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `RuleSpecification(EventSourceSpecification<EventAtom> sourceSpecification, ActivationLifeCycle lifeCycle, java.util.Set<Job<EventAtom>> jobs)` Creates a specification with the given life-cycle and job set.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `EventFilter<EventAtom>` | `createEmptyFilter()`
    `java.util.Set<ActivationState>` | `getEnabledStates()`
    `com.google.common.collect.Multimap<ActivationState,Job<EventAtom>>` | `getJobs()`
    `java.util.Collection<Job<EventAtom>>` | `getJobs(ActivationState state)` Returns the jobs specified for the given state.
    `ActivationLifeCycle` | `getLifeCycle()`
    `EventSourceSpecification<EventAtom>` | `getSourceSpecification()`
    `java.lang.String` | `toString()`

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### RuleSpecification

          public RuleSpecification(EventSourceSpecification<EventAtom> sourceSpecification,
                                   ActivationLifeCycle lifeCycle,
                                   java.util.Set<Job<EventAtom>> jobs)

      Creates a specification with the given life-cycle and job set.
      Parameters:
        `lifeCycle` -
        `jobs` -

  - ### Method Detail

    - #### getSourceSpecification

          public EventSourceSpecification<EventAtom> getSourceSpecification()

      Returns:
        the sourceSpecification

    - #### createEmptyFilter

          public EventFilter<EventAtom> createEmptyFilter()

    - #### getLifeCycle

          public ActivationLifeCycle getLifeCycle()

      Returns:
        the lifeCycle

    - #### getEnabledStates

          public java.util.Set<ActivationState> getEnabledStates()

      Returns:
        the enabledStates

    - #### getJobs

          public java.util.Collection<Job<EventAtom>> getJobs(ActivationState state)

      Returns the jobs specified for the given state.
      Parameters:
        `state` -
      Returns:
        the collection of jobs

    - #### getJobs

          public com.google.common.collect.Multimap<ActivationState,Job<EventAtom>> getJobs()

      Returns:
        the jobs

    - #### toString

          public java.lang.String toString()

      Overrides:
        `toString` in class `java.lang.Object`