edu.umn.se.trap.rule.grantrule.SponsoredNoAlcoholRule.java Source code

Introduction

Here is the source code for edu.umn.se.trap.rule.grantrule.SponsoredNoAlcoholRule.java

Source

/*
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 edu.umn.se.trap.rule.grantrule;

import java.util.Iterator;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.commons.lang3.StringUtils;

import edu.umn.se.trap.TrapException;
import edu.umn.se.trap.form.Expense;
import edu.umn.se.trap.form.ExpenseType;
import edu.umn.se.trap.form.FormGrant;
import edu.umn.se.trap.form.GrantSet;
import edu.umn.se.trap.form.TrapForm;

/**
 * @author Mark
 * 
 *         From the TRAP Design Document:
 * 
 *         Requirement: 22
 *         Description: Sponsored grants don't cover alcohol.
 * 
 */
public class SponsoredNoAlcoholRule extends AbstractGrantRule {

    private final String alcoholRegex = "alcohol";

    /*
     * (non-Javadoc)
     * 
     * @see
     * edu.umn.se.trap.rule.grantrule.AbstractGrantRule#removeGrants(edu.umn
     * .se.trap.form.Expense)
     */
    @Override
    protected void removeGrants(Expense expense, TrapForm form) throws TrapException {
        if (expense != null) {
            checkSponsoredAlcohol(expense);

        } else {
            throw new TrapException("Invalid TrapForm object: expense was null.");
        }

    }

    /**
     * @param expense
     * @throws TrapException
     */
    private void checkSponsoredAlcohol(Expense expense) throws TrapException {

        /*
         * Check to make sure the expense is an other expense.
         */
        if (expense.getType().equals(ExpenseType.OTHER)) {
            /*
             * Try to match "alcohol" in the justification field.
             */

            Pattern alcoholPattern = Pattern.compile(alcoholRegex, Pattern.CASE_INSENSITIVE);

            Matcher alcoholMatcher = alcoholPattern.matcher(expense.getJustification());

            // If alcohol is found, check the grants.
            if (alcoholMatcher.find()) {
                GrantSet grantSet = expense.getEligibleGrants();

                if (grantSet == null) {
                    throw new TrapException("Invalid TrapForm object: grantSet was null.");
                }

                Set<FormGrant> grants = grantSet.getGrants();

                if (grants == null) {
                    throw new TrapException("Invalid TrapForm object: grants was null.");
                }

                Iterator<FormGrant> grantIter = grants.iterator();

                while (grantIter.hasNext()) {
                    FormGrant grant = grantIter.next();

                    if (StringUtils.equalsIgnoreCase(grant.getAccountType(), "Sponsored")) {
                        // Remove the grant if it is a sponsored grant trying to
                        // cover alcohol.
                        grantSet.removeGrant(grant.getAccountName());
                    }
                }
            }
        }

    }

}