alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Lucene example source code file (BoostAttributeImpl.java)

This example Lucene source code file (BoostAttributeImpl.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Lucene tags/keywords

attributeimpl, attributeimpl, boostattribute, boostattributeimpl, boostattributeimpl, override, override, string, unsupportedoperationexception, unsupportedoperationexception

The Lucene BoostAttributeImpl.java source code

package org.apache.lucene.queryParser.standard.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.config.FieldConfig;
import org.apache.lucene.queryParser.standard.processors.MultiFieldQueryNodeProcessor;
import org.apache.lucene.util.AttributeImpl;

/**
 * This attribute is used by {@link MultiFieldQueryNodeProcessor} processor and
 * it should be defined in a {@link FieldConfig}. This processor uses this
 * attribute to define which boost a specific field should have when none is
 * defined to it. <br/>
 * <br/>
 * 
 * @see org.apache.lucene.queryParser.standard.config.BoostAttribute
 */
public class BoostAttributeImpl extends AttributeImpl 
				implements BoostAttribute {

  private static final long serialVersionUID = -2104763012523049527L;

  { enableBackwards = false; }
  
  private float boost = 1.0f;

  public BoostAttributeImpl() {
    // empty constructor
  }

  public void setBoost(float boost) {
    this.boost = boost;
  }

  public float getBoost() {
    return this.boost;
  }

  @Override
  public void clear() {
    throw new UnsupportedOperationException();
  }

  @Override
  public void copyTo(AttributeImpl target) {
    throw new UnsupportedOperationException();
  }

  @Override
  public boolean equals(Object other) {

    if (other instanceof BoostAttributeImpl
        && ((BoostAttributeImpl) other).boost == this.boost) {

      return true;

    }

    return false;

  }

  @Override
  public int hashCode() {
    return Float.valueOf(this.boost).hashCode();
  }

  @Override
  public String toString() {
    return "<boostAttribute boost=" + this.boost + "/>";
  }

}

Other Lucene examples (source code examples)

Here is a short list of links related to this Lucene BoostAttributeImpl.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.