src/main/java/de/ids_mannheim/korap/query/spans/OrderedDistanceSpans.java

package de.ids_mannheim.korap.query.spans;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import org.apache.lucene.index.LeafReaderContext;
import org.apache.lucene.index.Term;
import org.apache.lucene.index.TermContext;
import org.apache.lucene.util.Bits;

import de.ids_mannheim.korap.query.SpanDistanceQuery;

/**
 * Base class for calculating a distance between two ordered spans.
 * 
 * @author margaretha
 * */
public abstract class OrderedDistanceSpans extends DistanceSpans {

    protected boolean hasMoreFirstSpans;
    protected int minDistance, maxDistance;

    protected List<CandidateSpan> candidateList;
    protected int candidateListIndex;
    protected int candidateListDocNum;


    /**
     * Constructs OrderedDistanceSpans based on the given
     * SpanDistanceQuery.
     * 
     * @param query
     *            a SpanDistanceQuery
     * @param context
     * @param acceptDocs
     * @param termContexts
     * @throws IOException
     */
    public OrderedDistanceSpans (SpanDistanceQuery query,
                                 LeafReaderContext context, Bits acceptDocs,
                                 Map<Term, TermContext> termContexts)
            throws IOException {
        super(query, context, acceptDocs, termContexts);

        minDistance = query.getMinDistance();
        maxDistance = query.getMaxDistance();

        hasMoreFirstSpans = firstSpans.next();

        candidateList = new ArrayList<>();
        candidateListIndex = -1;
        candidateListDocNum = firstSpans.doc();
    }


    /**
     * Finds a span match in the candidate list.
     * */
    @Override
    protected boolean advance () throws IOException {
        while (hasMoreSpans && candidateListIndex < candidateList.size()) {
            // Check candidates
            for (candidateListIndex++; candidateListIndex < candidateList
                    .size(); candidateListIndex++) {
                if (findMatch())
                    return true;
            }

            do { // Forward secondspan
                hasMoreSpans = secondSpans.next();
                setCandidateList();
            }
            while (hasMoreSpans && !isSecondSpanValid());
        }
        return false;
    }


    /**
     * Determines if the current second span is valid (i.e. within an
     * element).
     * It is always valid in TokenDistanceSpan, but it can be invalid
     * in the
     * ElementDistanceSpan, namely when it is not within a particular
     * element (a
     * sentence or a paragraph depends on the element distance unit).
     * 
     * @return <code>true</code> of the current second span is valid,
     *         <code>false</code> otherwise.
     * @throws IOException
     */
    protected abstract boolean isSecondSpanValid () throws IOException;


    /**
     * Stores/collects the states of all possible firstspans as
     * candidate spans
     * for the current secondspan. The candidate spans must be within
     * the
     * maximum distance from the current secondspan.
     * 
     * @throws IOException
     */
    protected abstract void setCandidateList () throws IOException;


    /**
     * Defines the conditions for a match and tells if a match is
     * found.
     * 
     * @return <code>true</code> if a match is found,
     *         <code>false</code>
     *         otherwise.
     * @throws IOException
     */
    protected abstract boolean findMatch () throws IOException;


    /**
     * Defines the properties of a span match. The distance between
     * the first
     * and the second spans is zero, when there is an intersection
     * between them
     * in {@link TokenDistanceSpans}, or they occur in the same
     * element in {@link ElementDistanceSpans}.
     * 
     * @param candidateSpan
     *            a match span
     * @param isDistanceZero
     *            <code>true</code> if the distance between the first
     *            and the second spans is zero, <code>false</code>
     *            otherwise.
     * @throws IOException
     */
    protected void setMatchProperties (CandidateSpan candidateSpan,
            boolean isDistanceZero) throws IOException {

        setMatchFirstSpan(candidateSpan);
        setMatchSecondSpan(new CandidateSpan(secondSpans));

        if (isDistanceZero) {
            matchStartPosition = Math.min(candidateSpan.getStart(),
                    secondSpans.start());
            matchEndPosition = Math.max(candidateSpan.getEnd(),
                    secondSpans.end());
        }
        else {
            matchStartPosition = candidateSpan.getStart();
            matchEndPosition = secondSpans.end();
        }

        this.matchDocNumber = secondSpans.doc();
        if (collectPayloads) {
            if (candidateSpan.getPayloads() != null) {
                matchPayload.addAll(candidateSpan.getPayloads());
            }
            if (secondSpans.isPayloadAvailable()) {
                matchPayload.addAll(secondSpans.getPayload());
            }
        }
    }


    @Override
    public boolean skipTo (int target) throws IOException {
        if (hasMoreSpans && (secondSpans.doc() < target)) {
            if (!secondSpans.skipTo(target)) {
                candidateList.clear();
                return false;
            }
        }

        setCandidateList();
        matchPayload.clear();
        isStartEnumeration = false;
        return advance();
    }
}