/**
* 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
*
*
* 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.
*/
/**
* Parameters used across many handlers
*/
public interface CommonParams {
/** the query type - which query handler should handle the request */
/** the response writer type - the format of the response */
/** query string */
public static final String Q ="q";
/** sort order */
/** Lucene query string(s) for filtering the results without affecting scoring */
/** zero based offset of matching documents to retrieve */
/** number of documents to return starting at "start" */
/** stylesheet to apply to XML results */
/** version parameter to check request-response compatibility */
/** query and init param for field list */
/** default query field */
/** whether to include debug data */
/**
* boolean indicating whether score explanations should structured (true),
* or plain text (false)
*/
/** another query to explain against */
/** If the content stream should come from a URL (using URLConnection) */
/** If the content stream should come from a File (using FileReader) */
/** If the content stream should come directly from a field */
/**
* Explicitly set the content type for the input stream
* If multiple streams are specified, the explicit contentType
* will be used for all of them.
*/
/**
* Timeout value in milliseconds. If not set, or the value is <= 0, there is no timeout.
*/
/** 'true' if the header should include the handler name */
/** include the parameters in the header **/
/** include header in the response */
/** valid values for: <code>echoParams</code> */
public enum EchoParamStyle {
ALL,
NONE;
if( v != null ) {
if( v.equals( "EXPLICIT" ) ) {
return EXPLICIT;
}
if( v.equals( "ALL") ) {
return ALL;
}
return NONE;
}
}
return null;
}
};
/** Used as a local parameter on queries. cache=false means don't check any query or filter caches.
* cache=true is the default.
*/
/** Used as a local param on filter queries in conjunction with cache=false. Filters are checked in order, from
* smallest cost to largest. If cost>=100 and the query implements PostFilter, then that interface will be used to do post query filtering.
*/
}