org.openmrs.customdatatype

Interface DownloadableDatatypeHandler<T>

All Superinterfaces:

CustomDatatypeHandler<CustomDatatype<T>,T>

All Known Implementing Classes:

LongFreeTextFileUploadHandler, LongFreeTextTextareaHandler

public interface DownloadableDatatypeHandler<T>
extends CustomDatatypeHandler<CustomDatatype<T>,T>

Indicates that a CustomDatatypeHandler allows underlying custom values to be downloaded or streamed in some meaningful way.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContentType(CustomDatatype<T> dt, java.lang.String valueReference)
java.lang.String	getFilename(CustomDatatype<T> dt, java.lang.String valueReference)
void	writeToStream(CustomDatatype<T> dt, java.lang.String valueReference, java.io.OutputStream os) Writes the custom value to os.

Methods inherited from interface org.openmrs.customdatatype.CustomDatatypeHandler

setHandlerConfiguration

Method Detail

getContentType

java.lang.String getContentType(CustomDatatype<T> dt,
                                java.lang.String valueReference)

Parameters:

dt - the datatype this handler handles

valueReference - custom value to be downloaded

Returns:

the MIME type that should be communicated to any client downloading the given custom value. Should not return null.

getFilename

java.lang.String getFilename(CustomDatatype<T> dt,
                             java.lang.String valueReference)

Parameters:

dt - the datatype this handler handles

valueReference - custom value to be downloaded

Returns:

the filename that should be communicated to any client downloading the given custom value. May return null, in which case the framework will choose a meaningless filename.

writeToStream

void writeToStream(CustomDatatype<T> dt,
                   java.lang.String valueReference,
                   java.io.OutputStream os)
            throws java.io.IOException

Writes the custom value to os. Implementations should assume that the caller has set up the stream, calling getMimeType and getFilename if necessary. Implementations should assume that the caller has taken care of any needed buffering on os.

Parameters:

dt - the datatype this handler handles

valueReference - custom value to be written to os

os - the output stream to be written to

Throws:

java.io.IOException - if there is an IO error writing to the stream