org.kuali.rice.kew.export

Class DataExporter

java.lang.Object

org.kuali.rice.kew.export.DataExporter

All Implemented Interfaces:

Exporter

public class DataExporter
extends Object
implements Exporter

The DataExporter allows for exporting of KEW BusinessObjects to various supported formats. The current implementation supports only XML export. This process is initiated from the KNS screens (lookups and inquiries) and this implementation leverages the existing XmlExporterService which is part of KEW and which was used to do exports before KEW was converted to use the KNS.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Constructor Summary

Constructors

Constructor and Description
DataExporter()

Method Summary

Methods

Modifier and Type	Method and Description
protected ExportDataSet	buildExportDataSet(Class<?> dataObjectClass, List<? extends Object> dataObjects) Builds the ExportDataSet based on the BusinessObjects passed in.
void	export(Class<?> dataObjectClass, List<? extends Object> dataObjects, String exportFormat, OutputStream outputStream) Export the given List of Objects of the specified type to XML.
List<String>	getSupportedFormats(Class<?> dataObjectClass) Returns a List of ExportFormats supported by this Exporter for the given DataOject class.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataExporter

public DataExporter()

Method Detail

getSupportedFormats

public List<String> getSupportedFormats(Class<?> dataObjectClass)

Description copied from interface: Exporter

Returns a List of ExportFormats supported by this Exporter for the given DataOject class.

Specified by:

getSupportedFormats in interface Exporter

Parameters:

dataObjectClass - the class of the DataObjects being exported

Returns:

a List of supported ExportFormats

See Also:

Exporter.getSupportedFormats(java.lang.Class)

buildExportDataSet

protected ExportDataSet buildExportDataSet(Class<?> dataObjectClass,
                               List<? extends Object> dataObjects)

Builds the ExportDataSet based on the BusinessObjects passed in.

export

public void export(Class<?> dataObjectClass,
          List<? extends Object> dataObjects,
          String exportFormat,
          OutputStream outputStream)
            throws IOException,
                   ExportNotSupportedException

Export the given List of Objects of the specified type to XML.

Specified by:

export in interface Exporter

Parameters:

dataObjectClass - the type of DataObjects being exported

dataObjects - a List of DataObjects to export

exportFormat - the export format in which to export the DataObjects

outputStream - the OutputStream to write the exported data to

Throws:

IOException - if the process encounters an I/O issue

ExportNotSupportedException - if the given ExportFormat is not supported

See Also:

Exporter.export(java.lang.Class, java.util.List, java.lang.String, java.io.OutputStream)