001: /**
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */package org.apache.solr.request;
017:
018: import org.apache.solr.search.SolrIndexSearcher;
019: import org.apache.solr.schema.IndexSchema;
020: import org.apache.solr.util.ContentStream;
021: import org.apache.solr.core.SolrCore;
022:
023: import java.util.Map;
024:
025: /**
026: * <p>Container for a request to execute a query.</p>
027: * <p><code>SolrQueryRequest</code> is not thread safe.</p>
028: *
029: * @author yonik
030: * @version $Id: SolrQueryRequest.java 523774 2007-03-29 17:28:31Z yonik $
031: */
032: public interface SolrQueryRequest {
033:
034: /** returns the current request parameters */
035: public SolrParams getParams();
036:
037: /** Change the parameters for this request. This does not affect
038: * the original parameters returned by getOriginalParams()
039: */
040: public void setParams(SolrParams params);
041:
042: /** A Collection of ContentStreams passed to the request
043: */
044: public Iterable<ContentStream> getContentStreams();
045:
046: /** Returns the original request parameters. As this
047: * does not normally include configured defaults
048: * it's more suitable for logging.
049: */
050: public SolrParams getOriginalParams();
051:
052: /**
053: * Generic information associated with this request that may be both read and updated.
054: */
055: public Map<Object, Object> getContext();
056:
057: /**
058: * This method should be called when all uses of this request are
059: * finished, so that resources can be freed.
060: */
061: public void close();
062:
063: /**
064: * Returns the input parameter value for the specified name
065: * @return the value, or the first value if the parameter was
066: * specified more then once; may be null.
067: */
068: @Deprecated
069: public String getParam(String name);
070:
071: /**
072: * Returns the input parameter values for the specified name
073: * @return the values; may be null or empty depending on implementation
074: */
075: @Deprecated
076: public String[] getParams(String name);
077:
078: /**
079: * Returns the primary query string parameter of the request
080: */
081: @Deprecated
082: public String getQueryString();
083:
084: /**
085: * Signifies the syntax and the handler that should be used
086: * to execute this query.
087: */
088: @Deprecated
089: public String getQueryType();
090:
091: /** starting position in matches to return to client */
092: @Deprecated
093: public int getStart();
094:
095: /** number of matching documents to return */
096: @Deprecated
097: public int getLimit();
098:
099: /** The start time of this request in milliseconds */
100: public long getStartTime();
101:
102: /** The index searcher associated with this request */
103: public SolrIndexSearcher getSearcher();
104:
105: /** The solr core (coordinator, etc) associated with this request */
106: public SolrCore getCore();
107:
108: /** The index schema associated with this request */
109: public IndexSchema getSchema();
110:
111: /**
112: * Returns a string representing all the important parameters.
113: * Suitable for logging.
114: */
115: public String getParamString();
116:
117: /******
118: // Get the current elapsed time in milliseconds
119: public long getElapsedTime();
120: ******/
121: }
|