pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / queryparser / src / java / org / apache / lucene / queryParser / standard / config / DateResolutionAttribute.java
1 package org.apache.lucene.queryParser.standard.config;
2
3 /**
4  * Licensed to the Apache Software Foundation (ASF) under one or more
5  * contributor license agreements.  See the NOTICE file distributed with
6  * this work for additional information regarding copyright ownership.
7  * The ASF licenses this file to You under the Apache License, Version 2.0
8  * (the "License"); you may not use this file except in compliance with
9  * the License.  You may obtain a copy of the License at
10  *
11  *     http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19
20 import org.apache.lucene.document.DateTools;
21 import org.apache.lucene.document.DateTools.Resolution;
22 import org.apache.lucene.queryParser.core.config.QueryConfigHandler;
23 import org.apache.lucene.queryParser.standard.nodes.RangeQueryNode;
24 import org.apache.lucene.queryParser.standard.processors.ParametricRangeQueryNodeProcessor;
25 import org.apache.lucene.util.Attribute;
26
27 /**
28  * This attribute is used by {@link ParametricRangeQueryNodeProcessor} processor
29  * and must be defined in the {@link QueryConfigHandler}. This attribute tells
30  * the processor which {@link Resolution} to use when parsing the date. <br/>
31  * 
32  * @deprecated
33  * 
34  */
35 @Deprecated
36 public interface DateResolutionAttribute extends Attribute {
37   /**
38    * Sets the default date resolution used by {@link RangeQueryNode}s for
39    * fields for which no specific date resolutions has been set. Field
40    * specific resolutions can be set with
41    * 
42    * @param dateResolution the default date resolution to set
43    */
44   public void setDateResolution(DateTools.Resolution dateResolution);
45   public DateTools.Resolution getDateResolution();
46 }