org.apache.solr.request.SolrQueryRequest Maven / Gradle / Ivy
The newest version!
/**
* 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.request;
import org.apache.solr.search.SolrIndexSearcher;
import org.apache.solr.schema.IndexSchema;
import org.apache.solr.common.params.CommonParams;
import org.apache.solr.common.params.SolrParams;
import org.apache.solr.common.util.ContentStream;
import org.apache.solr.core.SolrCore;
import java.util.Map;
/**
* Container for a request to execute a query.
* SolrQueryRequest is not thread safe.
*
* @version $Id: SolrQueryRequest.java 684908 2008-08-11 20:37:36Z gsingers $
*/
public interface SolrQueryRequest {
/** returns the current request parameters */
public SolrParams getParams();
/** Change the parameters for this request. This does not affect
* the original parameters returned by getOriginalParams()
*/
public void setParams(SolrParams params);
/** A Collection of ContentStreams passed to the request
*/
public Iterable getContentStreams();
/** Returns the original request parameters. As this
* does not normally include configured defaults
* it's more suitable for logging.
*/
public SolrParams getOriginalParams();
/**
* Generic information associated with this request that may be both read and updated.
*/
public Map getContext();
/**
* This method should be called when all uses of this request are
* finished, so that resources can be freed.
*/
public void close();
/**
* Returns the input parameter value for the specified name
* @return the value, or the first value if the parameter was
* specified more then once; may be null.
* @deprecated Use {@link #getParams()} instead.
*/
@Deprecated
public String getParam(String name);
/**
* Returns the input parameter values for the specified name
* @return the values; may be null or empty depending on implementation
* @deprecated Use {@link #getParams()} instead.
*/
@Deprecated
public String[] getParams(String name);
/**
* Returns the primary query string parameter of the request
* @deprecated Use {@link #getParams()} and {@link CommonParams#Q} instead.
*/
@Deprecated
public String getQueryString();
/**
* Signifies the syntax and the handler that should be used
* to execute this query.
* @deprecated Use {@link #getParams()} and {@link CommonParams#QT} instead.
*/
@Deprecated
public String getQueryType();
/** starting position in matches to return to client
* @deprecated Use {@link #getParams()} and {@link CommonParams#START} instead.
*/
@Deprecated
public int getStart();
/** number of matching documents to return
* @deprecated Use {@link #getParams()} and {@link CommonParams#ROWS} instead.
*/
@Deprecated
public int getLimit();
/** The start time of this request in milliseconds */
public long getStartTime();
/** The index searcher associated with this request */
public SolrIndexSearcher getSearcher();
/** The solr core (coordinator, etc) associated with this request */
public SolrCore getCore();
/** The index schema associated with this request */
public IndexSchema getSchema();
/**
* Returns a string representing all the important parameters.
* Suitable for logging.
*/
public String getParamString();
/******
// Get the current elapsed time in milliseconds
public long getElapsedTime();
******/
}