add --shared
[pylucene.git] / lucene-java-3.4.0 / lucene / contrib / queryparser / src / test / org / apache / lucene / queryParser / spans / UniqueFieldAttributeImpl.java
1 package org.apache.lucene.queryParser.spans;
2
3 /**
4  * Licensed to the Apache Software Foundation (ASF) under one or more
5  * contributor license agreements.  See the NOTICE file distributed with
6  * this work for additional information regarding copyright ownership.
7  * The ASF licenses this file to You under the Apache License, Version 2.0
8  * (the "License"); you may not use this file except in compliance with
9  * the License.  You may obtain a copy of the License at
10  *
11  *     http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19
20 import org.apache.lucene.queryParser.core.nodes.FieldableNode;
21 import org.apache.lucene.util.AttributeImpl;
22
23 /**
24  * This attribute is used by the {@link UniqueFieldQueryNodeProcessor}
25  * processor. It holds a value that defines which is the unique field name that
26  * should be set in every {@link FieldableNode}.<br/>
27  * <br/>
28  * 
29  * @see UniqueFieldQueryNodeProcessor
30  */
31 public class UniqueFieldAttributeImpl extends AttributeImpl implements
32     UniqueFieldAttribute {
33
34   private static final long serialVersionUID = 8553318595851064232L;
35
36   { enableBackwards = false; }
37   
38   private CharSequence uniqueField;
39
40   public UniqueFieldAttributeImpl() {
41     clear();
42   }
43
44   @Override
45   public void clear() {
46     this.uniqueField = "";
47   }
48
49   public void setUniqueField(CharSequence uniqueField) {
50     this.uniqueField = uniqueField;
51   }
52
53   public CharSequence getUniqueField() {
54     return this.uniqueField;
55   }
56
57   @Override
58   public void copyTo(AttributeImpl target) {
59
60     if (!(target instanceof UniqueFieldAttributeImpl)) {
61       throw new IllegalArgumentException(
62           "cannot copy the values from attribute UniqueFieldAttribute to an instance of "
63               + target.getClass().getName());
64     }
65
66     UniqueFieldAttributeImpl uniqueFieldAttr = (UniqueFieldAttributeImpl) target;
67     uniqueFieldAttr.uniqueField = uniqueField.toString();
68
69   }
70
71   @Override
72   public boolean equals(Object other) {
73
74     if (other instanceof UniqueFieldAttributeImpl) {
75
76       return ((UniqueFieldAttributeImpl) other).uniqueField
77           .equals(this.uniqueField);
78
79     }
80
81     return false;
82
83   }
84
85   @Override
86   public int hashCode() {
87     return this.uniqueField.hashCode();
88   }
89
90   @Override
91   public String toString() {
92     return "<uniqueField uniqueField='" + this.uniqueField + "'/>";
93   }
94
95 }