DefaultItemScoring

java.lang.Object
- com.itemanalysis.psychometrics.measurement.DefaultItemScoring

All Implemented Interfaces:

ItemScoring
```
public class DefaultItemScoring
extends java.lang.Object
implements ItemScoring
```
The default implementation of the ItemScoring interface. It maintains information about the item and scores examinees responses. It also includes special codes for omitted and not reached responses. These types of response codes are either treated as missing data or scored as zero points. Missing data retun a value of Double.NaN.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class DefaultItemScoring.ItemResponseComparator
Sort Strings before Doubles.

Nested Classes
Modifier and Type	Class and Description
`class`	`DefaultItemScoring.ItemResponseComparator` Sort Strings before Doubles.

Field Summary

Fields
Modifier and Type Field and Description

java.util.TreeMap<java.lang.Object,Category> categoryMap

Fields
Modifier and Type	Field and Description
`java.util.TreeMap<java.lang.Object,Category>`	`categoryMap`

Constructor Summary

Constructors
Constructor and Description

DefaultItemScoring()

DefaultItemScoring(boolean isContinuous)

Constructors
Constructor and Description
`DefaultItemScoring()`
`DefaultItemScoring(boolean isContinuous)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ItemType`	`addAllCategories(java.lang.String optionScoreKey, VariableType type)` Parses string from syntax file or database.
`void`	`addCategory(Category cat)`
`void`	`addCategory(java.lang.Object categoryID, double scoreValue)`
`boolean`	`binaryScoring()` Determine whether the item scoring is binary or polytomous.
`java.util.Iterator<java.lang.Object>`	`categoryIterator()` Return category iterator for binary and polytomous items.
`void`	`clearCategory()`
`double`	`computeCategoryScore(java.lang.Object categoryId, java.lang.Object response)` Returns 1 if response == categoryId and 0 otherwise.
`double`	`computeItemScore(java.lang.Object response)` Missing responses, omitted responses, and not reached responses are scored according to the value in the SepcialDataCodes object.
`org.apache.commons.math3.util.Pair[]`	`computeScoreVector(java.lang.Object response)` Creates an array of category keys and their corresponding score for the response.
`java.lang.String`	`getAnswerKey()` This method return the answer key for an item.
`java.lang.String`	`getCategoryScoreString(java.lang.Object response)`
`ItemType`	`getItemType()` An item type is defined by its scoring.
`VariableName`	`getName()`
`boolean`	`isContinuous()`
`void`	`isContinuous(boolean isContinuous)`
`double`	`maximumPossibleScore()`
`double`	`minimumPossibleScore()`
`int`	`numberOfCategories()` Gets the number of response options.
`int`	`numberOfScoreLevels()` Gets the number of score levels.
`java.lang.String`	`printOptionScoreKey()` this method creates a String that represents the item scoring.
`void`	`removeCategory(Category cat)`
`double[]`	`scoreArray()` this method creates a double array of all existing options scores.
`void`	`setSpecialDataCodes(SpecialDataCodes specialDataCodes)`

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

- Field Detail
  - categoryMap
```
public java.util.TreeMap<java.lang.Object,Category> categoryMap
```
- Constructor Detail
  - DefaultItemScoring
```
public DefaultItemScoring()
```
  - DefaultItemScoring
```
public DefaultItemScoring(boolean isContinuous)
```
- Method Detail
  - addCategory
```
public void addCategory(Category cat)
```
  - removeCategory
```
public void removeCategory(Category cat)
```
  - addCategory
```
public void addCategory(java.lang.Object categoryID,
                        double scoreValue)
```
    Specified by:
    
    addCategory in interface ItemScoring
  - clearCategory
```
public void clearCategory()
```
    Specified by:
    
    clearCategory in interface ItemScoring
  - numberOfCategories
```
public int numberOfCategories()
```
    Gets the number of response options.
    
    Specified by:
    
    numberOfCategories in interface ItemScoring
    
    Returns:
    
    number of response options.
  - isContinuous
```
public void isContinuous(boolean isContinuous)
```
    Specified by:
    
    isContinuous in interface ItemScoring
  - isContinuous
```
public boolean isContinuous()
```
  - numberOfScoreLevels
```
public int numberOfScoreLevels()
```
    Gets the number of score levels. For a polytomous item, this number will be the same as the value returned by numberOfCategories() unless the score categories are collapsed. With collapsed score categories, the number of score levels will be less than the number of response options.
    
    Specified by:
    
    numberOfScoreLevels in interface ItemScoring
    
    Returns:
    
    number of score levels.
  - maximumPossibleScore
```
public double maximumPossibleScore()
```
    Specified by:
    
    maximumPossibleScore in interface ItemScoring
  - minimumPossibleScore
```
public double minimumPossibleScore()
```
    Specified by:
    
    minimumPossibleScore in interface ItemScoring
  - categoryIterator
```
public java.util.Iterator<java.lang.Object> categoryIterator()
```
    Return category iterator for binary and polytomous items. No categories exist for continuous items.
    
    Specified by:
    
    categoryIterator in interface ItemScoring
    
    Returns:
  - getCategoryScoreString
```
public java.lang.String getCategoryScoreString(java.lang.Object response)
```
    Specified by:
    
    getCategoryScoreString in interface ItemScoring
  - setSpecialDataCodes
```
public void setSpecialDataCodes(SpecialDataCodes specialDataCodes)
```
  - computeItemScore
```
public double computeItemScore(java.lang.Object response)
```
    Missing responses, omitted responses, and not reached responses are scored according to the value in the SepcialDataCodes object.
    
    Specified by:
    
    computeItemScore in interface ItemScoring
    
    Parameters:
    
    response - an item response that is either a Double or String
    
    Returns:
    
    item score
  - computeScoreVector
```
public org.apache.commons.math3.util.Pair[] computeScoreVector(java.lang.Object response)
```
    Creates an array of category keys and their corresponding score for the response. They are stored in an array of Pairs so that the category ID and score are kept together.
    
    Parameters:
    
    response - an item response
    
    Returns:
    
    pair of category value score pairs
  - computeCategoryScore
```
public double computeCategoryScore(java.lang.Object categoryId,
                                   java.lang.Object response)
```
    Returns 1 if response == categoryId and 0 otherwise.
    
    Specified by:
    
    computeCategoryScore in interface ItemScoring
    
    Parameters:
    
    categoryId - category ID
    
    response - response value
    
    Returns:
    
    category score
  - getAnswerKey
```
public java.lang.String getAnswerKey()
```
    This method return the answer key for an item. the answer key is the category code with the highest score values. For a multiple-choice question it will return the response options with a score of, say, 1 where all other scores are 0. For a polytomous item it will return a plus sign to indicate increasing order and a minus sign to indicate reverse order. jMetrik uses this method to populate a table with the answer key.
    
    Specified by:
    
    getAnswerKey in interface ItemScoring
    
    Returns:
    
    answer key
  - addAllCategories
```
public ItemType addAllCategories(java.lang.String optionScoreKey,
                                 VariableType type)
```
    Parses string from syntax file or database. The original responses should be a comma delimited list enclosed in paretheses, REGEX=\\((.+?(?=,|\\)))\\). The score values should also be a comma delimited list enclosed in paretheses. The score rho list can only contain numbers, REGEX=\\(([[-+]?[0-9]\*\.?[0-9]+(?=,|\\))]+?)\\). Leading and trailing white spaces within each list are NOT permitted. The original responses should be listed first, followed by the score values. Both lists must be enclosed in parentheses. This format allows an item to have one or more correct responses, partial credit assigned to any or all responses, and polytomous item categories to be collapsed. For example, (A,B,C,D) (0,1,0,0) indicates the original responses A, B, C, and D are scored 1, 0, 0, 0 (i.e. A is correct all others are incorrect). As another example (A,B,C,D) (0,1,0,1) indicates that the original values A and D are scored 1 but C and D are scored 0. For polytomous items, (1,2,3,4) (1,2,3,4) indicates that the responses 1, 2, 3, and 4 are scored 1, 2, 3 and 4. A polytomous item category may also be collapsed. For example, (1,2,3,4) (1,2,3,3) indicates that responses or 3 and 4 are scored 3, thereby collapsing the third and fourth categories. INCORRECT: (A, B, C, D)(0, 1, 0, 0) because leading and trailing spaces within the list are not permitted. Original and scored lists will be forced to have equal length by adding spaces or zeros to the end of a list until both lists are of equal length.
    
    Specified by:
    
    addAllCategories in interface ItemScoring
  - binaryScoring
```
public boolean binaryScoring()
```
    Determine whether the item scoring is binary or polytomous.
    
    Returns:
    
    true if binary scoring, false otherwise.
  - getItemType
```
public ItemType getItemType()
```
    An item type is defined by its scoring. A NOT_ITEM has no scoring assigned to the category. A BINARY_ITEM has only two score levels with values 0 and 1. A POLYTOMOUS_ITEM has more than two levels and each level is an integer. A CONTINUOUS_ITEM has more than two levels and each level is a real number. Or, it is an item set as continuous in the constructor or parsing of a score string.
    
    Specified by:
    
    getItemType in interface ItemScoring
    
    Returns:
    
    type of item
  - printOptionScoreKey
```
public java.lang.String printOptionScoreKey()
```
    this method creates a String that represents the item scoring. It is referred to as the score string.
    
    Specified by:
    
    printOptionScoreKey in interface ItemScoring
    
    Returns:
    
    string representation of option score key
  - scoreArray
```
public double[] scoreArray()
```
    this method creates a double array of all existing options scores. The options themselves are not returned. Only the scores are returned.
    
    Specified by:
    
    scoreArray in interface ItemScoring
    
    Returns:
    
    array of options scores.
  - getName
```
public VariableName getName()
```
    Specified by:
    
    getName in interface ItemScoring

Class DefaultItemScoring

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

categoryMap

Constructor Detail

DefaultItemScoring

DefaultItemScoring

Method Detail

addCategory

removeCategory

addCategory

clearCategory

numberOfCategories

isContinuous

isContinuous

numberOfScoreLevels

maximumPossibleScore

minimumPossibleScore

categoryIterator

getCategoryScoreString

setSpecialDataCodes

computeItemScore

computeScoreVector

computeCategoryScore

getAnswerKey

addAllCategories

binaryScoring

getItemType

printOptionScoreKey

scoreArray

getName