1 package org.apache.lucene.queryParser.spans;
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 import org.apache.lucene.queryParser.core.nodes.FieldableNode;
21 import org.apache.lucene.util.AttributeImpl;
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/>
29 * @see UniqueFieldQueryNodeProcessor
31 public class UniqueFieldAttributeImpl extends AttributeImpl implements
32 UniqueFieldAttribute {
34 private static final long serialVersionUID = 8553318595851064232L;
36 { enableBackwards = false; }
38 private CharSequence uniqueField;
40 public UniqueFieldAttributeImpl() {
46 this.uniqueField = "";
49 public void setUniqueField(CharSequence uniqueField) {
50 this.uniqueField = uniqueField;
53 public CharSequence getUniqueField() {
54 return this.uniqueField;
58 public void copyTo(AttributeImpl target) {
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());
66 UniqueFieldAttributeImpl uniqueFieldAttr = (UniqueFieldAttributeImpl) target;
67 uniqueFieldAttr.uniqueField = uniqueField.toString();
72 public boolean equals(Object other) {
74 if (other instanceof UniqueFieldAttributeImpl) {
76 return ((UniqueFieldAttributeImpl) other).uniqueField
77 .equals(this.uniqueField);
86 public int hashCode() {
87 return this.uniqueField.hashCode();
91 public String toString() {
92 return "<uniqueField uniqueField='" + this.uniqueField + "'/>";