BooleanClause.java
01 package gate.creole.annic.apache.lucene.search;
02 
03 /**
04  * Copyright 2004 The Apache Software Foundation
05  *
06  * Licensed under the Apache License, Version 2.0 (the "License");
07  * you may not use this file except in compliance with the License.
08  * You may obtain a copy of the License at
09  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 /** A clause in a BooleanQuery. */
20 @SuppressWarnings("serial")
21 public class BooleanClause implements java.io.Serializable {
22   /** The query whose matching documents are combined by the boolean query. */
23   public Query query;
24   /** If true, documents documents which <i>do not</i>
25     match this sub-query will <i>not</i> match the boolean query. */
26   public boolean required = false;
27   /** If true, documents documents which <i>do</i>
28     match this sub-query will <i>not</i> match the boolean query. */
29   public boolean prohibited = false;
30 
31   /** Constructs a BooleanClause with query <code>q</code>, required
32     <code>r</code> and prohibited <code>p</code>. */
33   public BooleanClause(Query q, boolean r, boolean p) {
34     query = q;
35     required = r;
36     prohibited = p;
37   }
38 
39   /** Returns true iff <code>o</code> is equal to this. */
40   @Override
41   public boolean equals(Object o) {
42     if (!(instanceof BooleanClause))
43       return false;
44     BooleanClause other = (BooleanClause)o;
45     return this.query.equals(other.query)
46       && (this.required == other.required)
47       && (this.prohibited == other.prohibited);
48   }
49 
50   /** Returns a hash code value for this object.*/
51   @Override
52   public int hashCode() {
53     return query.hashCode() (this.required?1:0(this.prohibited?2:0);
54   }
55 
56 }