org.apache.lucene.queries.function.valuesource.MultiFunction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lucene-queries Show documentation
Lucene Queries Module
There is a newer version: 10.0.0
/*
 * 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.
 */
package org.apache.lucene.queries.function.valuesource;

import java.io.IOException;
import java.util.List;
import java.util.Map;
import org.apache.lucene.index.LeafReaderContext;
import org.apache.lucene.queries.function.FunctionValues;
import org.apache.lucene.queries.function.ValueSource;
import org.apache.lucene.search.IndexSearcher;

/**
 * Abstract parent class for {@link ValueSource} implementations that wrap multiple ValueSources and
 * apply their own logic.
 */
public abstract class MultiFunction extends ValueSource {
  protected final List sources;

  public MultiFunction(List sources) {
    this.sources = sources;
  }

  protected abstract String name();

  @Override
  public String description() {
    return description(name(), sources);
  }

  /**
   * Helper utility for {@link FunctionValues}
   *
   * @return true if all of the specified values {@link FunctionValues#exists}
   *     for the specified doc, else false.
   */
  public static boolean allExists(int doc, FunctionValues[] values) throws IOException {
    for (FunctionValues v : values) {
      if (!v.exists(doc)) {
        return false;
      }
    }
    return true;
  }

  /**
   * Helper utility for {@link FunctionValues}
   *
   * @return true if any of the specified values {@link FunctionValues#exists}
   *     for the specified doc, else false.
   */
  public static boolean anyExists(int doc, FunctionValues[] values) throws IOException {
    for (FunctionValues v : values) {
      if (v.exists(doc)) {
        return true;
      }
    }
    return false;
  }

  /**
   * Equivalent to the {@code FunctionValues[]} method with the same name, but optimized for dealing
   * with exactly 2 arguments.
   *
   * @return true if both of the specified values {@link
   *     FunctionValues#exists} for the specified doc, else false.
   * @see #anyExists(int,FunctionValues[])
   */
  public static boolean allExists(int doc, FunctionValues values1, FunctionValues values2)
      throws IOException {
    return values1.exists(doc) && values2.exists(doc);
  }

  /**
   * Equivalent to the {@code FunctionValues[]} method with the same name, but optimized for dealing
   * with exactly 2 arguments.
   *
   * @return true if either of the specified values {@link
   *     FunctionValues#exists} for the specified doc, else false.
   * @see #anyExists(int,FunctionValues[])
   */
  public static boolean anyExists(int doc, FunctionValues values1, FunctionValues values2)
      throws IOException {
    return values1.exists(doc) || values2.exists(doc);
  }

  public static String description(String name, List sources) {
    StringBuilder sb = new StringBuilder();
    sb.append(name).append('(');
    boolean firstTime = true;
    for (ValueSource source : sources) {
      if (firstTime) {
        firstTime = false;
      } else {
        sb.append(',');
      }
      sb.append(source);
    }
    sb.append(')');
    return sb.toString();
  }

  public static FunctionValues[] valsArr(
      List sources, Map fcontext, LeafReaderContext readerContext)
      throws IOException {
    final FunctionValues[] valsArr = new FunctionValues[sources.size()];
    int i = 0;
    for (ValueSource source : sources) {
      valsArr[i++] = source.getValues(fcontext, readerContext);
    }
    return valsArr;
  }

  /** Base implementation that wraps multiple sources */
  public class Values extends FunctionValues {
    final FunctionValues[] valsArr;

    public Values(FunctionValues[] valsArr) {
      this.valsArr = valsArr;
    }

    @Override
    public String toString(int doc) throws IOException {
      return MultiFunction.toString(name(), valsArr, doc);
    }

    @Override
    public ValueFiller getValueFiller() {
      // TODO: need ValueSource.type() to determine correct type
      return super.getValueFiller();
    }
  }

  public static String toString(String name, FunctionValues[] valsArr, int doc) throws IOException {
    StringBuilder sb = new StringBuilder();
    sb.append(name).append('(');
    boolean firstTime = true;
    for (FunctionValues vals : valsArr) {
      if (firstTime) {
        firstTime = false;
      } else {
        sb.append(',');
      }
      sb.append(vals.toString(doc));
    }
    sb.append(')');
    return sb.toString();
  }

  @Override
  public void createWeight(Map context, IndexSearcher searcher) throws IOException {
    for (ValueSource source : sources) {
      source.createWeight(context, searcher);
    }
  }

  @Override
  public int hashCode() {
    return sources.hashCode() + name().hashCode();
  }

  @Override
  public boolean equals(Object o) {
    if (this.getClass() != o.getClass()) return false;
    MultiFunction other = (MultiFunction) o;
    return this.sources.equals(other.sources);
  }
}