SampleAggregationMode.java

/*******************************************************************************
 * Copyright 2006 - 2012 Vienna University of Technology,  
 * Department of Software Technology and Interactive Systems, IFS
 * 
 * Licensed 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.
 * 
 * This work originates from the Planets project, co-funded by the European Union under the Sixth Framework Programme.
 ******************************************************************************/
package eu.scape_project.planning.model;

/**
 * Differentiates two aggregation modes:
 * <ul>
 * <li>WORST which is the minimum value over the sample records' results</li>
 * <li>AVERAGE meaning the average over the sample records' results</li>
 * </ul>
 *
 * @author Hannes Kulovits
 */
public enum SampleAggregationMode {

    /**
     * good for boolean, probably also for ordinal values
     */
    WORST ("Worst result"),

    /**
     * good for numeric values
     */
    AVERAGE ("Arithmetic mean");

    public SampleAggregationMode[] getEnumValues() {
        return SampleAggregationMode.values();
    }

    private String niceName;

    private SampleAggregationMode(String niceName) {
        this.niceName = niceName;
    }

    public String toString() {
        return this.niceName;
    }

    /**
     * @return string value of WORST or AVERAGE.
     */
    public String getName() {
        return this.toString();
    }
}