KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > selection > Selector


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.cocoon.selection;
17
18 import org.apache.avalon.framework.component.Component;
19 import org.apache.avalon.framework.parameters.Parameters;
20
21 import java.util.Map JavaDoc;
22
23 /**
24  *
25  * @author <a HREF="mailto:Giacomo.Pati@pwr.ch">Giacomo Pati</a>
26  * @author <a HREF="mailto:leo.sutic">Leo Sutic</a>
27  * @version CVS $Id: Selector.java 30932 2004-07-29 17:35:38Z vgritsenko $
28  */
29 public interface Selector extends Component {
30
31     String JavaDoc ROLE = Selector.class.getName();
32     /**
33      * Selectors test pattern against some objects in a <code>Map</code>
34      * model and signals success with the returned boolean value
35      * @param expression The expression to test.
36      * @param objectModel The <code>Map</code> containing object of the
37      * calling environment which may be used
38      * to select values to test the expression.
39      * @param parameters The sitemap parameters, as specified by &lt;parameter/&gt; tags.
40      * @return boolean Signals successfull test.
41      */
42     boolean select (String JavaDoc expression, Map JavaDoc objectModel, Parameters parameters);
43 }
44
45
46
Popular Tags