01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.selection;
18:
19: import org.apache.avalon.framework.component.Component;
20: import org.apache.avalon.framework.parameters.Parameters;
21:
22: import java.util.Map;
23:
24: /**
25: *
26: * @author <a href="mailto:Giacomo.Pati@pwr.ch">Giacomo Pati</a>
27: * @author <a href="mailto:leo.sutic">Leo Sutic</a>
28: * @version CVS $Id: Selector.java 433543 2006-08-22 06:22:54Z crossley $
29: */
30: public interface Selector extends Component {
31:
32: String ROLE = Selector.class.getName();
33:
34: /**
35: * Selectors test pattern against some objects in a <code>Map</code>
36: * model and signals success with the returned boolean value
37: * @param expression The expression to test.
38: * @param objectModel The <code>Map</code> containing object of the
39: * calling environment which may be used
40: * to select values to test the expression.
41: * @param parameters The sitemap parameters, as specified by <parameter/> tags.
42: * @return boolean Signals successfull test.
43: */
44: boolean select(String expression, Map objectModel,
45: Parameters parameters);
46: }
|