Android Open Source - GradeCalculator-Android Percentage Grade Component

• Back to Calculator/grade  ↑

From Project

Back to project page GradeCalculator-Android.

License

The source code is released under:

Copyright (C) 2012 Jimmy Theis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in ...

Java Source Code

/*
 * Copyright (C) 2012 Jimmy Theis. Licensed under the MIT License:
 * /*from  w ww . ja  v a 2 s  .  c om*/
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.jetheis.android.grades.model;

import com.jetheis.android.grades.storage.GradeComponentStorageAdapter;

/**
 * A grade component that is scored based on a percentage of points earned. Its
 * weight relative to the rest of the course is based on a specific percentage
 * weight.
 * 
 */
public class PercentageGradeComponent extends GradeComponent implements
        Comparable<PercentageGradeComponent> {

    private double mEarnedPercentage;
    private double mWeight;

    /**
     * Get a {@link PercentageGradeComponent} by its unique identifier.
     * 
     * @param id
     *            The unique identifier of the {@link PercentageGradeComponent}.
     * @return The retrieved {@link PercentageGradeComponent}, or null if one is
     *         not found.
     */
    public static PercentageGradeComponent getPercentageGradeComponentById(long id) {
        return new GradeComponentStorageAdapter().getPercentageGradeComponentById(id);
    }

    /**
     * Get the percentage of points earned for this grade component. Any actual
     * point totals are not reflected here; rather, the value tracked is simply
     * the ratio of points earned to total points.
     * 
     * @return The percentage of points earned for this grade component,
     *         represented as a double less than or equal to {@code 1.0}.
     */
    public double getEarnedPercentage() {
        return mEarnedPercentage;
    }

    /**
     * Set the percentage of points earned for this grade component.Any actual
     * point totals are not reflected here; rather, the value tracked is simply
     * the ratio of points earned to total points.
     * 
     * @param earnedPercentage
     *            The percentage of points earned for this grade component,
     *            represented as a double less than or equal to 1.0f.
     */
    public void setEarnedPercentage(double earnedPercentage) {
        mEarnedPercentage = earnedPercentage;
    }

    /**
     * Get the percentage weighting for this grade component. This value
     * specifically represents the ratio of potential points in this grade
     * component to total points available across the entire course.
     * 
     * @return The percentage weighting of this grade component relative to the
     *         rest of the course, represented as a double less than or equal to
     *         {@code 1.0}.
     */
    public double getWeight() {
        return mWeight;
    }

    /**
     * Set the percentage weighting for this grade component. This value
     * specifically represents the ratio of potential points in this grade
     * component to total points available across the entire course.
     * 
     * @param weight
     *            The percentage weighting of this grade component relative to
     *            the rest of the course, represented as a double less than or
     *            equal to {@code 1.0}.
     */
    public void setWeight(double weight) {
        mWeight = weight;
    }

    @Override
    public void save() {
        new GradeComponentStorageAdapter().savePercentageGradeComponent(this);
    }

    @Override
    public String toString() {
        return String.format("PercentageGradeComponent %s: %.2f%% * %.2f%%", getName(),
                getEarnedPercentage() * 100, getWeight() * 100);
    }

    @Override
    public boolean equals(Object o) {
        if (!(o instanceof PercentageGradeComponent)) {
            return false;
        }

        return compareTo((PercentageGradeComponent) o) == 0;
    }

    @Override
    public int compareTo(PercentageGradeComponent other) {
        if (getId() > 0 && other.getId() > 0) {
            return (int) Math.signum(getId() - other.getId());
        }

        // TODO: Compare courses

        if (!getName().equals(other.getName())) {
            return getName().compareTo(other.getName());
        }

        long weight = Math.round(getWeight() * 100000);
        long otherWeight = Math.round(other.getWeight() * 100000);

        if (weight != otherWeight) {
            return (int) Math.signum(weight - otherWeight);
        }

        long earnedPercentage = Math.round(getEarnedPercentage() * 100000);
        long otherEarnedPercentage = Math.round(other.getEarnedPercentage() * 100000);

        return (int) Math.signum(earnedPercentage - otherEarnedPercentage);
    }

}

Java Source Code List

• Back to Calculator/grade  ↑