org.openmrs.obs.handler

Class AbstractHandler

java.lang.Object

org.openmrs.obs.handler.AbstractHandler

Direct Known Subclasses:

BinaryDataHandler, BinaryStreamHandler, ImageHandler, MediaHandler, TextHandler

public class AbstractHandler
extends Object

Abstract handler for some convenience methods Files are stored in the location specified by the global property: "obs.complex_obs_dir"

Since:

1.5

Field Summary

Fields

Modifier and Type	Field and Description
protected NumberFormat	nf

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static File	getComplexDataFile(Obs obs) Convenience method to create and return a file for the stored ComplexData.data Object
String	getExtension(String filename) Deprecated. since 2.1.3 use FilenameUtils.getExtension(String) instead.
Obs	getObs(Obs obs, String view)
File	getOutputFileToWrite(Obs obs) Returns a File for the given obs complex data to be written to.
String[]	getSupportedViews()
boolean	purgeComplexData(Obs obs)
boolean	supportsView(String view)

Methods inherited from class java.lang.Object

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

Field Detail

nf

protected NumberFormat nf

Constructor Detail

AbstractHandler

public AbstractHandler()

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

Method Detail

getOutputFileToWrite

public File getOutputFileToWrite(Obs obs)
                          throws IOException

Returns a File for the given obs complex data to be written to. The output file location is determined off of the OpenmrsConstants.GLOBAL_PROPERTY_COMPLEX_OBS_DIR and the file name is determined off the current obs.getComplexData().getTitle().

Parameters:

obs - the Obs with a non-null complex data on it

Returns:

File that the complex data should be written to

Throws:

IOException

getExtension

@Deprecated
public String getExtension(String filename)

Deprecated. since 2.1.3 use FilenameUtils.getExtension(String) instead.

Get the extension for a given filename if it exists, else return the filename. If there is no filename in the input string, "raw" is returned. If given "asdf.jpg", will return "jpg". If given "asdf", will return "asdf". If given "" or "a/b/c/" will return "raw".

Parameters:

filename -

Returns:

the part after the period in the given filename, the filename, or "raw"

getObs

public Obs getObs(Obs obs,
                  String view)

See Also:

ComplexObsHandler.getObs(Obs, String)

purgeComplexData

public boolean purgeComplexData(Obs obs)

See Also:

ComplexObsHandler.purgeComplexData(org.openmrs.Obs)

getComplexDataFile

public static File getComplexDataFile(Obs obs)

Convenience method to create and return a file for the stored ComplexData.data Object

Parameters:

obs -

Returns:

File object

getSupportedViews

public String[] getSupportedViews()

See Also:

ComplexObsHandler.getSupportedViews()

supportsView

public boolean supportsView(String view)

See Also:

ComplexObsHandler.supportsView(java.lang.String)