solr/core/src/java/org/apache/solr/search/ExtendedQuery.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.solr.search;

/** The ExtendedQuery interface provides extra metadata to a query.
 *  Implementations of ExtendedQuery must also extend Query.
 */
public interface ExtendedQuery {
  /** Should this query be cached in the query cache or filter cache. */
  public boolean getCache();

  public void setCache(boolean cache);

  /** Returns the cost of this query, used to order checking of filters that are not cached.
   * If getCache()==false && getCost()>=100 && this instanceof PostFilter, then
   * the PostFilter interface will be used for filtering.
   */
  public int getCost();

  public void setCost(int cost);

  /** If true, the clauses of this boolean query should be cached separately. This is not yet implemented. */
  public boolean getCacheSep();
  public void setCacheSep(boolean cacheSep);
}