org.wso2.carbon.analytics.apim.spark.udf.APIManagerAnalyticsUDF.java Source code

Java tutorial

Introduction

Here is the source code for org.wso2.carbon.analytics.apim.spark.udf.APIManagerAnalyticsUDF.java

Source

/*
 * Copyright (c) 2016, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 * WSO2 Inc. 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.wso2.carbon.analytics.apim.spark.udf;

import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import java.util.TimeZone;

import org.wso2.carbon.analytics.spark.core.udf.CarbonUDF;
import org.apache.commons.math3.distribution.NormalDistribution;

public class APIManagerAnalyticsUDF implements CarbonUDF {

    /**
     * @param numOfDays
     * @return
     * @throws APIManagerAnalyticsUDFException
     */
    public Long offsetInDays(Integer numOfDays) throws APIManagerAnalyticsUDFException {
        if (numOfDays == null) {
            throw new APIManagerAnalyticsUDFException("Offset days can't be null");
        }

        Calendar calender = Calendar.getInstance();
        calender.add(Calendar.DAY_OF_MONTH, numOfDays);
        return calender.getTimeInMillis();
    }

    /**
     * This method convert a given timeStamp to the respective Date and returns it as a String
     *
     * @param timeStamp
     * @return Date in MM/dd//yyyy format as a String
     * @throws APIManagerAnalyticsUDFException
     */
    public String convertToDate(Long timeStamp) throws APIManagerAnalyticsUDFException {
        if (timeStamp == null) {
            throw new APIManagerAnalyticsUDFException("timeStamp can't be null");
        }
        Calendar calender = Calendar.getInstance();
        calender.setTimeInMillis(timeStamp);

        DateFormat df = new SimpleDateFormat("dd/MM/yyyy");
        String reportDate = df.format(calender.getTime());
        return reportDate;
    }

    /**
     * @param dateString
     * @return
     * @throws APIManagerAnalyticsUDFException
     */
    public Long convertToTimestamp(String dateString) throws APIManagerAnalyticsUDFException {
        if (dateString == null) {
            throw new APIManagerAnalyticsUDFException("dateString can't be null");
        }

        DateFormat format = new SimpleDateFormat("dd/MM/yyyy");
        format.setTimeZone(TimeZone.getTimeZone("UTC"));
        Date date = null;
        try {
            date = format.parse(dateString);
        } catch (ParseException e) {
            throw new APIManagerAnalyticsUDFException("An error occurred while parsing string: " + dateString);
        }
        return date.getTime();
    }

    /**
     * This method calculates given percentile using mean and standard deviation
     *
     * @param mean
     * @param stdDeviation
     * @param percentile
     * @return
     * @throws APIManagerAnalyticsUDFException
     */
    public Double getpercentileValue(Double mean, Double stdDeviation, Double percentile)
            throws APIManagerAnalyticsUDFException {
        if (mean == null || stdDeviation == null || percentile == null) {
            throw new APIManagerAnalyticsUDFException("One or more arguments provided for the method is/are null");
        }

        if (percentile < 0 || percentile > 1) {
            throw new APIManagerAnalyticsUDFException("percentile should in 0 < percentile < 1 range");
        }
        double zValue = new NormalDistribution().inverseCumulativeProbability(percentile);
        return mean + zValue * stdDeviation;
    }

    /**
     * This method converts given year and month to timestamp
     *
     * @param year
     * @param month
     * @return
     */
    public String getMonthStartingTime(Integer year, Integer month) {
        Calendar calender = Calendar.getInstance();
        synchronized (calender) {
            calender.set(Calendar.YEAR, year);
            calender.set(Calendar.MONTH, month - 1);
            calender.set(Calendar.DAY_OF_MONTH, 1);
            calender.set(Calendar.HOUR_OF_DAY, 0);
            calender.set(Calendar.MINUTE, 0);
            calender.set(Calendar.SECOND, 0);
            calender.set(Calendar.MILLISECOND, 0);
            return String.valueOf(calender.getTimeInMillis());
        }
    }

    /**
     * This method converts given year, month and date to timestamp
     *
     * @param year
     * @param month
     * @param date
     * @return
     */
    public String getDateStartingTime(Integer year, Integer month, Integer date) {
        Calendar calender = Calendar.getInstance();
        synchronized (calender) {
            calender.set(Calendar.YEAR, year);
            calender.set(Calendar.MONTH, month - 1);
            calender.set(Calendar.DAY_OF_MONTH, date);
            calender.set(Calendar.HOUR_OF_DAY, 0);
            calender.set(Calendar.MINUTE, 0);
            calender.set(Calendar.SECOND, 0);
            calender.set(Calendar.MILLISECOND, 0);
            return String.valueOf(calender.getTimeInMillis());
        }
    }

    /**
     * This method converts given year, month, date and hour to timestamp
     *
     * @param year
     * @param month
     * @param date
     * @param hour
     * @return
     */
    public String getHourStartingTime(Integer year, Integer month, Integer date, Integer hour) {
        Calendar calender = Calendar.getInstance();
        synchronized (calender) {
            calender.set(Calendar.YEAR, year);
            calender.set(Calendar.MONTH, month - 1);
            calender.set(Calendar.DAY_OF_MONTH, date);
            calender.set(Calendar.HOUR_OF_DAY, hour);
            calender.set(Calendar.MINUTE, 0);
            calender.set(Calendar.SECOND, 0);
            calender.set(Calendar.MILLISECOND, 0);
            return String.valueOf(calender.getTimeInMillis());
        }
    }

    /**
     * This method converts given year, month, date, hour and minute to timestamp
     *
     * @param year
     * @param month
     * @param date
     * @param hour
     * @param minute
     * @return
     */
    public String getMinuteStartingTime(Integer year, Integer month, Integer date, Integer hour, Integer minute) {
        Calendar calender = Calendar.getInstance();
        synchronized (calender) {
            calender.set(Calendar.YEAR, year);
            calender.set(Calendar.MONTH, month - 1);
            calender.set(Calendar.DAY_OF_MONTH, date);
            calender.set(Calendar.HOUR_OF_DAY, hour);
            calender.set(Calendar.MINUTE, minute);
            calender.set(Calendar.SECOND, 0);
            calender.set(Calendar.MILLISECOND, 0);
            return String.valueOf(calender.getTimeInMillis());
        }
    }

    /**
     * This method converts given year, month, date, hour, minute and second to timestamp
     *
     * @param year
     * @param month
     * @param date
     * @param hour
     * @param minute
     * @param second
     * @return
     */
    public String getSecondStartingTime(Integer year, Integer month, Integer date, Integer hour, Integer minute,
            Integer second) {
        Calendar calender = Calendar.getInstance();
        synchronized (calender) {
            calender.set(Calendar.YEAR, year);
            calender.set(Calendar.MONTH, month - 1);
            calender.set(Calendar.DAY_OF_MONTH, date);
            calender.set(Calendar.HOUR_OF_DAY, hour);
            calender.set(Calendar.MINUTE, minute);
            calender.set(Calendar.SECOND, second);
            calender.set(Calendar.MILLISECOND, 0);
            return String.valueOf(calender.getTimeInMillis());
        }
    }
}