org.kuali.student.enrollment.class2.courseoffering.service.impl.CourseOfferingCodeGeneratorImpl.java Source code

Introduction

Here is the source code for org.kuali.student.enrollment.class2.courseoffering.service.impl.CourseOfferingCodeGeneratorImpl.java

Source

/**
 * Copyright 2012 The Kuali Foundation Licensed under the
 * Educational Community 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.osedu.org/licenses/ECL-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.
 *
 * Created by Daniel on 6/7/12
 */
package org.kuali.student.enrollment.class2.courseoffering.service.impl;

import org.apache.commons.lang.StringUtils;
import org.kuali.student.enrollment.class2.courseoffering.service.CourseOfferingCodeGenerator;
import org.kuali.student.enrollment.courseoffering.dto.CourseOfferingInfo;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Map;

/**
 * This class provides a default implementation of CourseOfferingCodeGenerator
 *
 * @author Kuali Student Team
 */
public class CourseOfferingCodeGeneratorImpl implements CourseOfferingCodeGenerator {

    @Override
    public String generateActivityOfferingCode(Map<String, Object> generationProperties) {

        List<String> existingActivityOfferings = (List<String>) generationProperties
                .get(CourseOfferingCodeGenerator.ACTIVITY_OFFERING_CODE_LIST_KEY);

        // If this is the first code, send back "A"
        if (existingActivityOfferings == null || existingActivityOfferings.isEmpty()) {
            return "A";
        }

        List<String> aoCodes = new ArrayList<String>();
        for (String aoCode : existingActivityOfferings) {
            aoCodes.add(aoCode);
        }

        return calculateNextCode(aoCodes);
    }

    @Override
    public String generateCourseOfferingInternalCode(List<CourseOfferingInfo> existingCourseOfferings) {

        //If this is the first code, send back "A"
        if (existingCourseOfferings == null || existingCourseOfferings.isEmpty()) {
            return "A";
        }

        List<String> internalCodes = new ArrayList<String>();
        for (CourseOfferingInfo coInfo : existingCourseOfferings) {
            if (coInfo.getCourseNumberSuffix() != null) {
                internalCodes.add(coInfo.getCourseNumberSuffix());
            }
        }

        return calculateNextCode(internalCodes);
    }

    public String calculateNextCode(List<String> codes) {
        // Always start with A if it's not there
        if (!codes.contains("A")) {
            return "A";
        }

        // Sort the list so we can fill in gaps
        Collections.sort(codes, new Comparator<String>() {
            @Override
            public int compare(String o1, String o2) {
                if (o1.length() == o2.length()) {
                    return o1.compareTo(o2);
                } else {
                    return o1.length() - o2.length();
                }
            }
        });

        // Fill in the gaps of letters
        for (String s : codes) {
            //For each existing code, find the next valid generated code and see if it exists
            String nextCode = getNextCode(s);
            if (!codes.contains(nextCode)) {
                return nextCode;
            }
        }

        // This should never be reached unless there is an infinite list of strings passed in
        throw new RuntimeException("Error generating codes");
    }

    /**
     * Gets the next letter of the alphabet in caps in the form A,B...Z,AA,AB...AZ,BA,BB..BZ,CA,CB....ZZ,AAA,AAB...
     *
     * Make sure it's public as it's needed for Test class
     *
     * @param source source code string
     * @return next code
     */
    public String getNextCode(String source) {
        if (StringUtils.isEmpty(source)) {
            return "A";
        } else if (StringUtils.endsWithIgnoreCase(source, "Z")) {
            return getNextCode(StringUtils.substringBeforeLast(source, "Z")) + "A";
        } else {
            char lastLetter = source.charAt(source.length() - 1);
            return StringUtils.substringBeforeLast(source, "" + lastLetter) + ++lastLetter;
        }
    }
}