1 package org.drools.reteoo.impl;
2
3 /*
4 $Id: AgendaItem.java,v 1.3 2002/08/10 19:34:32 bob Exp $
5
6 Copyright 2002 (C) The Werken Company. All Rights Reserved.
7
8 Redistribution and use of this software and associated documentation
9 ("Software"), with or without modification, are permitted provided
10 that the following conditions are met:
11
12 1. Redistributions of source code must retain copyright
13 statements and notices. Redistributions must also contain a
14 copy of this document.
15
16 2. Redistributions in binary form must reproduce the
17 above copyright notice, this list of conditions and the
18 following disclaimer in the documentation and/or other
19 materials provided with the distribution.
20
21 3. The name "drools" must not be used to endorse or promote
22 products derived from this Software without prior written
23 permission of The Werken Company. For written permission,
24 please contact bob@werken.com.
25
26 4. Products derived from this Software may not be called "drools"
27 nor may "drools" appear in their names without prior written
28 permission of The Werken Company. "drools" is a registered
29 trademark of The Werken Company.
30
31 5. Due credit should be given to The Werken Company.
32 (http://drools.werken.com/).
33
34 THIS SOFTWARE IS PROVIDED BY THE WERKEN COMPANY AND CONTRIBUTORS
35 ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
36 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
37 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
38 THE WERKEN COMPANY OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
39 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
40 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
41 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
42 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
43 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
44 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
45 OF THE POSSIBILITY OF SUCH DAMAGE.
46
47 */
48
49 import org.drools.WorkingMemory;
50
51 import org.drools.rule.Rule;
52 import org.drools.spi.ConsequenceException;
53
54 /*** Item entry in the <code>Agenda</code>.
55 *
56 * @author <a href="mailto:bob@eng.werken.com">bob mcwhirter</a>
57 */
58 class AgendaItem
59 {
60 // ------------------------------------------------------------
61 // Instance members
62 // ------------------------------------------------------------
63
64 /*** The tuple. */
65 private ReteTuple tuple;
66
67 /*** The rule. */
68 private Rule rule;
69
70 // ------------------------------------------------------------
71 // Constructors
72 // ------------------------------------------------------------
73
74 /*** Construct.
75 *
76 * @param tuple The tuple.
77 * @param rule The rule.
78 */
79 AgendaItem(ReteTuple tuple,
80 Rule rule)
81 {
82 this.tuple = tuple;
83 this.rule = rule;
84 }
85
86 // ------------------------------------------------------------
87 // Instance methods
88 // ------------------------------------------------------------
89
90 /*** Retrieve the rule.
91 *
92 * @return The rule.
93 */
94 Rule getRule()
95 {
96 return this.rule;
97 }
98
99 /*** Determine if this tuple depends on the values
100 * derrived from a particular root object.
101 *
102 * @param object The root object.
103 *
104 * @return <code>true<code> if this agenda item depends
105 * upon the item, otherwise <code>false</code>.
106 */
107 boolean dependsOn(Object object)
108 {
109 return getTuple().dependsOn( object );
110 }
111
112 /*** Set the tuple.
113 *
114 * @param tuple The tuple.
115 */
116 void setTuple(ReteTuple tuple)
117 {
118 this.tuple = tuple;
119 }
120
121 /*** Retrieve the tuple.
122 *
123 * @return The tuple.
124 */
125 ReteTuple getTuple()
126 {
127 return this.tuple;
128 }
129
130 /*** Fire this item.
131 *
132 * @param workingMemory The working memory context.
133 *
134 * @throws ConsequenceException If an error occurs while
135 * attempting to fire the consequence.
136 */
137 void fire(WorkingMemory workingMemory) throws ConsequenceException
138 {
139 getRule().getConsequence().invoke( getTuple(),
140 workingMemory );
141 }
142
143 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
144 // java.lang.Object;
145 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
146
147 /*** Retrieve a debug string.
148 *
149 * @return The debug string.
150 */
151 public String toString()
152 {
153 return "[" + getTuple() + getRule().getName() + "]";
154 }
155 }
This page was automatically generated by Maven