org.openmrs.logic.result

Class Result

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Result>

org.openmrs.logic.result.Result

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Result>, Collection<Result>, List<Result>, RandomAccess

Direct Known Subclasses:

EmptyResult

public class Result
extends ArrayList<Result>

A result from the logic service. A result can be 0-to-n date-values pairs. You can treat the result as a list or easily coerce it into a simple value as needed.

When possible, results carry references to more complex objects so that code that deals with results and has some prior knowledge of the objects returned by a particular rule can more easily get to the full-featured objects instead of the simplified values in the date-value pairs.

TODO: eliminate unnecessary methods (toDatetime(), getDatetime(), and getDate() should all do the same thing)
TODO: better support/handling of NULL_RESULT

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Result.Datatype Core datatypes for a result.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
Result()
Result(Boolean valueBoolean) Builds a boolean result with a result date of today
Result(Concept valueCoded) Builds a coded result with a result date of today
Result(Date valueDatetime) Builds a datetime result with a result date of today
Result(Date resultDate, Boolean valueBoolean, Object obj) Builds a boolean result with a specific result date
Result(Date resultDate, Concept valueCoded, Object obj) Builds a coded result with a specific result date
Result(Date resultDate, Date valueDatetime, Object obj) Builds a datetime result with a specific result date
Result(Date resultDate, Double valueNumeric, Object obj) Builds a numeric result with a specific result date
Result(Date resultDate, Integer valueNumeric, Object obj) Builds a numeric result with a specific result date
Result(Date resultDate, Result.Datatype datatype, Boolean valueBoolean, Concept valueCoded, Date valueDatetime, Double valueNumeric, String valueText, Object object) Builds a result date with specific (overloaded) values — i.e., instead of simply accepting the default translation of one datatype into another (e.g., a date translated automatically into string format), this contructor allows the various datatype representations of the result to be individually controlled.
Result(Date resultDate, String valueText, Object obj) Builds a text result with a specific result date
Result(Double valueNumeric) Builds a numeric result with a result date of today
Result(Integer valueNumeric) Builds a numeric result with a result date of today
Result(List<Result> list) Builds a result from a list of results
Result(Obs obs) Builds a coded result from an observation
Result(Result result) Builds result upon another result — the first step in create a result that contains a list of other results.
Result(String valueText) Builds a text result with a result date of today

Method Summary

Modifier and Type	Method and Description
boolean	contains(Concept concept)
boolean	contains(Result result)
boolean	containsConcept(Integer conceptId)
Result	earliest()
static Result	emptyResult()
boolean	equals(Object obj)
boolean	exists()
Result	get(int index)
Result.Datatype	getDatatype() Returns the datatype of the result.
Date	getResultDate() Returns the data of the result (not to be confused with a data value).
Object	getResultObject() Get the result object
Result	gt(Integer value)
boolean	isNull()
Result	latest()
static Result	nullResult() Deprecated.
void	setDatatype(Result.Datatype datatype) Changes the default datatype of the result
void	setResultDate(Date resultDatetime) Changes the result date time — not to be confused with a value that is a date.
void	setResultObject(Object object) Set the result object
void	setValueBoolean(Boolean valueBoolean) Overrides the boolean representation of ths result without changing the default datatype
void	setValueCoded(Concept valueCoded) Overrides the coded representation of ths result without changing the default datatype
void	setValueDatetime(Date valueDatetime) Overrides the datetime representation of ths result without changing the default datatype
void	setValueNumeric(Double valueNumeric) Overrides the numeric representation of ths result without changing the default datatype
void	setValueNumeric(Integer valueNumeric) Overrides the numeric representation of ths result without changing the default datatype
void	setValueText(String valueText) Overrides the text representation of ths result without changing the default datatype
Boolean	toBoolean()
Concept	toConcept()
Date	toDatetime()
Double	toNumber()
Object	toObject()
String	toString()
Result	unique()

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

hashCode

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

Result

public Result()

Result

public Result(Result result)

Builds result upon another result — the first step in create a result that contains a list of other results.

Parameters:

result - the result that will be the sole member of the new result

Should:

not fail with null result

Result

public Result(List<Result> list)

Builds a result from a list of results

Parameters:

list - a list of results

Should:

not fail with null list, not fail with empty list

Result

public Result(Boolean valueBoolean)

Builds a boolean result with a result date of today

Parameters:

valueBoolean -

Result

public Result(Date resultDate,
              Boolean valueBoolean,
              Object obj)

Builds a boolean result with a specific result date

Parameters:

resultDate -

valueBoolean -

Result

public Result(Concept valueCoded)

Builds a coded result with a result date of today

Parameters:

valueCoded -

Result

public Result(Date resultDate,
              Concept valueCoded,
              Object obj)

Builds a coded result with a specific result date

Parameters:

resultDate -

valueCoded -

Result

public Result(Obs obs)

Builds a coded result from an observation

Parameters:

obs -

Result

public Result(Date valueDatetime)

Builds a datetime result with a result date of today

Parameters:

valueDatetime -

Result

public Result(Date resultDate,
              Date valueDatetime,
              Object obj)

Builds a datetime result with a specific result date

Parameters:

resultDate -

valueDatetime -

Result

public Result(Double valueNumeric)

Builds a numeric result with a result date of today

Parameters:

valueNumeric -

Result

public Result(Date resultDate,
              Double valueNumeric,
              Object obj)

Builds a numeric result with a specific result date

Parameters:

resultDate -

valueNumeric -

Result

public Result(Integer valueNumeric)

Builds a numeric result with a result date of today

Parameters:

valueNumeric -

Result

public Result(Date resultDate,
              Integer valueNumeric,
              Object obj)

Builds a numeric result with a specific result date

Parameters:

resultDate -

valueNumeric -

Result

public Result(String valueText)

Builds a text result with a result date of today

Parameters:

valueText -

Result

public Result(Date resultDate,
              String valueText,
              Object obj)

Builds a text result with a specific result date

Parameters:

resultDate -

valueText -

Result

public Result(Date resultDate,
              Result.Datatype datatype,
              Boolean valueBoolean,
              Concept valueCoded,
              Date valueDatetime,
              Double valueNumeric,
              String valueText,
              Object object)

Builds a result date with specific (overloaded) values — i.e., instead of simply accepting the default translation of one datatype into another (e.g., a date translated automatically into string format), this contructor allows the various datatype representations of the result to be individually controlled. Any values set to null will yield the natural translation of the default datatype. For example,

 Result result = new Result(new Date(), 2.5);
 assertEqualtes("2.5", result.toString());
 
 Result result = new Result(new Date(),
                            Result.Datatype.NUMERIC,
                            2.5,
                            null,
                            null,
                            "Two and a half",
                            null);
 assertEquals("Two and a half", result.toString());
 

Parameters:

resultDate -

datatype -

valueBoolean -

valueCoded -

valueDatetime -

valueNumeric -

valueText -

object -

Method Detail

nullResult

@Deprecated
public static final Result nullResult()

Deprecated.

emptyResult

public static final Result emptyResult()

Returns:

null/empty result

getDatatype

public Result.Datatype getDatatype()

Returns the datatype of the result. If the result is a list of other results, then the datatype of the first element is returned

Returns:

datatype of the result

setResultDate

public void setResultDate(Date resultDatetime)

Changes the result date time — not to be confused with a value that is a date. The result date time is typically the datetime that the observation was recorded.

Parameters:

resultDatetime -

setDatatype

public void setDatatype(Result.Datatype datatype)

Changes the default datatype of the result

Parameters:

datatype -

setValueBoolean

public void setValueBoolean(Boolean valueBoolean)

Overrides the boolean representation of ths result without changing the default datatype

Parameters:

valueBoolean -

setValueCoded

public void setValueCoded(Concept valueCoded)

Overrides the coded representation of ths result without changing the default datatype

Parameters:

valueCoded -

setValueDatetime

public void setValueDatetime(Date valueDatetime)

Overrides the datetime representation of ths result without changing the default datatype

Parameters:

valueDatetime -

setValueNumeric

public void setValueNumeric(Integer valueNumeric)

Overrides the numeric representation of ths result without changing the default datatype

Parameters:

valueNumeric -

setValueNumeric

public void setValueNumeric(Double valueNumeric)

Overrides the numeric representation of ths result without changing the default datatype

Parameters:

valueNumeric -

setValueText

public void setValueText(String valueText)

Overrides the text representation of ths result without changing the default datatype

Parameters:

valueText -

getResultDate

public Date getResultDate()

Returns the data of the result (not to be confused with a data value). For example, if a result represents an observation like DATE STARTED ON HIV TREATMENT, the result date (returned by this method) would be the date the observation was recorded while the toDatetime() method would be used to get the actual answer (when the patient started their treatment).

Returns:

date of the result (usually the date the result was recorded or observed)

See Also:

toDatetime()

getResultObject

public Object getResultObject()

Get the result object

Returns:

the underlying result object

setResultObject

public void setResultObject(Object object)

Set the result object

Parameters:

object -

toBoolean

public Boolean toBoolean()

Returns:

boolean representation of the result. For non-boolean results, this will either be the overridden boolean value (if specifically defined) or a boolean representation of the default datatype. If the result is a list, then return false only if all members are false

	Datatype	Returns
CODED	false for concept FALSE true for all others
DATETIME	true for any date value false if the date is null
NUMERIC	true for any non-zero number false for zero
TEXT	true for any non-blank value false if blank or null

toConcept

public Concept toConcept()

Returns:

concept for result. For non-concept results, returns the concept value if it was overridden (specifically defined for the result), otherwise returns null. If the result is a list, then the concept for the first member is returned.

toDatetime

public Date toDatetime()

Returns:

the datetime representation of the result value (not to be confused with the result's own datetime). For non-datetime results, this will return the overridden datetime value (if specifically defined) or datetime representation of the default datatype. If the result is a list, then the datetime representation of the first member is returned.

	Datatype	Returns
BOOLEAN	null
CODED	null
NUMERIC	null
TEXT	If the text can be parsed into a date, then that value is returned; otherwise returns null

toNumber

public Double toNumber()

Returns:

numeric representation of the result. For non-numeric results, this will either be the overridden numeric value (if specifically defined) or a numeric representation of the default datatype. If the result is a list, then the value of the first element is returned.

	Datatype	Returns
BOOLEAN	1 for true 0 for false
CODED	zero (0)
DATETIME	Number of milliseconds since Java's epoch
TEXT	numeric value of text if it can be parsed into a number otherwise zero (0)

toString

public String toString()

Overrides:

toString in class AbstractCollection<Result>

Returns:

string representation of the result. For non-text results, this will either be the overridden text value (if specifically defined) or a string representation of the default datatype value. If the result is a list, then the string representation of all members a joined with commas.

toObject

public Object toObject()

Returns:

the object associated with the result (generally, this is used internally or for advanced rule design)

Should:

return resultObject for single results, return all results for result list

isNull

public boolean isNull()

Returns:

true if result is empty

exists

public boolean exists()

Returns:

true if the result has any non-zero, non-empty value

contains

public boolean contains(Concept concept)

gt

public Result gt(Integer value)

Returns:

all results greater than the given value

containsConcept

public boolean containsConcept(Integer conceptId)

Returns:

true if result contains a coded value with the given concept id (if the result is a list, then returns true if any member has a matching coded value)

contains

public boolean contains(Result result)

Returns:

true if the result is equal to the given result or is a list containing a member equal to the given result

unique

public Result unique()

Returns:

a result with all duplicates removed

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<Result>

Specified by:

equals in interface List<Result>

Overrides:

equals in class AbstractList<Result>

See Also:

Object.equals(java.lang.Object)

get

public Result get(int index)

Specified by:

get in interface List<Result>

Overrides:

get in class ArrayList<Result>

Returns:

the index element of a list. If the result is not a list, then this will return the result only if index is equal to zero (0); otherwise, returns an empty result

See Also:

List.get(int)

Should:

get empty result for indexes out of range

earliest

public Result earliest()

Returns:

the chronologically (based on result date) first result

Should:

get the first result given multiple results, get the result given a single result, get an empty result given an empty result, not get the result with null result date given other results, get one result with null result dates for all results

latest

public Result latest()

Returns:

the chronologically (based on result date) last result

Should:

get the most recent result given multiple results, get the result given a single result, get an empty result given an empty result, get the result with null result date