001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.jsp.search.config.parser.simplesearch.daterestrictions;
029
030import java.text.DateFormat;
031import java.text.SimpleDateFormat;
032import java.util.Date;
033import java.util.TimeZone;
034
035/**
036 * Restriction to a date between a fixed start and end date, but only one of them has to be given.<p>
037 */
038public class CmsDateRangeRestriction implements I_CmsDateRestriction {
039
040    /** A constant for the Solr date format. */
041    private static final DateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
042    static {
043        DATE_FORMAT.setTimeZone(TimeZone.getTimeZone("UTC"));
044    }
045
046    /** The start date. */
047    private Date m_from;
048
049    /** The end date. */
050    private Date m_to;
051
052    /**
053     * Creates a new instance.<p>
054     *
055     * @param fromDate the start date
056     * @param toDate the end date
057     */
058    public CmsDateRangeRestriction(Date fromDate, Date toDate) {
059
060        m_from = fromDate;
061        m_to = toDate;
062    }
063
064    /**
065     * @see org.opencms.jsp.search.config.parser.simplesearch.daterestrictions.I_CmsDateRestriction#getRange()
066     */
067    public String getRange() {
068
069        return "[" + formatDate(m_from) + " TO " + formatDate(m_to) + "]";
070    }
071
072    /**
073     * Formats the date for use in Solr range queries.<p>
074     *
075     * If null is passed as the date, "*" will be returned.
076     *
077     * @param date the date to format
078     * @return the formatted date
079     */
080    private String formatDate(Date date) {
081
082        if (date == null) {
083            return "*";
084        }
085        return DATE_FORMAT.format(date);
086    }
087
088}