lucene/core/src/java/org/apache/lucene/search/IndriQuery.java

/*
 * 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.search;

import java.io.IOException;
import java.util.Iterator;
import java.util.List;
import java.util.Objects;

/**
 * A Basic abstract query that all IndriQueries can extend to implement toString, equals,
 * getClauses, and iterator.
 */
public abstract class IndriQuery extends Query implements Iterable<BooleanClause> {

  private List<BooleanClause> clauses;

  public IndriQuery(List<BooleanClause> clauses) {
    this.clauses = clauses;
  }

  @Override
  public abstract Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)
      throws IOException;

  @Override
  public String toString(String field) {
    StringBuilder buffer = new StringBuilder();

    int i = 0;
    for (BooleanClause c : this) {
      buffer.append(c.getOccur().toString());

      Query subQuery = c.getQuery();
      if (subQuery instanceof BooleanQuery) { // wrap sub-bools in parens
        buffer.append("(");
        buffer.append(subQuery.toString(field));
        buffer.append(")");
      } else {
        buffer.append(subQuery.toString(field));
      }

      if (i != clauses.size() - 1) {
        buffer.append(" ");
      }
      i += 1;
    }

    return buffer.toString();
  }

  @Override
  public boolean equals(Object o) {
    return sameClassAs(o) && equalsTo(getClass().cast(o));
  }

  @Override
  public void visit(QueryVisitor visitor) {
    visitor.visitLeaf(this);
  }

  private boolean equalsTo(IndriQuery other) {
    return clauses.equals(other.clauses);
  }

  @Override
  public int hashCode() {
    int hashCode = Objects.hash(clauses);
    if (hashCode == 0) {
      hashCode = 1;
    }
    return hashCode;
  }

  @Override
  public Iterator<BooleanClause> iterator() {
    return clauses.iterator();
  }

  public List<BooleanClause> getClauses() {
    return this.clauses;
  }
}