PatientSearch (OpenMRS 1.8.5-SNAPSHOT API)

java.lang.Object
- org.openmrs.reporting.PatientSearch

All Implemented Interfaces:

Serializable, CohortDefinition, Parameterizable

Deprecated.
see reportingcompatibility module
```
@Deprecated
public class PatientSearch
extends Object
implements CohortDefinition
```
This class represents a search for a set of patients, as entered from a user interface. There are different types of searches:
- a composition, e.g. "1 and (2 or 3)"
- a reference to a saved filter, expressed as the database integer pk.
- a reference to a saved cohort, expressed as the database integer pk.
- a regular search, which describes a PatientFilter subclass and a list of bean-style properties to set.
Composition filters:
When isComposition() returns true, then this represents something like "1 and (2 or 3)", which must be evaluated in the context of a search history.
Saved filters:
When isSavedFilterReference() returns true, then this represents something like "saved filter #8"
When isSavedCohortReference() returns true, then this represents something like "saved cohort #3"
Regular filters:
Otherwise this search describes a PatientFilter subclass and a list of bean-style properties to set, so that it can be turned into a PatientFilter with the utility method OpenmrsUtil.toPatientFilter(PatientSearch). But it can also be left as-is for better version-compatibility if PatientFilter classes change, or to avoid issues with xml-encoding hibernate proxies.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected static org.apache.commons.logging.Log log
Deprecated.

Fields
Modifier and Type	Field and Description
`protected static org.apache.commons.logging.Log`	`log` Deprecated.

Constructor Summary

Constructors
Constructor and Description

PatientSearch()
Deprecated.

Constructors
Constructor and Description
`PatientSearch()` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addArgument(SearchArgument sa)` Deprecated.
`void`	`addArgument(String name, String value, Class clz)` Deprecated.
`void`	`addParameter(Parameter parameter)` Deprecated. Adds a SearchArgument as a Parameter where the SearchArgument name is set to the Parameter label and SearchArgument value is set to the Parameter name and SearchArgument propertyClass is set to the Parameter clazz
`CohortHistoryCompositionFilter`	`cloneCompositionAsFilter(CohortSearchHistory history)` Deprecated. Deep-copies this.parsedComposition, and converts to filters, in the context of history
`CohortHistoryCompositionFilter`	`cloneCompositionAsFilter(CohortSearchHistory history, EvaluationContext evalContext)` Deprecated. Deep-copies this.parsedComposition, and converts to filters, in the context of history
`PatientSearch`	`copyAndDetachFromHistory(CohortSearchHistory history)` Deprecated. Creates a copy of this PatientSearch that doesn't depend on history, replacing references with actual PatientSearch elements from the provided history.
`static PatientSearch`	`createCompositionSearch(List<Object> tokens)` Deprecated.
`static PatientSearch`	`createCompositionSearch(Object[] tokens)` Deprecated.
`static PatientSearch`	`createCompositionSearch(String description)` Deprecated.
`static PatientSearch`	`createFilterSearch(Class filterClass)` Deprecated.
`static PatientSearch`	`createSavedCohortReference(int id)` Deprecated.
`static PatientSearch`	`createSavedFilterReference(int id)` Deprecated.
`static PatientSearch`	`createSavedSearchReference(int id)` Deprecated.
`List<SearchArgument>`	`getArguments()` Deprecated.
`String`	`getArgumentValue(String name)` Deprecated. Looks up an argument value, accounting for parameterValues
`String`	`getCompositionString()` Deprecated.
`Class`	`getFilterClass()` Deprecated.
`List<Parameter>`	`getParameters()` Deprecated. Returns all SearchArgument values that match `EvaluationContext.parameterValues`
`List<Object>`	`getParsedComposition()` Deprecated.
`Integer`	`getSavedCohortId()` Deprecated.
`Integer`	`getSavedFilterId()` Deprecated.
`Integer`	`getSavedSearchId()` Deprecated.
`String`	`getSpecificationString()` Deprecated.
`boolean`	`isComposition()` Deprecated.
`boolean`	`isSavedCohortReference()` Deprecated.
`boolean`	`isSavedFilterReference()` Deprecated.
`boolean`	`isSavedReference()` Deprecated.
`boolean`	`isSavedSearchReference()` Deprecated.
`boolean`	`removeFromHistoryNotify(int i)` Deprecated. Call this to notify this composition search that the _i_th element of the search history has been removed, and the search potentially needs to renumber its constituent parts.
`boolean`	`requiresHistory()` Deprecated.
`void`	`setArguments(List<SearchArgument> arguments)` Deprecated.
`void`	`setFilterClass(Class clazz)` Deprecated.
`void`	`setParameterValue(String name, String value)` Deprecated.
`void`	`setParsedComposition(List<Object> parsedComposition)` Deprecated. Elements in this list can be: an Integer, indicating a 1-based index into a search history a BooleanOperator (AND, OR, NOT) a PatientFilter a PatientSearch another List of the same form, which indicates a parenthetical expression
`void`	`setSavedCohortId(Integer savedCohortId)` Deprecated.
`void`	`setSavedFilterId(Integer savedFilterId)` Deprecated.
`void`	`setSavedSearchId(Integer savedSearchId)` Deprecated.
`void`	`setSpecificationString(String specification)` Deprecated. Convenience method so that a PatientSearch object can be created from a string of compositions
`String`	`toString()` Deprecated.

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

- Field Detail
  - log
```
protected static final org.apache.commons.logging.Log log
```
    Deprecated.
- Constructor Detail
  - PatientSearch
```
public PatientSearch()
```
    Deprecated.
- Method Detail
  - createSavedSearchReference
```
public static PatientSearch createSavedSearchReference(int id)
```
    Deprecated.
  - createSavedFilterReference
```
public static PatientSearch createSavedFilterReference(int id)
```
    Deprecated.
  - createSavedCohortReference
```
public static PatientSearch createSavedCohortReference(int id)
```
    Deprecated.
  - createCompositionSearch
```
public static PatientSearch createCompositionSearch(String description)
```
    Deprecated.
  - createCompositionSearch
```
public static PatientSearch createCompositionSearch(Object[] tokens)
```
    Deprecated.
  - createCompositionSearch
```
public static PatientSearch createCompositionSearch(List<Object> tokens)
```
    Deprecated.
  - createFilterSearch
```
public static PatientSearch createFilterSearch(Class filterClass)
```
    Deprecated.
  - toString
```
public String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class Object
  - isComposition
```
public boolean isComposition()
```
    Deprecated.
  - getCompositionString
```
public String getCompositionString()
```
    Deprecated.
  - setSpecificationString
```
public void setSpecificationString(String specification)
```
    Deprecated.
    
    Convenience method so that a PatientSearch object can be created from a string of compositions
    
    Parameters:
    
    specification -
  - getSpecificationString
```
public String getSpecificationString()
```
    Deprecated.
  - requiresHistory
```
public boolean requiresHistory()
```
    Deprecated.
    
    Returns:
    
    Whether this search requires a history against which to evaluate it
  - copyAndDetachFromHistory
```
public PatientSearch copyAndDetachFromHistory(CohortSearchHistory history)
```
    Deprecated.
    
    Creates a copy of this PatientSearch that doesn't depend on history, replacing references with actual PatientSearch elements from the provided history. The PatientSearch object returned is only a copy when necessary to detach it from history. This method does NOT do a clone.
  - cloneCompositionAsFilter
```
public CohortHistoryCompositionFilter cloneCompositionAsFilter(CohortSearchHistory history)
```
    Deprecated.
    
    Deep-copies this.parsedComposition, and converts to filters, in the context of history
  - cloneCompositionAsFilter
```
public CohortHistoryCompositionFilter cloneCompositionAsFilter(CohortSearchHistory history,
                                                               EvaluationContext evalContext)
```
    Deprecated.
    
    Deep-copies this.parsedComposition, and converts to filters, in the context of history
  - isSavedReference
```
public boolean isSavedReference()
```
    Deprecated.
  - isSavedSearchReference
```
public boolean isSavedSearchReference()
```
    Deprecated.
  - isSavedFilterReference
```
public boolean isSavedFilterReference()
```
    Deprecated.
  - isSavedCohortReference
```
public boolean isSavedCohortReference()
```
    Deprecated.
  - removeFromHistoryNotify
```
public boolean removeFromHistoryNotify(int i)
```
    Deprecated.
    
    Call this to notify this composition search that the _i_th element of the search history has been removed, and the search potentially needs to renumber its constituent parts. Examples, assuming this search is "1 and (4 or 5)": * removeFromHistoryNotify(1) -> This search becomes "1 and (3 or 4)" and the method return false * removeFromHistoryNotify(3) -> This search becomes invalid, and the method returns true * removeFromHistoryNotify(9) -> This search is unaffected, and the method returns false
    
    Returns:
    
    whether or not this search itself should be removed (because it directly references the removed history element
  - getArgumentValue
```
public String getArgumentValue(String name)
```
    Deprecated.
    
    Looks up an argument value, accounting for parameterValues
    
    Parameters:
    
    name -
    
    Returns:
    
    the String value for the specified argument
  - getArguments
```
public List<SearchArgument> getArguments()
```
    Deprecated.
  - setArguments
```
public void setArguments(List<SearchArgument> arguments)
```
    Deprecated.
  - getParameters
```
public List<Parameter> getParameters()
```
    Deprecated.
    
    Returns all SearchArgument values that match EvaluationContext.parameterValues
    
    Specified by:
    
    getParameters in interface Parameterizable
    
    Returns:
    
    List<Parameter> of all parameters in the arguments
  - getFilterClass
```
public Class getFilterClass()
```
    Deprecated.
  - setFilterClass
```
public void setFilterClass(Class clazz)
```
    Deprecated.
  - addArgument
```
public void addArgument(String name,
                        String value,
                        Class clz)
```
    Deprecated.
  - addArgument
```
public void addArgument(SearchArgument sa)
```
    Deprecated.
  - addParameter
```
public void addParameter(Parameter parameter)
```
    Deprecated.
    
    Adds a SearchArgument as a Parameter where the SearchArgument name is set to the Parameter label and SearchArgument value is set to the Parameter name and SearchArgument propertyClass is set to the Parameter clazz
    
    Parameters:
    
    parameter -
  - getParsedComposition
```
public List<Object> getParsedComposition()
```
    Deprecated.
  - setParsedComposition
```
public void setParsedComposition(List<Object> parsedComposition)
```
    Deprecated.
    
    Elements in this list can be: an Integer, indicating a 1-based index into a search history a BooleanOperator (AND, OR, NOT) a PatientFilter a PatientSearch another List of the same form, which indicates a parenthetical expression
  - getSavedSearchId
```
public Integer getSavedSearchId()
```
    Deprecated.
  - setSavedSearchId
```
public void setSavedSearchId(Integer savedSearchId)
```
    Deprecated.
  - getSavedFilterId
```
public Integer getSavedFilterId()
```
    Deprecated.
  - setSavedFilterId
```
public void setSavedFilterId(Integer savedFilterId)
```
    Deprecated.
  - getSavedCohortId
```
public Integer getSavedCohortId()
```
    Deprecated.
  - setSavedCohortId
```
public void setSavedCohortId(Integer savedCohortId)
```
    Deprecated.
  - setParameterValue
```
public void setParameterValue(String name,
                              String value)
```
    Deprecated.

Class PatientSearch

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

Constructor Detail

PatientSearch

Method Detail

createSavedSearchReference

createSavedFilterReference

createSavedCohortReference

createCompositionSearch

createCompositionSearch

createCompositionSearch

createFilterSearch

toString

isComposition

getCompositionString

setSpecificationString

getSpecificationString

requiresHistory

copyAndDetachFromHistory

cloneCompositionAsFilter

cloneCompositionAsFilter

isSavedReference

isSavedSearchReference

isSavedFilterReference

isSavedCohortReference

removeFromHistoryNotify

getArgumentValue

getArguments

setArguments

getParameters

getFilterClass

setFilterClass

addArgument

addArgument

addParameter

getParsedComposition

setParsedComposition

getSavedSearchId

setSavedSearchId

getSavedFilterId

setSavedFilterId

getSavedCohortId

setSavedCohortId

setParameterValue