pylucene 3.5.0-3

[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / queryparser / src / java / org / apache / lucene / queryParser / core / config / FieldConfig.java

diff --git a/lucene-java-3.5.0/lucene/contrib/queryparser/src/java/org/apache/lucene/queryParser/core/config/FieldConfig.java b/lucene-java-3.5.0/lucene/contrib/queryparser/src/java/org/apache/lucene/queryParser/core/config/FieldConfig.java
new file mode 100644 (file)
index 0000000..5ea7204
--- /dev/null
+++ b/lucene-java-3.5.0/lucene/contrib/queryparser/src/java/org/apache/lucene/queryParser/core/config/FieldConfig.java
@@ -0,0 +1,90 @@
+package org.apache.lucene.queryParser.core.config;
+
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import org.apache.lucene.queryParser.core.util.StringUtils;
+import org.apache.lucene.util.AttributeSource;
+
+/**
+ * This class represents a field configuration. Every configuration should be
+ * set using the methods inherited from {@link AttributeSource}.
+ * 
+ * @see QueryConfigHandler
+ * @see org.apache.lucene.util.Attribute
+ */
+public class FieldConfig extends AbstractQueryConfig {
+
+  private String fieldName;
+
+  /**
+   * Constructs a {@link FieldConfig}
+   * 
+   * @param fieldName the field name, it cannot be null
+   * @throws IllegalArgumentException if the field name is null
+   * 
+   * @deprecated use {@link #FieldConfig(String)} instead
+   */
+  @Deprecated
+  public FieldConfig(CharSequence fieldName) {
+    this(StringUtils.toString(fieldName));
+  }
+
+  /**
+   * Constructs a {@link FieldConfig}
+   * 
+   * @param fieldName the field name, it cannot be null
+   * @throws IllegalArgumentException if the field name is null
+   */
+  public FieldConfig(String fieldName) {
+
+    if (fieldName == null) {
+      throw new IllegalArgumentException("field name should not be null!");
+    }
+
+    this.fieldName = fieldName;
+
+  }
+
+  /**
+   * Returns the field name this configuration represents.
+   * 
+   * @return the field name
+   * 
+   * @deprecated use {@link #getField()} instead
+   */
+  @Deprecated
+  public CharSequence getFieldName() {
+    return this.fieldName;
+  }
+
+  /**
+   * Returns the field name this configuration represents.
+   * 
+   * @return the field name
+   */
+  public String getField() {
+    return this.fieldName;
+  }
+
+  @Override
+  public String toString() {
+    return "<fieldconfig name=\"" + this.fieldName + "\" configurations=\""
+        + super.toString() + "\"/>";
+  }
+
+}