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.ui.apps.lists.daterestrictions;
029
030/**
031 * Date restrictions for a fixed number of time units going backward or forward from the current time.<p>
032 */
033public class CmsListDateFromTodayRestriction implements I_CmsListDateRestriction {
034
035    /** The number of time units. */
036    private int m_count;
037
038    /** The time unit to use. */
039    private TimeUnit m_unit;
040
041    /** The time direction. */
042    private TimeDirection m_direction;
043
044    /**
045     * Creates a new instance.<p>
046     *
047     * @param count the number of time units
048     * @param unit the time unit
049     * @param direction the time direction
050     */
051    public CmsListDateFromTodayRestriction(int count, TimeUnit unit, TimeDirection direction) {
052        m_count = count;
053        m_unit = unit;
054        m_direction = direction;
055    }
056
057    /**
058     * @see org.opencms.ui.apps.lists.daterestrictions.I_CmsListDateRestriction#getRange()
059     */
060    public String getRange() {
061
062        boolean isFuture = m_direction == TimeDirection.future;
063        String sign = isFuture ? "+" : "-";
064        String time = "NOW" + sign + m_unit.formatForRange(m_count);
065        if (isFuture) {
066            return "[NOW TO " + time + "]";
067        } else {
068            return "[" + time + " TO NOW]";
069        }
070    }
071
072}