org.openmrs.obs.handler

Class TextHandler

java.lang.Object

org.openmrs.obs.handler.AbstractHandler

org.openmrs.obs.handler.TextHandler

All Implemented Interfaces:

ComplexObsHandler

public class TextHandler
extends AbstractHandler
implements ComplexObsHandler

Handler for storing files for complex obs to the file system. Files are stored in the location specified by the global property: "obs.complex_obs_dir" The in coming data are either char[] or java.io.Reader

Field Summary

Fields inherited from class org.openmrs.obs.handler.AbstractHandler

nf

Fields inherited from interface org.openmrs.obs.ComplexObsHandler

HTML_VIEW, PREVIEW_VIEW, RAW_VIEW, TEXT_VIEW, TITLE_VIEW, URI_VIEW

Constructor Summary

Constructors

Constructor and Description
TextHandler() Constructor initializes formats for alternative file names to protect from unintentionally overwriting existing files.

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
Obs	saveObs(Obs obs) Save a complex obs.

Methods inherited from class org.openmrs.obs.handler.AbstractHandler

getComplexDataFile, getExtension, getOutputFileToWrite, purgeComplexData, supportsView

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmrs.obs.ComplexObsHandler

purgeComplexData, supportsView

Constructor Detail

TextHandler

public TextHandler()

Constructor initializes formats for alternative file names to protect from unintentionally overwriting existing files.

Method Detail

getObs

public Obs getObs(Obs obs,
                  String view)

Description copied from interface: ComplexObsHandler

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.

Specified by:

getObs in interface ComplexObsHandler

Overrides:

getObs in class AbstractHandler

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:

ComplexObsHandler.getObs(org.openmrs.Obs, java.lang.String)

getSupportedViews

public String[] getSupportedViews()

Description copied from interface: ComplexObsHandler

Supported views getter

Specified by:

getSupportedViews in interface ComplexObsHandler

Overrides:

getSupportedViews in class AbstractHandler

Returns:

all views supported by this handler

See Also:

ComplexObsHandler.getSupportedViews()

saveObs

public Obs saveObs(Obs obs)
            throws APIException

Description copied from interface: ComplexObsHandler

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.

Specified by:

saveObs in interface ComplexObsHandler

Returns:

the Obs with the ComplexData nullified

Throws:

APIException

See Also:

ComplexObsHandler.saveObs(org.openmrs.Obs)