Package org.optaplanner.constraint.streams.drools.common

Class UniLeftHandSide<A>

java.lang.Object
org.optaplanner.constraint.streams.drools.common.UniLeftHandSide<A>
Type Parameters:
A - generic type of the resulting variable
public final class UniLeftHandSide<A> extends Object
Represents the left-hand side of a Drools rule, the result of which is a single variable. The simplest variant of such rule, with no filters or groupBys applied, would look like this in equivalent DRL: 
 
  rule "Simplest univariate rule"
  when
      $a: Something()
  then
      // Do something with the $a variable.
  end
Left-hand side is that part of the rule between the "when" and "then" keywords. The part between the "then" and "end" keywords is called the consequence of the rule, and this class does not represent it. It can be created by calling #andTerminate(). There are also more complex variants of rules that still result in just one variable: 
 
  rule "Complex univariate rule"
  when
      $accumulateResult: Collection() from accumulate(
          ...
      )
      $a: Object() from $accumulateResult
      exists Something()
  then
      // Do something with the $a variable.
  end
To create the simplest possible variant, call UniLeftHandSide(Class, DroolsVariableFactory). Further specializations can be introduced by calling builder methods such as andFilter(Predicate). These builder methods will always return a new instance of AbstractLeftHandSide, as these are immutable. Some builder methods, such as andJoin(UniLeftHandSide, BiJoiner), will return an instance of BiLeftHandSide (TriLeftHandSide, ...), as that particular operation will increase the cardinality of the parent constraint stream.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final DroolsVariableFactory
    variableFactory
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    UniLeftHandSide(Class<A> aClass, DroolsVariableFactory variableFactory)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    <B> UniLeftHandSide<A>
    andExists(Class<B> bClass, org.optaplanner.core.api.score.stream.bi.BiJoiner<A,B>[] joiners, Predicate<B> nullityFilter)
     
    UniLeftHandSide<A>
    andFilter(Predicate<A> predicate)
     
    <NewA> UniLeftHandSide<NewA>
    andFlattenLast(Function<A,Iterable<NewA>> mapping)
     
    <NewA> UniLeftHandSide<NewA>
    andGroupBy(Function<A,NewA> keyMapping)
     
    <NewA, NewB>
    BiLeftHandSide<NewA,NewB>
    andGroupBy(Function<A,NewA> keyMappingA, Function<A,NewB> keyMappingB)
     
    <NewA, NewB, NewC>
    TriLeftHandSide<NewA,NewB,NewC>
    andGroupBy(Function<A,NewA> keyMappingA, Function<A,NewB> keyMappingB, Function<A,NewC> keyMappingC)
     
    <NewA, NewB, NewC, NewD>
    QuadLeftHandSide<NewA,NewB,NewC,NewD>
    andGroupBy(Function<A,NewA> keyMappingA, Function<A,NewB> keyMappingB, Function<A,NewC> keyMappingC, Function<A,NewD> keyMappingD)
     
    <NewA, NewB, NewC, NewD>
    QuadLeftHandSide<NewA,NewB,NewC,NewD>
    andGroupBy(Function<A,NewA> keyMappingA, Function<A,NewB> keyMappingB, Function<A,NewC> keyMappingC, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewD> collectorD)
     
    <NewA, NewB, NewC>
    TriLeftHandSide<NewA,NewB,NewC>
    andGroupBy(Function<A,NewA> keyMappingA, Function<A,NewB> keyMappingB, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewC> collectorC)
     
    <NewA, NewB, NewC, NewD>
    QuadLeftHandSide<NewA,NewB,NewC,NewD>
    andGroupBy(Function<A,NewA> keyMappingA, Function<A,NewB> keyMappingB, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewC> collectorC, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewD> collectorD)
     
    <NewA, NewB>
    BiLeftHandSide<NewA,NewB>
    andGroupBy(Function<A,NewA> keyMappingA, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewB> collectorB)
     
    <NewA, NewB, NewC>
    TriLeftHandSide<NewA,NewB,NewC>
    andGroupBy(Function<A,NewA> keyMappingA, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewB> collectorB, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewC> collectorC)
     
    <NewA, NewB, NewC, NewD>
    QuadLeftHandSide<NewA,NewB,NewC,NewD>
    andGroupBy(Function<A,NewA> keyMappingA, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewB> collectorB, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewC> collectorC, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewD> collectorD)
     
    <NewA> UniLeftHandSide<NewA>
    andGroupBy(org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewA> collector)
     
    <NewA, NewB>
    BiLeftHandSide<NewA,NewB>
    andGroupBy(org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewA> collectorA, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewB> collectorB)
     
    <NewA, NewB, NewC>
    TriLeftHandSide<NewA,NewB,NewC>
    andGroupBy(org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewA> collectorA, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewB> collectorB, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewC> collectorC)
     
    <NewA, NewB, NewC, NewD>
    QuadLeftHandSide<NewA,NewB,NewC,NewD>
    andGroupBy(org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewA> collectorA, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewB> collectorB, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewC> collectorC, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewD> collectorD)
     
    <B> BiLeftHandSide<A,B>
    andJoin(UniLeftHandSide<B> right, org.optaplanner.core.api.score.stream.bi.BiJoiner<A,B> joiner)
     
    <NewA> UniLeftHandSide<NewA>
    andMap(Function<A,NewA> mapping)
     
    <B> UniLeftHandSide<A>
    andNotExists(Class<B> bClass, org.optaplanner.core.api.score.stream.bi.BiJoiner<A,B>[] joiners, Predicate<B> nullityFilter)
     
    <Solution_>
    RuleBuilder<Solution_>
    andTerminate(Function<A,BigDecimal> matchWeigher)
     
    <Solution_>
    RuleBuilder<Solution_>
    andTerminate(ToIntFunction<A> matchWeigher)
     
    <Solution_>
    RuleBuilder<Solution_>
    andTerminate(ToLongFunction<A> matchWeigher)
     
    protected static org.drools.model.view.ViewItem<?>
    buildAccumulate(org.drools.model.view.ViewItem<?> innerAccumulatePattern, org.drools.model.functions.accumulate.AccumulateFunction... accFunctions)
     
    protected static <A, B> org.optaplanner.constraint.streams.drools.common.IndirectPatternVariable<B,org.optaplanner.constraint.streams.drools.common.BiTuple<A,B>>
    decompose(org.drools.model.Variable<org.optaplanner.constraint.streams.drools.common.BiTuple<A,B>> primaryVariable, org.drools.model.view.ViewItem<?> prerequisitePattern, org.drools.model.Variable<A> boundVarA, org.drools.model.Variable<B> boundVarB)
    Create an IndirectPatternVariable on BiTuple with pre-made bindings for its components variables.
    protected static <A, B, C, D> org.optaplanner.constraint.streams.drools.common.IndirectPatternVariable<D,org.optaplanner.constraint.streams.drools.common.QuadTuple<A,B,C,D>>
    decompose(org.drools.model.Variable<org.optaplanner.constraint.streams.drools.common.QuadTuple<A,B,C,D>> primaryVariable, org.drools.model.view.ViewItem<?> prerequisitePattern, org.drools.model.Variable<A> boundVarA, org.drools.model.Variable<B> boundVarB, org.drools.model.Variable<C> boundVarC, org.drools.model.Variable<D> boundVarD)
    Create an IndirectPatternVariable on QuadTuple with pre-made bindings for its components variables.
    protected static <A, B, C> org.optaplanner.constraint.streams.drools.common.IndirectPatternVariable<C,org.optaplanner.constraint.streams.drools.common.TriTuple<A,B,C>>
    decompose(org.drools.model.Variable<org.optaplanner.constraint.streams.drools.common.TriTuple<A,B,C>> primaryVariable, org.drools.model.view.ViewItem<?> prerequisitePattern, org.drools.model.Variable<A> boundVarA, org.drools.model.Variable<B> boundVarB, org.drools.model.Variable<C> boundVarC)
    Create an IndirectPatternVariable on TriTuple with pre-made bindings for its components variables.
    protected static <A, B, C> org.optaplanner.constraint.streams.drools.common.DirectPatternVariable<C>
    decomposeWithAccumulate(org.drools.model.Variable<org.optaplanner.constraint.streams.drools.common.BiTuple<A,B>> primaryVariable, org.drools.model.view.ViewItem<?> prerequisitePattern, org.drools.model.Variable<A> boundVarA, org.drools.model.Variable<B> boundVarB, org.drools.model.Variable<C> accumulateOutput)
    Create a DirectPatternVariable on BiTuple with pre-made bindings for its components variables and one accumulate output variable.
    protected static <A, B, C, D> org.optaplanner.constraint.streams.drools.common.DirectPatternVariable<D>
    decomposeWithAccumulate(org.drools.model.Variable<org.optaplanner.constraint.streams.drools.common.TriTuple<A,B,C>> primaryVariable, org.drools.model.view.ViewItem<?> prerequisitePattern, org.drools.model.Variable<A> boundVarA, org.drools.model.Variable<B> boundVarB, org.drools.model.Variable<C> boundVarC, org.drools.model.Variable<D> accumulateOutput)
    Create a DirectPatternVariable on TriTuple with pre-made bindings for its components variables and one accumulate output variable.
    protected static org.drools.model.Index.ConstraintType
    getConstraintType(org.optaplanner.core.impl.score.stream.JoinerType type)
     
    PatternVariable<A,?,?>
    getPatternVariableA()
     
    protected static org.drools.model.view.ViewItem<?>
    joinViewItemsWithLogicalAnd(PatternVariable<?,?,?>... patternVariables)
     
    protected static List<org.drools.model.view.ViewItem<?>>
    mergeViewItems(PatternVariable<?,?,?>... patternVariables)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

  • Method Details

    • getPatternVariableA

      public PatternVariable<A,?,?> getPatternVariableA()

    • andFilter

      public UniLeftHandSide<A> andFilter(Predicate<A> predicate)

    • andExists

      public <B> UniLeftHandSide<A> andExists(Class<B> bClass, org.optaplanner.core.api.score.stream.bi.BiJoiner<A,B>[] joiners, Predicate<B> nullityFilter)

    • andNotExists

      public <B> UniLeftHandSide<A> andNotExists(Class<B> bClass, org.optaplanner.core.api.score.stream.bi.BiJoiner<A,B>[] joiners, Predicate<B> nullityFilter)

    • andJoin

      public <B> BiLeftHandSide<A,B> andJoin(UniLeftHandSide<B> right, org.optaplanner.core.api.score.stream.bi.BiJoiner<A,B> joiner)

    • andGroupBy

      public <NewA> UniLeftHandSide<NewA> andGroupBy(org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewA> collector)

    • andGroupBy

      public <NewA, NewB> BiLeftHandSide<NewA,NewB> andGroupBy(org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewA> collectorA, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewB> collectorB)

    • andGroupBy

      public <NewA, NewB, NewC> TriLeftHandSide<NewA,NewB,NewC> andGroupBy(org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewA> collectorA, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewB> collectorB, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewC> collectorC)

    • andGroupBy

      public <NewA, NewB, NewC, NewD> QuadLeftHandSide<NewA,NewB,NewC,NewD> andGroupBy(org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewA> collectorA, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewB> collectorB, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewC> collectorC, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewD> collectorD)

    • andGroupBy

      public <NewA> UniLeftHandSide<NewA> andGroupBy(Function<A,NewA> keyMapping)

    • andGroupBy

      public <NewA, NewB> BiLeftHandSide<NewA,NewB> andGroupBy(Function<A,NewA> keyMappingA, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewB> collectorB)

    • andGroupBy

      public <NewA, NewB, NewC> TriLeftHandSide<NewA,NewB,NewC> andGroupBy(Function<A,NewA> keyMappingA, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewB> collectorB, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewC> collectorC)

    • andGroupBy

      public <NewA, NewB, NewC, NewD> QuadLeftHandSide<NewA,NewB,NewC,NewD> andGroupBy(Function<A,NewA> keyMappingA, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewB> collectorB, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewC> collectorC, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewD> collectorD)

    • andGroupBy

      public <NewA, NewB> BiLeftHandSide<NewA,NewB> andGroupBy(Function<A,NewA> keyMappingA, Function<A,NewB> keyMappingB)

    • andGroupBy

      public <NewA, NewB, NewC> TriLeftHandSide<NewA,NewB,NewC> andGroupBy(Function<A,NewA> keyMappingA, Function<A,NewB> keyMappingB, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewC> collectorC)

    • andGroupBy

      public <NewA, NewB, NewC, NewD> QuadLeftHandSide<NewA,NewB,NewC,NewD> andGroupBy(Function<A,NewA> keyMappingA, Function<A,NewB> keyMappingB, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewC> collectorC, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewD> collectorD)

    • andGroupBy

      public <NewA, NewB, NewC> TriLeftHandSide<NewA,NewB,NewC> andGroupBy(Function<A,NewA> keyMappingA, Function<A,NewB> keyMappingB, Function<A,NewC> keyMappingC)

    • andGroupBy

      public <NewA, NewB, NewC, NewD> QuadLeftHandSide<NewA,NewB,NewC,NewD> andGroupBy(Function<A,NewA> keyMappingA, Function<A,NewB> keyMappingB, Function<A,NewC> keyMappingC, org.optaplanner.core.api.score.stream.uni.UniConstraintCollector<A,?,NewD> collectorD)

    • andGroupBy

      public <NewA, NewB, NewC, NewD> QuadLeftHandSide<NewA,NewB,NewC,NewD> andGroupBy(Function<A,NewA> keyMappingA, Function<A,NewB> keyMappingB, Function<A,NewC> keyMappingC, Function<A,NewD> keyMappingD)

    • andMap

      public <NewA> UniLeftHandSide<NewA> andMap(Function<A,NewA> mapping)

    • andFlattenLast

      public <NewA> UniLeftHandSide<NewA> andFlattenLast(Function<A,Iterable<NewA>> mapping)

    • andTerminate

      public <Solution_> RuleBuilder<Solution_> andTerminate(ToIntFunction<A> matchWeigher)

    • andTerminate

      public <Solution_> RuleBuilder<Solution_> andTerminate(ToLongFunction<A> matchWeigher)

    • andTerminate

      public <Solution_> RuleBuilder<Solution_> andTerminate(Function<A,BigDecimal> matchWeigher)

    • getConstraintType

      protected static org.drools.model.Index.ConstraintType getConstraintType(org.optaplanner.core.impl.score.stream.JoinerType type)

    • joinViewItemsWithLogicalAnd

      protected static org.drools.model.view.ViewItem<?> joinViewItemsWithLogicalAnd(PatternVariable<?,?,?>... patternVariables)

    • mergeViewItems

      protected static List<org.drools.model.view.ViewItem<?>> mergeViewItems(PatternVariable<?,?,?>... patternVariables)

    • decompose

      protected static <A, B> org.optaplanner.constraint.streams.drools.common.IndirectPatternVariable<B,org.optaplanner.constraint.streams.drools.common.BiTuple<A,B>> decompose(org.drools.model.Variable<org.optaplanner.constraint.streams.drools.common.BiTuple<A,B>> primaryVariable, org.drools.model.view.ViewItem<?> prerequisitePattern, org.drools.model.Variable<A> boundVarA, org.drools.model.Variable<B> boundVarB)
      Create an IndirectPatternVariable on BiTuple with pre-made bindings for its components variables.
      Type Parameters:
      A - generic type of the first bound variable
      B - generic type of the second bound variable
      Parameters:
      primaryVariable - never null
      prerequisitePattern - never null, pattern required to construct the variable
      boundVarA - never null, BiTuple.a
      boundVarB - never null, BiTuple.b
      Returns:
      never null

    • decomposeWithAccumulate

      protected static <A, B, C> org.optaplanner.constraint.streams.drools.common.DirectPatternVariable<C> decomposeWithAccumulate(org.drools.model.Variable<org.optaplanner.constraint.streams.drools.common.BiTuple<A,B>> primaryVariable, org.drools.model.view.ViewItem<?> prerequisitePattern, org.drools.model.Variable<A> boundVarA, org.drools.model.Variable<B> boundVarB, org.drools.model.Variable<C> accumulateOutput)
      Create a DirectPatternVariable on BiTuple with pre-made bindings for its components variables and one accumulate output variable.
      Type Parameters:
      A - generic type of the first bound variable
      B - generic type of the second bound variable
      C - generic type of the accumulate output variable
      Parameters:
      primaryVariable - never null
      prerequisitePattern - never null, pattern required to construct the variable
      boundVarA - never null, TriTuple.a
      boundVarB - never null, TriTuple.b
      accumulateOutput - never null, output of the accumulate function
      Returns:
      never null

    • decompose

      protected static <A, B, C> org.optaplanner.constraint.streams.drools.common.IndirectPatternVariable<C,org.optaplanner.constraint.streams.drools.common.TriTuple<A,B,C>> decompose(org.drools.model.Variable<org.optaplanner.constraint.streams.drools.common.TriTuple<A,B,C>> primaryVariable, org.drools.model.view.ViewItem<?> prerequisitePattern, org.drools.model.Variable<A> boundVarA, org.drools.model.Variable<B> boundVarB, org.drools.model.Variable<C> boundVarC)
      Create an IndirectPatternVariable on TriTuple with pre-made bindings for its components variables.
      Type Parameters:
      A - generic type of the first bound variable
      B - generic type of the second bound variable
      C - generic type of the third bound variable
      Parameters:
      primaryVariable - never null
      prerequisitePattern - never null, pattern required to construct the variable
      boundVarA - never null, TriTuple.a
      boundVarB - never null, TriTuple.b
      boundVarC - never null, TriTuple.c
      Returns:
      never null

    • decompose

      protected static <A, B, C, D> org.optaplanner.constraint.streams.drools.common.IndirectPatternVariable<D,org.optaplanner.constraint.streams.drools.common.QuadTuple<A,B,C,D>> decompose(org.drools.model.Variable<org.optaplanner.constraint.streams.drools.common.QuadTuple<A,B,C,D>> primaryVariable, org.drools.model.view.ViewItem<?> prerequisitePattern, org.drools.model.Variable<A> boundVarA, org.drools.model.Variable<B> boundVarB, org.drools.model.Variable<C> boundVarC, org.drools.model.Variable<D> boundVarD)
      Create an IndirectPatternVariable on QuadTuple with pre-made bindings for its components variables.
      Type Parameters:
      A - generic type of the first bound variable
      B - generic type of the second bound variable
      C - generic type of the third bound variable
      D - generic type of the fourth bound variable
      Parameters:
      primaryVariable - never null
      prerequisitePattern - never null, pattern required to construct the variable
      boundVarA - never null, QuadTuple.a
      boundVarB - never null, QuadTuple.b
      boundVarC - never null, QuadTuple.c
      boundVarD - never null, QuadTuple.d
      Returns:
      never null

    • decomposeWithAccumulate

      protected static <A, B, C, D> org.optaplanner.constraint.streams.drools.common.DirectPatternVariable<D> decomposeWithAccumulate(org.drools.model.Variable<org.optaplanner.constraint.streams.drools.common.TriTuple<A,B,C>> primaryVariable, org.drools.model.view.ViewItem<?> prerequisitePattern, org.drools.model.Variable<A> boundVarA, org.drools.model.Variable<B> boundVarB, org.drools.model.Variable<C> boundVarC, org.drools.model.Variable<D> accumulateOutput)
      Create a DirectPatternVariable on TriTuple with pre-made bindings for its components variables and one accumulate output variable.
      Type Parameters:
      A - generic type of the first bound variable
      B - generic type of the second bound variable
      C - generic type of the third bound variable
      D - generic type of the accumulate output variable
      Parameters:
      primaryVariable - never null
      prerequisitePattern - never null, pattern required to construct the variable
      boundVarA - never null, TriTuple.a
      boundVarB - never null, TriTuple.b
      boundVarC - never null, TriTuple.c
      accumulateOutput - never null, output of the accumulate function
      Returns:
      never null

    • buildAccumulate

      protected static org.drools.model.view.ViewItem<?> buildAccumulate(org.drools.model.view.ViewItem<?> innerAccumulatePattern, org.drools.model.functions.accumulate.AccumulateFunction... accFunctions)