org.openmrs.obs

Interface ComplexObsHandler

All Known Subinterfaces:

SerializableComplexObsHandler

All Known Implementing Classes:

BinaryDataHandler, BinaryStreamHandler, ImageHandler, MediaHandler, TextHandler

public interface ComplexObsHandler

Interface for handling complex obs. Implementing classes are responsible for the storage and retrieval of ComplexData associated with an Obs that is complex -- where Obs.isComplex() returns true.

These handler classes are delegated to by the ObsService and should never be called directly.

Use case:

   Obs complexObs = Context.getObsService().getComplexObs(123, OpenmrsConstants.RAW_VIEW);
   ComplexData complexData = complexObs.getComplexData();
   Object largeStoredObject = complexData.getData();
 

Since:

1.5

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTML_VIEW
static String	PREVIEW_VIEW
static String	RAW_VIEW
static String	TEXT_VIEW
static String	TITLE_VIEW
static String	URI_VIEW

Method Summary

Modifier and Type	Method and Description
Obs	getObs(Obs obs, String view) Fetches the ComplexData from the location indicated from Obs.value_complex, attaches ComplexData onto the Obs and returns the Obs.
String[]	getSupportedViews() Supported views getter
boolean	purgeComplexData(Obs obs) Completely removes the ComplexData Object from its storage location.
Obs	saveObs(Obs obs) Save a complex obs.
boolean	supportsView(String view) View support check

Field Detail

RAW_VIEW

static final String RAW_VIEW

See Also:

Constant Field Values

TITLE_VIEW

static final String TITLE_VIEW

See Also:

Constant Field Values

TEXT_VIEW

static final String TEXT_VIEW

See Also:

Constant Field Values

HTML_VIEW

static final String HTML_VIEW

See Also:

Constant Field Values

PREVIEW_VIEW

static final String PREVIEW_VIEW

See Also:

Constant Field Values

URI_VIEW

static final String URI_VIEW

See Also:

Constant Field Values

Method Detail

saveObs

Obs saveObs(Obs obs)
     throws APIException

Save a complex obs. This extracts the ComplexData from an Obs, stores it to a location determined by the handler, and returns the Obs with the ComplexData nullified.

Parameters:

obs -

Returns:

the Obs with the ComplexData nullified

Throws:

APIException

getObs

Obs getObs(Obs obs,
           String view)

Fetches the ComplexData from the location indicated from Obs.value_complex, attaches ComplexData onto the Obs and returns the Obs.
The ComplexData is returned in the format specified by the view (which can be null).
This view is typically a contract between the view and the handler that has been registered, so they those two know the types of views that can be handled.

Parameters:

obs - an obs without complex data filled in

view - nullable view type. This is defined by the ui and view/handler

Returns:

the obs with complex data filled in

See Also:

OpenmrsConstants

purgeComplexData

boolean purgeComplexData(Obs obs)

Completely removes the ComplexData Object from its storage location.

TODO: If we cannot delete the complex data object because of an error, do we want to return the Obs, a boolean false, or an Exception?

Parameters:

obs -

getSupportedViews

String[] getSupportedViews()

Supported views getter

Returns:

all views supported by this handler

Since:

1.12

supportsView

boolean supportsView(String view)

View support check

Parameters:

view - view type defined by UI and view/handler

Returns:

true if given view is supported by this handler

Since:

1.12