org.phenotips.data

Class PatientSpecificity

java.lang.Object

org.phenotips.data.PatientSpecificity

public class PatientSpecificity
extends Object

Patient specificity, a score estimating how "good" a patient record is, along with metadata about the score computation.

Since:

1.0M12

Version:

$Id: d6f2861e29ccfd8a996059b0f40e965c4959b97c $

Constructor Summary

Constructors

Constructor and Description
PatientSpecificity(double score, Date computationDate, String computingMethod) Default constructor passing all the required information.

Method Summary

Methods

Modifier and Type	Method and Description
Date	getComputationDate() The date when this score was computed.
String	getComputingMethod() The method used for computing this score.
double	getScore() The score assigned to this patient record, where 0 means the record isn't informative at all, and 1 means that this is a perfect patient description.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PatientSpecificity

public PatientSpecificity(double score,
                  Date computationDate,
                  String computingMethod)

Default constructor passing all the required information.

Parameters:

score - the profile score, must be a number between 0 and 1 (inclusive)

computationDate - the date when the score was computed

computingMethod - the method used for computing the score

Method Detail

getScore

public double getScore()

The score assigned to this patient record, where 0 means the record isn't informative at all, and 1 means that this is a perfect patient description.

Returns:

a number between 0.0 and 1.0 (inclusive), or -1 if a score couldn't be computed

getComputationDate

public Date getComputationDate()

The date when this score was computed.

Returns:

a date object

getComputingMethod

public String getComputingMethod()

The method used for computing this score.

Returns:

a method identifier, e.g. monarchinitiative.org or local-omim