1 package org.drools.spi;
2
3 /*
4 $Id: Extractor.java,v 1.2 2002/08/19 00:38:43 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.rule.Declaration;
50
51 /*** Extracts new facts from existing facts.
52 *
53 * @see Tuple
54 * @see org.drools.rule.Declaration
55 * @see org.drools.rule.Extraction
56 *
57 * @author <a href="mailto:bob@eng.werken.com">bob mcwhirter</a>
58 */
59 public interface Extractor extends SemanticComponent
60 {
61 /*** Retrieve the array of <code>Declaration</code>s required
62 * by this <code>Extractor</code> to perform its duties.
63 *
64 * @return The array of <code>Declarations</code> expected
65 * on incoming <code>Tuple</code>s.
66 */
67 Declaration[] getRequiredTupleMembers();
68
69 /*** Extract a new fact from the incoming <code>Tuple</code>
70 *
71 * @param tuple The source data tuple.
72 *
73 * @return The newly extract fact object.
74 *
75 * @throws ExtractionException if an error occurs during
76 * fact extraction activities.
77 */
78 Object extractFact(Tuple tuple) throws ExtractionException;
79 }
This page was automatically generated by Maven