/*==========================================================================*\
 |  $Id: ScoreSummaryBlock.java,v 1.5 2011/12/06 18:38:25 stedwar2 Exp $
 |*-------------------------------------------------------------------------*|
 |  Copyright (C) 2006-2010 Virginia Tech
 |
 |  This file is part of Web-CAT.
 |
 |  Web-CAT is free software; you can redistribute it and/or modify
 |  it under the terms of the GNU Affero General Public License as published
 |  by the Free Software Foundation; either version 3 of the License, or
 |  (at your option) any later version.
 |
 |  Web-CAT is distributed in the hope that it will be useful,
 |  but WITHOUT ANY WARRANTY; without even the implied warranty of
 |  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 |  GNU General Public License for more details.
 |
 |  You should have received a copy of the GNU Affero General Public License
 |  along with Web-CAT; if not, see <http://www.gnu.org/licenses/>.
\*==========================================================================*/

package org.webcat.grader;

import com.webobjects.appserver.*;
import org.apache.log4j.Logger;
import org.webcat.core.*;

// -------------------------------------------------------------------------
/**
 *  Renders a descriptive table containing a submission result's basic
 *  identifying information.  An optional submission file stats object,
 *  if present, will be used to present file-specific data.
 *
 *  @author  Stephen Edwards
 *  @author  Latest changes by: $Author: stedwar2 $
 *  @version $Revision: 1.5 $, $Date: 2011/12/06 18:38:25 $
 */
public class ScoreSummaryBlock
    extends GraderComponent
{
    //~ Constructors ..........................................................

    // ----------------------------------------------------------
    /**
     * Default constructor.
     * @param context The page's context
     */
    public ScoreSummaryBlock( WOContext context )
    {
        super( context );
    }


    //~ KVC Attributes (must be public) .......................................

    public boolean          allowScoreEdit   = false;
    public Submission       submission;
    public SubmissionResult result;
    public int              rowNumber;


    //~ Methods ...............................................................

    // ----------------------------------------------------------
    protected void beforeAppendToResponse(
        WOResponse response, WOContext context)
    {
        rowNumber = 0;
        if (submission != null)
        {
            result = submission.result();
            super.beforeAppendToResponse( response, context );
        }
    }


    // ----------------------------------------------------------
    public boolean hasTAGrade()
    {
        return submission.assignmentOffering().assignment()
            .submissionProfile().taPoints() > 0.0
            || (result != null
                && result.taScoreRaw() != null
                && result.taScore() > 0.0)
            || allowScoreEdit;
    }


    // ----------------------------------------------------------
    public Object taScore()
    {
        return ( result.status() == Status.CHECK )
            ? result.taScoreRaw()
            : null;
    }


    // ----------------------------------------------------------
    public String taMeter()
    {
        Number taPossibleNum = submission.assignmentOffering()
            .assignment().submissionProfile().taPointsRaw();
        double taPossible = ( taPossibleNum == null )
            ? 1.0 : taPossibleNum.doubleValue();
        Number taPtsNum = result.taScoreRaw();
        if ( taPtsNum == null ||
             ( !allowScoreEdit && result.status() != Status.CHECK ) )
        {
            return "<Awaiting Staff>";
        }
        double taPts = taPtsNum.doubleValue();
        return FinalReportPage.meter( taPts / taPossible );
    }


    // ----------------------------------------------------------
    public String toolMeter()
    {
        Number toolPossibleNum = submission.assignmentOffering()
            .assignment().submissionProfile().toolPointsRaw();
        double toolPossible = ( toolPossibleNum == null )
            ? 1.0 : toolPossibleNum.doubleValue();
        double toolPts = result.toolScore();
        return FinalReportPage.meter( toolPts / toolPossible );
    }


    // ----------------------------------------------------------
    public String correctnessMeter()
    {
        double possible = submission.assignmentOffering()
            .assignment().submissionProfile().correctnessPoints();
        double pts = result.correctnessScore();
        return FinalReportPage.meter( pts / possible );
    }


    // ----------------------------------------------------------
    public String finalMeter()
    {
        double possible = submission.assignmentOffering()
            .assignment().submissionProfile().availablePoints();
        double pts = result.finalScoreVisibleTo(user());
        return FinalReportPage.meter( pts / possible );
    }


    //~ Instance/static variables .............................................

    static Logger log = Logger.getLogger( ScoreSummaryBlock.class );
}