com.liferay.dynamic.data.lists.exporter.impl

Class BaseDDLExporter

java.lang.Object

com.liferay.dynamic.data.lists.exporter.impl.BaseDDLExporter

All Implemented Interfaces:

DDLExporter

Direct Known Subclasses:

DDLCSVExporter, DDLXMLExporter

@ProviderType
public abstract class BaseDDLExporter
extends java.lang.Object
implements DDLExporter

Constructor Summary

Constructors

Constructor and Description
BaseDDLExporter()

Method Summary

Modifier and Type	Method and Description
protected abstract byte[]	doExport(long recordSetId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator)
byte[]	export(long recordSetId) Exports the record set's records as a byte array.
byte[]	export(long recordSetId, int status) Exports the record set's records of the workflow status as a byte array.
byte[]	export(long recordSetId, int status, int start, int end) Exports a range of the record set's records as a byte array.
byte[]	export(long recordSetId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator) Exports an ordered range of the record set's records as a byte array.
protected java.util.List<DDMFormField>	getDDMFormFields(DDMStructure ddmStructure)
java.util.Locale	getLocale() Returns the locale of the current DDL Exporter service instance.
protected java.lang.String	getStatusMessage(int status)
void	setLocale(java.util.Locale locale) Returns the locale of the current DDL Exporter service instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.dynamic.data.lists.exporter.DDLExporter

getFormat

Constructor Detail

BaseDDLExporter

public BaseDDLExporter()

Method Detail

export

public byte[] export(long recordSetId)
              throws java.lang.Exception

Description copied from interface: DDLExporter

Exports the record set's records as a byte array.

Specified by:

export in interface DDLExporter

Parameters:

recordSetId - the record set ID

Returns:

the byte values of the exported records

Throws:

java.lang.Exception - if an unexpected exception occurred

export

public byte[] export(long recordSetId,
                     int status)
              throws java.lang.Exception

Description copied from interface: DDLExporter

Exports the record set's records of the workflow status as a byte array.

Specified by:

export in interface DDLExporter

Parameters:

recordSetId - the record set ID

status - the workflow status of the records to export

Returns:

the byte values of the exported records

Throws:

java.lang.Exception - if an unexpected exception occurred

export

public byte[] export(long recordSetId,
                     int status,
                     int start,
                     int end)
              throws java.lang.Exception

Description copied from interface: DDLExporter

Exports a range of the record set's records as a byte array.

Specified by:

export in interface DDLExporter

Parameters:

recordSetId - the record set ID

status - the workflow status of the records

start - the lower bound of the range of records to export

end - the upper bound of the range of records to export (not inclusive)

Returns:

the byte values of the exported records

Throws:

java.lang.Exception - if an unexpected exception occurred

export

public byte[] export(long recordSetId,
                     int status,
                     int start,
                     int end,
                     com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator)
              throws java.lang.Exception

Description copied from interface: DDLExporter

Exports an ordered range of the record set's records as a byte array.

Specified by:

export in interface DDLExporter

Parameters:

recordSetId - the record set ID

status - the workflow status of the records

start - the lower bound of the range of records to export

end - the upper bound of the range of records to export (not inclusive)

orderByComparator - a comparator to order the records (optionally null)

Returns:

the byte values of the exported records

Throws:

java.lang.Exception - if an unexpected exception occurred

getLocale

public java.util.Locale getLocale()

Description copied from interface: DDLExporter

Returns the locale of the current DDL Exporter service instance.

Specified by:

getLocale in interface DDLExporter

Returns:

the locale of the current service instance

setLocale

public void setLocale(java.util.Locale locale)

Description copied from interface: DDLExporter

Returns the locale of the current DDL Exporter service instance.

Specified by:

setLocale in interface DDLExporter

Parameters:

locale - the locale used to retrieve the localized values of the record

doExport

protected abstract byte[] doExport(long recordSetId,
                                   int status,
                                   int start,
                                   int end,
                                   com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getDDMFormFields

protected java.util.List<DDMFormField> getDDMFormFields(DDMStructure ddmStructure)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getStatusMessage

protected java.lang.String getStatusMessage(int status)