com.webmethods.caf.faces.data.eform

Class EFormContentProvider

java.lang.Object

com.webmethods.caf.faces.data.eform.EFormContentProvider

All Implemented Interfaces:

IRefreshable

public class EFormContentProvider
extends Object
implements IRefreshable

Enables conversion of e-form data bean (IS Document) to and from e-form binary data. Provides convenient method for streaming (downloading) of the e-form and parsing uploaded file.

Constructor Summary

Constructors

Constructor and Description
EFormContentProvider()

Method Summary

Modifier and Type	Method and Description
void	convertBeanToBinary() Converts beanData into eformData using the template
void	convertBinaryToBean() Converts e-form data into bean data
void	download() Streams generated e-form file to the client.
ValueBinding	getBeanBinding()
Class<?>	getBeanClass()
Object	getBeanData()
byte[]	getBinaryData() Returns e-form binary data generated from data bean using template
IFileExportBeanEx	getDownloadFile()
String	getFileName()
boolean	getNeedRefresh() Returns true when IRefreshable.isAutoRefresh() is on and the result properties need to be refreshed from the data source by executing IRefreshable.refresh() method.
IEFormTemplateProvider	getTemplateProvider()
org.apache.commons.fileupload.FileItem	getUploadFile()
boolean	isAutoRefresh() Returns true if the provider is currenlty in auto-refresh mode
void	refresh() (Re)loads data from the data source.
void	setAutoRefresh(boolean autoRefresh) Sets auto refresh mode on.
void	setBeanBinding(ValueBinding beanBinding) Sets IS document bean value binding
void	setBeanClass(Class<?> beanClass)
void	setBeanData(Object beanData) Sets new e-form data bean (IS Document) instance to use for generation of e-form file
void	setBinaryData(byte[] binaryData)
void	setFileName(String fileName) Sets e-form file name
void	setNeedRefresh(boolean needRefresh) Tells the provider that the input parameters have changed and the output results need to be refreshed the next time any output property is requested via IContentProvider.getValue(Object).
void	setTemplateProvider(IEFormTemplateProvider templateProvider)
void	setUploadFile(org.apache.commons.fileupload.FileItem uploadFile) Convenience property to bind to the File Upload control and use as the source for the #setBinaryData()
boolean	supportsAutoRefresh() Returns true if this content provider supports auto refresh feature.
void	upload() Handles conversion of uploaded e-form file into the document and sets the bean value.

Methods inherited from class java.lang.Object

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

Constructor Detail

EFormContentProvider

public EFormContentProvider()

Method Detail

getTemplateProvider

public IEFormTemplateProvider getTemplateProvider()

setTemplateProvider

public void setTemplateProvider(IEFormTemplateProvider templateProvider)

getBeanBinding

public ValueBinding getBeanBinding()

setBeanBinding

public void setBeanBinding(ValueBinding beanBinding)

Sets IS document bean value binding

Parameters:

beanBinding - must not be null

getBeanData

public Object getBeanData()

See Also:

setBeanData(Object)

setBeanData

public void setBeanData(Object beanData)

Sets new e-form data bean (IS Document) instance to use for generation of e-form file

getBeanClass

public Class<?> getBeanClass()

setBeanClass

public void setBeanClass(Class<?> beanClass)

getFileName

public String getFileName()

See Also:

setFileName(String)

setFileName

public void setFileName(String fileName)

Sets e-form file name

Parameters:

fileName - for downloaded e-form

refresh

public void refresh()
             throws ContentProviderException

Description copied from interface: IRefreshable

(Re)loads data from the data source. Implementation specific meaning can be executing a SQL query or a web service call. All current data will be lost and updated with the new results if successful.

Specified by:

refresh in interface IRefreshable

Throws:

ContentProviderException - if error loading data from the data source

convertBeanToBinary

public void convertBeanToBinary()
                         throws ContentProviderException

Converts beanData into eformData using the template

Throws:

ContentProviderException

convertBinaryToBean

public void convertBinaryToBean()
                         throws ContentProviderException

Converts e-form data into bean data

Throws:

ContentProviderException

getBinaryData

public byte[] getBinaryData()

Returns e-form binary data generated from data bean using template

Returns:

setBinaryData

public void setBinaryData(byte[] binaryData)

getDownloadFile

public IFileExportBeanEx getDownloadFile()

getUploadFile

public org.apache.commons.fileupload.FileItem getUploadFile()

setUploadFile

public void setUploadFile(org.apache.commons.fileupload.FileItem uploadFile)

Convenience property to bind to the File Upload control and use as the source for the #setBinaryData()

Parameters:

uploadFile -

download

public void download()
              throws ContentProviderException

Streams generated e-form file to the client. Needs to have valid FacesContext

Throws:

ContentProviderException

upload

public void upload()
            throws ContentProviderException

Handles conversion of uploaded e-form file into the document and sets the bean value. Needs valid FacesContext

Throws:

ContentProviderException

getNeedRefresh

public boolean getNeedRefresh()

Description copied from interface: IRefreshable

Returns true when IRefreshable.isAutoRefresh() is on and the result properties need to be refreshed from the data source by executing IRefreshable.refresh() method.

Implementations may return an accurate value from this method if they can track the changes to the input parameter properties or they may require the clients to call IRefreshable.setNeedRefresh(boolean) explicitely.

Specified by:

getNeedRefresh in interface IRefreshable

Returns:

true when the output properties are not up-to-date with the current input parameters, i.e. IRefreshable.refresh() needs to be executed manually or automatically.

isAutoRefresh

public boolean isAutoRefresh()

Description copied from interface: IRefreshable

Returns true if the provider is currenlty in auto-refresh mode

Specified by:

isAutoRefresh in interface IRefreshable

Returns:

false if auto-refresh mode is off or not supported

setAutoRefresh

public void setAutoRefresh(boolean autoRefresh)
                    throws ContentProviderException

Description copied from interface: IRefreshable

Sets auto refresh mode on. When auto refresh mode is on, the provider calls IRefreshable.getNeedRefresh() to determine whether the refresh needs to be done before returning any result properties. If it returns true, the provider calls IRefreshable.refresh() method to updated the result properties.

Specified by:

setAutoRefresh in interface IRefreshable

Parameters:

autoRefresh - true to turn it on

Throws:

ContentProviderException - if auto refresh mode is not supported

See Also:

IRefreshable.supportsAutoRefresh(), IRefreshable.getNeedRefresh(), IRefreshable.setNeedRefresh(boolean)

setNeedRefresh

public void setNeedRefresh(boolean needRefresh)

Description copied from interface: IRefreshable

Tells the provider that the input parameters have changed and the output results need to be refreshed the next time any output property is requested via IContentProvider.getValue(Object).

Specified by:

setNeedRefresh in interface IRefreshable

Parameters:

needRefresh - true if the input parameters have changed

supportsAutoRefresh

public boolean supportsAutoRefresh()

Description copied from interface: IRefreshable

Returns true if this content provider supports auto refresh feature.

Specified by:

supportsAutoRefresh in interface IRefreshable

Returns:

true when auto refresh is supported

See Also:

IRefreshable.setAutoRefresh(boolean)