lucene/queries/src/java/org/apache/lucene/queries/intervals/DifferenceIntervalsSource.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.queries.intervals;

import java.io.IOException;

import org.apache.lucene.index.LeafReaderContext;
import org.apache.lucene.search.BooleanClause;
import org.apache.lucene.search.QueryVisitor;

abstract class DifferenceIntervalsSource extends IntervalsSource {

  final IntervalsSource minuend;
  final IntervalsSource subtrahend;

  DifferenceIntervalsSource(IntervalsSource minuend, IntervalsSource subtrahend) {
    this.minuend = minuend;
    this.subtrahend = subtrahend;
  }

  protected abstract IntervalIterator combine(IntervalIterator minuend, IntervalIterator subtrahend);

  @Override
  public final IntervalIterator intervals(String field, LeafReaderContext ctx) throws IOException {
    IntervalIterator minIt = minuend.intervals(field, ctx);
    if (minIt == null)
      return null;
    IntervalIterator subIt = subtrahend.intervals(field, ctx);
    if (subIt == null)
      return minIt;
    return combine(minIt, subIt);
  }

  @Override
  public final IntervalMatchesIterator matches(String field, LeafReaderContext ctx, int doc) throws IOException {
    IntervalMatchesIterator minIt = minuend.matches(field, ctx, doc);
    if (minIt == null) {
      return null;
    }
    IntervalMatchesIterator subIt = subtrahend.matches(field, ctx, doc);
    if (subIt == null) {
      return minIt;
    }
    IntervalIterator difference = combine(IntervalMatches.wrapMatches(minIt, doc), IntervalMatches.wrapMatches(subIt, doc));
    return IntervalMatches.asMatches(difference, minIt, doc);
  }

  @Override
  public void visit(String field, QueryVisitor visitor) {
    IntervalQuery q = new IntervalQuery(field, this);
    minuend.visit(field, visitor.getSubVisitor(BooleanClause.Occur.MUST, q));
    subtrahend.visit(field, visitor.getSubVisitor(BooleanClause.Occur.MUST_NOT, q));
  }

  @Override
  public int minExtent() {
    return minuend.minExtent();
  }
}