ScopePhase.java

/*
 * Licensed to Elastic Search and Shay Banon under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. Elastic Search 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.elasticsearch.search.internal;

import org.apache.lucene.search.Collector;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.TopDocs;

/**
 *
 */
public interface ScopePhase {

    String scope();

    void clear();

    Query query();

    public interface TopDocsPhase extends ScopePhase {

        void processResults(TopDocs topDocs, SearchContext context);

        int numHits();

        int factor();

        int incrementalFactor();
    }

    public interface CollectorPhase extends ScopePhase {

        boolean requiresProcessing();

        Collector collector();

        void processCollector(Collector collector);
    }
}