Package org.cyclos.impl.system

Class TabularExportHandlerImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseNetworkedHandlerImpl

org.cyclos.impl.system.TabularExportHandlerImpl

All Implemented Interfaces:

ExportHandler

Direct Known Subclasses:

CSVExportHandlerImpl, ExcelExportHandlerImpl

public abstract class TabularExportHandlerImpl
extends BaseNetworkedHandlerImpl
implements ExportHandler

An export handler that exports tabular data

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	TabularExportHandlerImpl.Column	Represents a column in a tabular export
protected static class	TabularExportHandlerImpl.ColumnType
protected class	TabularExportHandlerImpl.CustomColumn	A tabular column obtained from a custom function IMPORTANT: remember than the getter will receive the entity and not a data translation proxy so if the getter will return a String it must be translated in the getter because the formatter will not translate it.
protected class	TabularExportHandlerImpl.CustomFieldColumn	A tabular column obtained from a custom field value
protected class	TabularExportHandlerImpl.CustomOperationColumn
protected class	TabularExportHandlerImpl.ProfileFieldColumn	A tabular column obtained from a profile field, reading from UserWithFieldsVO or BasicUser
protected class	TabularExportHandlerImpl.PropertyColumn	A tabular column obtained from a bean property
protected class	TabularExportHandlerImpl.TransactionCustomFieldColumn	A tabular column obtained from a payment custom field value
protected class	TabularExportHandlerImpl.TransferStatusColumn	A tabular column obtained from a transfer status flow

Nested classes/interfaces inherited from interface org.cyclos.impl.system.ExportHandler

ExportHandler.ExportParameters

Field Summary

Fields

Modifier and Type	Field	Description
protected AccountServiceLocal	accountService
protected TransactionCustomFieldServiceLocal	transactionCustomFieldService

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
TabularExportHandlerImpl()

Method Summary

Modifier and Type	Method	Description
protected abstract SerializableInputStream	build(ExportHandler.ExportParameters params, List<TabularExportHandlerImpl.Column> columns)	Builds the report based on the given columns
SerializableInputStream	export(ExportHandler.ExportParameters params)	Exports the given data to file

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.impl.system.ExportHandler

getBuiltInFormat

Field Detail

transactionCustomFieldService

@Autowired
@Lazy
protected TransactionCustomFieldServiceLocal transactionCustomFieldService

accountService

@Autowired
@Lazy
protected AccountServiceLocal accountService

Constructor Detail

TabularExportHandlerImpl

public TabularExportHandlerImpl()

Method Detail

export

public SerializableInputStream export(ExportHandler.ExportParameters params)

Description copied from interface: ExportHandler

Exports the given data to file

Specified by:

export in interface ExportHandler

build

protected abstract SerializableInputStream build(ExportHandler.ExportParameters params,
                                                 List<TabularExportHandlerImpl.Column> columns)

Builds the report based on the given columns