GradeMapping (gradebook-service-hibernate 21.5 API)

java.lang.Object
- org.sakaiproject.tool.gradebook.GradeMapping

All Implemented Interfaces:

Serializable, Comparable<Object>

Direct Known Subclasses:

GradePointsMapping, LetterGradeMapping, LetterGradePlusMinusMapping, PassNotPassMapping
```
public class GradeMapping
extends Object
implements Serializable, Comparable<Object>
```
A GradeMapping provides a means to convert between an arbitrary set of grades (letter grades, pass / not pass, 4,0 scale) and numeric percentages.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Gradebook gradebook

protected Map<String,Double> gradeMap

protected Long id

protected int version

Fields
Modifier and Type	Field and Description
`protected Gradebook`	`gradebook`
`protected Map<String,Double>`	`gradeMap`
`protected Long`	`id`
`protected int`	`version`

Constructor Summary

Constructors
Constructor and Description

GradeMapping()

GradeMapping(GradingScale gradingScale)

Constructors
Constructor and Description
`GradeMapping()`
`GradeMapping(GradingScale gradingScale)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`compareTo(Object o)`
`boolean`	`equals(Object o)`
`Map<String,Double>`	`getDefaultBottomPercents()` Backwards-compatible wrapper to get to grading scale.
`List<Double>`	`getDefaultValues()` Deprecated.
`Gradebook`	`getGradebook()`
`Map<String,Double>`	`getGradeMap()`
`Collection<String>`	`getGrades()`
`GradingScale`	`getGradingScale()`
`Long`	`getId()`
`String`	`getMappedGrade(Double value)` Get the mapped grade based on the persistent grade mappings
`static String`	`getMappedGrade(Map<String,Double> gradeMap, Double value)` Get the mapped grade based on the passed in grade mappings.
`String`	`getName()`
`Double`	`getValue(String grade)` Gets the percentage mapped to a particular grade.
`int`	`getVersion()`
`int`	`hashCode()`
`void`	`setDefaultValues()` Sets the percentage values for this GradeMapping to their default values.
`void`	`setGradebook(Gradebook gradebook)`
`void`	`setGradeMap(Map<String,Double> gradeMap)`
`void`	`setGradingScale(GradingScale gradingScale)`
`void`	`setId(Long id)`
`void`	`setVersion(int version)`
`static Map<String,Double>`	`sortGradeMapping(Map<String,Double> gradeMap)` Handles the sorting of the grade mapping.
`String`	`standardizeInputGrade(String inputGrade)` Enable any-case input of grades (typically lowercase input for uppercase grades).
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - id
```
protected Long id
```
  - version
```
protected int version
```
  - gradebook
```
protected Gradebook gradebook
```
  - gradeMap
```
protected Map<String,Double> gradeMap
```
- Constructor Detail
  - GradeMapping
```
public GradeMapping()
```
  - GradeMapping
```
public GradeMapping(GradingScale gradingScale)
```
- Method Detail
  - getName
```
public String getName()
```
  - setDefaultValues
```
public void setDefaultValues()
```
    Sets the percentage values for this GradeMapping to their default values.
  - getDefaultBottomPercents
```
public Map<String,Double> getDefaultBottomPercents()
```
    Backwards-compatible wrapper to get to grading scale.
  - getGrades
```
public Collection<String> getGrades()
```
    Returns:
    
    An (ordered) collection of the available grade values
  - getDefaultValues
```
@Deprecated
public List<Double> getDefaultValues()
```
    Deprecated.
    
    Returns:
    
    A List of the default grade values. Only used for backward compatibility to pre-grading-scale mappings.
  - getValue
```
public Double getValue(String grade)
```
    Gets the percentage mapped to a particular grade.
  - getMappedGrade
```
public String getMappedGrade(Double value)
```
    Get the mapped grade based on the persistent grade mappings
  - getMappedGrade
```
public static String getMappedGrade(Map<String,Double> gradeMap,
                                    Double value)
```
    Get the mapped grade based on the passed in grade mappings. NOTE: The gradeMap MUST be sorted!
  - sortGradeMapping
```
public static Map<String,Double> sortGradeMapping(Map<String,Double> gradeMap)
```
    Handles the sorting of the grade mapping.
    
    Parameters:
    
    gradeMap -
    
    Returns:
  - getId
```
public Long getId()
```
  - setId
```
public void setId(Long id)
```
  - getVersion
```
public int getVersion()
```
  - setVersion
```
public void setVersion(int version)
```
  - getGradeMap
```
public Map<String,Double> getGradeMap()
```
  - setGradeMap
```
public void setGradeMap(Map<String,Double> gradeMap)
```
  - getGradebook
```
public Gradebook getGradebook()
```
  - setGradebook
```
public void setGradebook(Gradebook gradebook)
```
  - compareTo
```
public int compareTo(Object o)
```
    Specified by:
    
    compareTo in interface Comparable<Object>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - standardizeInputGrade
```
public String standardizeInputGrade(String inputGrade)
```
    Enable any-case input of grades (typically lowercase input for uppercase grades). Look for a case-insensitive match to the input text and if it's found, return the official version.
    
    Returns:
    
    The normalized version of the grade, or null if not found.
  - getGradingScale
```
public GradingScale getGradingScale()
```
    Returns:
    
    the GradingScale used to define this mapping, or null if this is an old Gradebook which uses hard-coded scales
  - setGradingScale
```
public void setGradingScale(GradingScale gradingScale)
```

Class GradeMapping

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

version

gradebook

gradeMap

Constructor Detail

GradeMapping

GradeMapping

Method Detail

getName

setDefaultValues

getDefaultBottomPercents

getGrades

getDefaultValues

getValue

getMappedGrade

getMappedGrade

sortGradeMapping

getId

setId

getVersion

setVersion

getGradeMap

setGradeMap

getGradebook

setGradebook

compareTo

equals

hashCode

toString

standardizeInputGrade

getGradingScale

setGradingScale