FreqType.java

/**
 * 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.
 */

package org.apache.falcon.regression.core.enumsAndConstants;

import org.apache.commons.lang.StringUtils;
import org.apache.falcon.entity.v0.Frequency;
import org.joda.time.DateTime;
import org.joda.time.format.DateTimeFormat;
import org.joda.time.format.DateTimeFormatter;

/**
 * Enum to represent different feed periodicity.
 */
public enum FreqType {
    MINUTELY("minutely", "yyyy/MM/dd/HH/mm", "${YEAR}/${MONTH}/${DAY}/${HOUR}/${MINUTE}",
            "year=${YEAR};month=${MONTH};day=${DAY};hour=${HOUR};minute=${MINUTE}") {
        public DateTime addTime(DateTime dateTime, int amount) {
            return dateTime.plusMinutes(amount);
        }

        @Override
        public Frequency.TimeUnit getFalconTimeUnit() {
            return Frequency.TimeUnit.minutes;
        }
    },
    HOURLY("hourly", "yyyy/MM/dd/HH", "${YEAR}/${MONTH}/${DAY}/${HOUR}",
            "year=${YEAR};month=${MONTH};day=${DAY};hour=${HOUR}") {
        @Override
        public DateTime addTime(DateTime dateTime, int amount) {
            return dateTime.plusHours(amount);
        }

        @Override
        public Frequency.TimeUnit getFalconTimeUnit() {
            return Frequency.TimeUnit.hours;
        }
    },
    DAILY("daily", "yyyy/MM/dd", "${YEAR}/${MONTH}/${DAY}",
            "year=${YEAR};month=${MONTH};day=${DAY}") {
        @Override
        public DateTime addTime(DateTime dateTime, int amount) {
            return dateTime.plusDays(amount);
        }

        @Override
        public Frequency.TimeUnit getFalconTimeUnit() {
            return Frequency.TimeUnit.days;
        }
    },
    MONTHLY("monthly", "yyyy/MM", "${YEAR}/${MONTH}",
            "year=${YEAR};month=${MONTH}") {
        @Override
        public DateTime addTime(DateTime dateTime, int amount) {
            return dateTime.plusMonths(amount);
        }

        @Override
        public Frequency.TimeUnit getFalconTimeUnit() {
            return Frequency.TimeUnit.months;
        }
    },
    YEARLY("yearly", "yyyy", "${YEAR}",
            "year=${YEAR}") {
        @Override
        public DateTime addTime(DateTime dateTime, int amount) {
            return dateTime.plusYears(amount);
        }

        @Override
        public Frequency.TimeUnit getFalconTimeUnit() {
            throw new UnsupportedOperationException();
        }
    };

    private final String value;
    private final String pathValue;
    private final String hcatPathValue;
    private final DateTimeFormatter formatter;

    private FreqType(String value, String format, String pathValue, String hcatPathValue) {
        this.value = value;
        formatter = DateTimeFormat.forPattern(format);
        this.pathValue = pathValue;
        this.hcatPathValue = hcatPathValue;
    }

    public String getValue() {
        return value;
    }

    public String getPathValue() {
        return pathValue;
    }

    public String getHcatPathValue() {
        return hcatPathValue;
    }

    public DateTimeFormatter getFormatter() {
        return formatter;
    }

    public int getDirDepth() {
        return StringUtils.countMatches(pathValue, "/");
    }

    public abstract DateTime addTime(DateTime dateTime, int amount);

    public abstract Frequency.TimeUnit getFalconTimeUnit();
}