View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.gui.query;
35  
36  import java.text.SimpleDateFormat;
37  import java.util.Date;
38  
39  import org.slf4j.LoggerFactory;
40  import org.slf4j.Logger;
41  
42  
43  /**
44   * @author Sameer Charles $Id: DateSearchQueryParameter.java 41137 2011-01-06 18:19:25Z gjoseph $
45   */
46  public class DateSearchQueryParameter extends SearchQueryParameter {
47      private static final Logger log = LoggerFactory.getLogger(DateSearchQueryParameter.class);
48  
49      /**
50       * sql constraint "TODAY"
51       */
52      public static final String TODAY = "today";
53  
54      /**
55       * sql constraint "AFTER"
56       */
57      public static final String AFTER = "after";
58  
59      /**
60       * sql constraint "BEFORE"
61       */
62      public static final String BEFORE = "before";
63  
64      /**
65       * sql constraint "IS"
66       */
67      public static final String IS = "is";
68  
69      /**
70       * default date format
71       */
72      private SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");
73  
74      /**
75       * @param name of this parameter
76       * @param value
77       * @param constraint check SearchQueryParameter constants
78       */
79      public DateSearchQueryParameter(String name, Date value, String constraint) {
80          super(name, value, constraint);
81      }
82  
83      /**
84       * get value
85       * @return Date
86       */
87      public Date getValue() {
88          return (Date) this.value;
89      }
90  
91      /**
92       * set value
93       * @param value Date
94       */
95      public void setValue(Date value) {
96          this.value = value;
97      }
98  
99      /**
100      * set date format
101      * @param format
102      */
103     public void setDateFormat(SimpleDateFormat format) {
104         this.format = format;
105     }
106 
107     /**
108      * get date format
109      * @return date format, either the one which has been set or default "yyyy-MM-dd"
110      */
111     public SimpleDateFormat getDateFormat() {
112         return this.format;
113     }
114 }