1 /***
2 * Copyright 2003-2010 Terracotta, Inc.
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
17 package net.sf.ehcache.search.expression;
18
19 import java.util.Map;
20
21 import net.sf.ehcache.Element;
22 import net.sf.ehcache.search.attribute.AttributeExtractor;
23
24 /***
25 * Criteria interface defines a boolean function that computes a search match result
26 *
27 * @author teck
28 */
29 public interface Criteria {
30
31 /***
32 * Test this criteria against a cache element
33 *
34 * @param element cache element
35 * @param attributeExtractors map of attribute extractors to attribute value names
36 * @return true if the criteria matches this element
37 */
38 boolean execute(Element element, Map<String, AttributeExtractor> attributeExtractors);
39
40 /***
41 * Produce a criteria that is the boolean "and" of this and the given other criteria
42 *
43 * @param other
44 * @return and criteria
45 */
46 Criteria and(Criteria other);
47
48 /***
49 * Produce a criteria that is the boolean "or" of this and the given other criteria
50 *
51 * @param other
52 * @return or criteria
53 */
54 Criteria or(Criteria other);
55
56 /***
57 * Produce a criteria that is the boolean "not" of this
58 *
59 * @return not criteria
60 */
61 Criteria not();
62 }