|
|||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
Configuration.java | - | - | - | - |
|
1 | package org.drools.smf; | |
2 | ||
3 | /* | |
4 | * $Id: Configuration.java,v 1.5 2005/01/23 18:16:20 mproctor Exp $ | |
5 | * | |
6 | * Copyright 2001-2003 (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 that the | |
10 | * following conditions are met: | |
11 | * | |
12 | * 1. Redistributions of source code must retain copyright statements and | |
13 | * notices. Redistributions must also contain a copy of this document. | |
14 | * | |
15 | * 2. Redistributions in binary form must reproduce the above copyright notice, | |
16 | * this list of conditions and the following disclaimer in the documentation | |
17 | * and/or other materials provided with the distribution. | |
18 | * | |
19 | * 3. The name "drools" must not be used to endorse or promote products derived | |
20 | * from this Software without prior written permission of The Werken Company. | |
21 | * For written permission, please contact bob@werken.com. | |
22 | * | |
23 | * 4. Products derived from this Software may not be called "drools" nor may | |
24 | * "drools" appear in their names without prior written permission of The Werken | |
25 | * Company. "drools" is a trademark of The Werken Company. | |
26 | * | |
27 | * 5. Due credit should be given to The Werken Company. (http://werken.com/) | |
28 | * | |
29 | * THIS SOFTWARE IS PROVIDED BY THE WERKEN COMPANY AND CONTRIBUTORS ``AS IS'' | |
30 | * AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
31 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
32 | * ARE DISCLAIMED. IN NO EVENT SHALL THE WERKEN COMPANY OR ITS CONTRIBUTORS BE | |
33 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
34 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
35 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
36 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
37 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
38 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
39 | * POSSIBILITY OF SUCH DAMAGE. | |
40 | * | |
41 | */ | |
42 | ||
43 | /** | |
44 | * Configuration passed to a configurable <code>SemanticComponent</code>. | |
45 | * | |
46 | * <p> | |
47 | * A <code>Configuration</code> may actually form a tree-shaped structure in | |
48 | * order to hold complex configuration data. Each node in the tree is | |
49 | * represented by a <code>Configuration</code> object that has a name and may | |
50 | * contain attributes, children and text. | |
51 | * </p> | |
52 | * | |
53 | * @author <a href="mailto:bob@werken.com">bob mcwhirter </a> | |
54 | * | |
55 | * @version $Id: Configuration.java,v 1.5 2005/01/23 18:16:20 mproctor Exp $ | |
56 | */ | |
57 | public interface Configuration | |
58 | { | |
59 | // ---------------------------------------------------------------------- | |
60 | // Constants | |
61 | // ---------------------------------------------------------------------- | |
62 | ||
63 | /** Empty <code>Configuration</code> array. */ | |
64 | Configuration[] EMPTY_ARRAY = new Configuration[0]; | |
65 | ||
66 | // ---------------------------------------------------------------------- | |
67 | // Interface | |
68 | // ---------------------------------------------------------------------- | |
69 | ||
70 | /** | |
71 | * Retrieve the node name. | |
72 | * | |
73 | * @return The node name. | |
74 | */ | |
75 | String getName(); | |
76 | ||
77 | /** | |
78 | * Retrieve the node text. | |
79 | * | |
80 | * @return The node text. | |
81 | */ | |
82 | String getText(); | |
83 | ||
84 | /** | |
85 | * Retrieve an attribute value. | |
86 | * | |
87 | * @param name The attribute name. | |
88 | * | |
89 | * @return The attribute value or <code>null</code> if no attribute | |
90 | * matches the specified name. | |
91 | */ | |
92 | String getAttribute(String name); | |
93 | ||
94 | /** | |
95 | * Retrieve all attribute names. | |
96 | * | |
97 | * @return The attribute names. | |
98 | */ | |
99 | String[] getAttributeNames(); | |
100 | ||
101 | /** | |
102 | * Retrieve a child node. | |
103 | * | |
104 | * @param name The child name. | |
105 | * | |
106 | * @return The first child matching the specified name, otherwise | |
107 | * <code>null</code> if none match. | |
108 | */ | |
109 | Configuration getChild(String name); | |
110 | ||
111 | /** | |
112 | * Retrieve children nodes. | |
113 | * | |
114 | * @param name The child name. | |
115 | * | |
116 | * @return All children matching the specified name, otherwise an empty | |
117 | * array if none match. | |
118 | */ | |
119 | Configuration[] getChildren(String name); | |
120 | ||
121 | /** | |
122 | * Retrieve all children nodes. | |
123 | * | |
124 | * @return All children nodes, otherwise an empty array if this node | |
125 | * contains no children. | |
126 | */ | |
127 | Configuration[] getChildren(); | |
128 | } |
|