AbstractRUMHolidayMatch.java

/* ====================================================================
 * Limited Evaluation License:
 *
 * This software is open source, but licensed. The license with this package
 * is an evaluation license, which may not be used for productive systems. If
 * you want a full license, please contact us.
 *
 * The exclusive owner of this work is the OpenRate project.
 * This work, including all associated documents and components
 * is Copyright of the OpenRate project 2006-2015.
 *
 * The following restrictions apply unless they are expressly relaxed in a
 * contractual agreement between the license holder or one of its officially
 * assigned agents and you or your organisation:
 *
 * 1) This work may not be disclosed, either in full or in part, in any form
 *    electronic or physical, to any third party. This includes both in the
 *    form of source code and compiled modules.
 * 2) This work contains trade secrets in the form of architecture, algorithms
 *    methods and technologies. These trade secrets may not be disclosed to
 *    third parties in any form, either directly or in summary or paraphrased
 *    form, nor may these trade secrets be used to construct products of a
 *    similar or competing nature either by you or third parties.
 * 3) This work may not be included in full or in part in any application.
 * 4) You may not remove or alter any proprietary legends or notices contained
 *    in or on this work.
 * 5) This software may not be reverse-engineered or otherwise decompiled, if
 *    you received this work in a compiled form.
 * 6) This work is licensed, not sold. Possession of this software does not
 *    imply or grant any right to you.
 * 7) You agree to disclose any changes to this work to the copyright holder
 *    and that the copyright holder may include any such changes at its own
 *    discretion into the work
 * 8) You agree not to derive other works from the trade secrets in this work,
 *    and that any such derivation may make you liable to pay damages to the
 *    copyright holder
 * 9) You agree to use this software exclusively for evaluation purposes, and
 *    that you shall not use this software to derive commercial profit or
 *    support your business or personal activities.
 *
 * This software is provided "as is" and any expressed or impled warranties,
 * including, but not limited to, the impled warranties of merchantability
 * and fitness for a particular purpose are disclaimed. In no event shall
 * The OpenRate Project or its officially assigned agents be liable to any
 * direct, indirect, incidental, special, exemplary, or consequential damages
 * (including but not limited to, procurement of substitute goods or services;
 * Loss of use, data, or profits; or any business interruption) however caused
 * and on theory of liability, whether in contract, strict liability, or tort
 * (including negligence or otherwise) arising in any way out of the use of
 * this software, even if advised of the possibility of such damage.
 * This software contains portions by The Apache Software Foundation, Robert
 * Half International.
 * ====================================================================
 */
package OpenRate.process;

import OpenRate.record.ChargePacket;
import OpenRate.record.RatingRecord;
import java.util.Calendar;

/**
 * This class performs a look up into the holiday calendar to see if the call
 * was made on a holiday. If so, the defined timeResult is set.
 *
 * @author Afzaal
 */
public abstract class AbstractRUMHolidayMatch
        extends AbstractRegexMatch {

  // this is used to check the dates

  private final String[] searchParameters = new String[3];
  Calendar calendar = Calendar.getInstance();

  /**
   * Check to see if the CDR start date is on a holiday day. If it is, set the
   * timeResult to the given value, and set the timeSplitting flag to NO_CHECK,
   * which means that the RUMTimeMatch module will not perform the normal check.
   *
   * The map group for the time match is read from the timeModel, meaning that
   * different holiday calendars can be mapped to different time models.
   *
   * The timeResult values are written into the charge packets.
   *
   * @param timeResult The result to write if the day is a holiday
   * @param recordToMatch The RatingRecord to work on
   */
  public void performCPHolidayMatch(RatingRecord recordToMatch, String timeResult) {
    int Index;
    ChargePacket tmpCP;

    calendar.setTime(recordToMatch.eventStartDate);
    searchParameters[0] = "" + calendar.get(Calendar.DAY_OF_MONTH);
    searchParameters[1] = "" + (calendar.get(Calendar.MONTH) + 1); // Incrementing by 1 as January = 0
    searchParameters[2] = "" + calendar.get(Calendar.YEAR);

    for (Index = 0; Index < recordToMatch.getChargePacketCount(); Index++) {
      tmpCP = recordToMatch.getChargePacket(Index);

      String RegexResult = getRegexMatch(tmpCP.timeModel, searchParameters);
      if (isValidRegexMatchResult(RegexResult)) {
        // set the flag to skip the time match
        tmpCP.timeSplitting = AbstractRUMTimeMatch.TIME_SPLITTING_HOLIDAY;
      }
    }
  }

  /**
   * Check to see if the CDR start date is on a holiday day. If it is, set the
   * timeResult to the given value, and set the timeSplitting flag to NO_CHECK,
   * which means that the RUMTimeMatch module will not perform the normal check.
   *
   * The map group for the time match is read from the MapGroup parameter,
   * meaning that a single holiday calendar is used for all time models.
   *
   * The timeResult values are written into ALL charge packets.
   *
   * @param recordToMatch The RatingRecord to work on
   * @param mapGroup The mapping group the use for the test
   * @param timeResult The result to write if the day is a holiday
   */
  public void performHolidayMatch(RatingRecord recordToMatch, String mapGroup, String timeResult) {
    int Index;
    ChargePacket tmpCP;

    calendar.setTime(recordToMatch.eventStartDate);
    searchParameters[0] = "" + calendar.get(Calendar.DAY_OF_MONTH);
    searchParameters[1] = "" + (calendar.get(Calendar.MONTH) + 1); // Incrementing by 1 as January = 0
    searchParameters[2] = "" + calendar.get(Calendar.YEAR);

    String RegexResult = getRegexMatch(mapGroup, searchParameters);
    if (isValidRegexMatchResult(RegexResult)) {
      for (Index = 0; Index < recordToMatch.getChargePacketCount(); Index++) {
        tmpCP = recordToMatch.getChargePacket(Index);

        // set the flag to skip the time match
        tmpCP.timeSplitting = AbstractRUMTimeMatch.TIME_SPLITTING_HOLIDAY;
      }
    }
  }
}