org.openmrs.obs.handler

Class BinaryStreamHandler

java.lang.Object

org.openmrs.obs.handler.AbstractHandler

org.openmrs.obs.handler.BinaryStreamHandler

All Implemented Interfaces:

ComplexObsHandler

public class BinaryStreamHandler
extends AbstractHandler
implements ComplexObsHandler

Handler for storing generic binary data for complex obs to the file system.

Since:

1.8

See Also:

OpenmrsConstants.GLOBAL_PROPERTY_COMPLEX_OBS_DIR

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
BinaryStreamHandler() 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) Returns the same ComplexData for all views.
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

BinaryStreamHandler

public BinaryStreamHandler()

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

Method Detail

getObs

public Obs getObs(Obs obs,
                  String view)

Returns the same ComplexData for all views. The title is the original filename, and the data is the raw byte[] of data (If the view is set to "download", all commas and whitespace are stripped out of the filename to fix an issue where the browser wasn't handling a filename with whitespace properly) Note that if the method cannot find the file associated with the obs, it returns the obs with the ComplexData = null

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(Obs, 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(Obs)