Package org.cyclos.impl.system

Class ExportFormatServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<ExportFormat,QExportFormat,ExportFormatDTO,ExportFormatData,Void>

org.cyclos.impl.system.ExportFormatServiceImpl

All Implemented Interfaces:

CRUDServiceLocal<ExportFormat,ExportFormatDTO,ExportFormatData,Void>, ExportFormatServiceLocal, CRUDService<ExportFormatDTO,ExportFormatData,Void>, CRUDWithConfirmationPasswordService<ExportFormatDTO,ExportFormatData,Void>, Service, ExportFormatService

@Service
public class ExportFormatServiceImpl
extends CRUDServiceImpl<ExportFormat,QExportFormat,ExportFormatDTO,ExportFormatData,Void>
implements ExportFormatServiceLocal

Implementation for ExportFormatService

Field Summary

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, richTextHandler, withConfirmationPassword

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
ExportFormatServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addCustomInternalNameValidations(Property internalName, ExportFormatDTO dto)	This method may be overridden to add custom validations for the INTERNAL_NAME property.
FileInfo	exportMultiple(ExportFormat format, ExportFormatContext context, QueryParameters params, com.mysema.commons.lang.CloseableIterator<?> entities)	Exports a series of entities using the given format and context
FileInfo	exportMultiple(ExportFormat format, ExportFormatContext context, QueryParameters params, com.mysema.commons.lang.CloseableIterator<?> entities, Map<String,Object> additionalData)	Exports a series of entities using the given format and context, passing additional data to the export handler
FileInfo	exportSingle(ExportFormat format, ExportFormatContext context, SimpleEntity entity)	Exports a single entity using the given format and context
FileInfo	exportSingle(ExportFormat format, ExportFormatContext context, SimpleEntity entity, Map<String,Object> additionalData)	Exports a single entity using the given format and context, passing additional data to the export handler
ExportFormat	getCSV()	Returns CSV export format
protected ExportFormatData	getData(ExportFormat entity)	Returns details data for the given entity
ExportFormat	getPDF()	Returns the PDF export format
ExportFormat	getXLSX()	Returns the XLSX export format
void	initialize()
protected boolean	isEntityInternalNameRequired()	NOTE: This method will be only invoked if the entity is an IInternalNamedEntity.
List<ExportFormatVO>	list()	Lists all available export formats
List<ExportFormat>	listAll()	Returns all the export formats
List<ExportFormat>	listByContext(ExportFormatContext context)	Returns the enabled export formats associated with the given context
ExportFormat	load(String internalName)	Loads an export format by internal name
ExportFormat	newEntity(Void params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected Object	onBeforeSave(ExportFormat entity, ExportFormat currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
protected Validator	resolveValidator(ExportFormatDTO dto)

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isNameRequired, load, logEntity, onAfterRemove, onAfterSave, onBeforeRemove, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, subClassMappings, toDTO, toEntity, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

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.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Constructor Detail

ExportFormatServiceImpl

public ExportFormatServiceImpl()

Method Detail

exportMultiple

public FileInfo exportMultiple(ExportFormat format,
                               ExportFormatContext context,
                               QueryParameters params,
                               com.mysema.commons.lang.CloseableIterator<?> entities)

Description copied from interface: ExportFormatServiceLocal

Exports a series of entities using the given format and context

Specified by:

exportMultiple in interface ExportFormatServiceLocal

exportMultiple

public FileInfo exportMultiple(ExportFormat format,
                               ExportFormatContext context,
                               QueryParameters params,
                               com.mysema.commons.lang.CloseableIterator<?> entities,
                               Map<String,Object> additionalData)

Description copied from interface: ExportFormatServiceLocal

Exports a series of entities using the given format and context, passing additional data to the export handler

Specified by:

exportMultiple in interface ExportFormatServiceLocal

exportSingle

public FileInfo exportSingle(ExportFormat format,
                             ExportFormatContext context,
                             SimpleEntity entity)

Description copied from interface: ExportFormatServiceLocal

Exports a single entity using the given format and context

Specified by:

exportSingle in interface ExportFormatServiceLocal

exportSingle

public FileInfo exportSingle(ExportFormat format,
                             ExportFormatContext context,
                             SimpleEntity entity,
                             Map<String,Object> additionalData)

Description copied from interface: ExportFormatServiceLocal

Exports a single entity using the given format and context, passing additional data to the export handler

Specified by:

exportSingle in interface ExportFormatServiceLocal

getCSV

public ExportFormat getCSV()

Description copied from interface: ExportFormatServiceLocal

Returns CSV export format

Specified by:

getCSV in interface ExportFormatServiceLocal

getPDF

public ExportFormat getPDF()

Description copied from interface: ExportFormatServiceLocal

Returns the PDF export format

Specified by:

getPDF in interface ExportFormatServiceLocal

getXLSX

public ExportFormat getXLSX()

Description copied from interface: ExportFormatServiceLocal

Returns the XLSX export format

Specified by:

getXLSX in interface ExportFormatServiceLocal

initialize

@PostConstruct
public void initialize()

list

public List<ExportFormatVO> list()
                          throws FrameworkException

Description copied from interface: ExportFormatService

Lists all available export formats

Specified by:

list in interface ExportFormatService

Throws:

FrameworkException

listAll

public List<ExportFormat> listAll()

Description copied from interface: ExportFormatServiceLocal

Returns all the export formats

Specified by:

listAll in interface ExportFormatServiceLocal

listByContext

public List<ExportFormat> listByContext(ExportFormatContext context)

Description copied from interface: ExportFormatServiceLocal

Returns the enabled export formats associated with the given context

Specified by:

listByContext in interface ExportFormatServiceLocal

load

public ExportFormat load(String internalName)

Description copied from interface: ExportFormatServiceLocal

Loads an export format by internal name

Specified by:

load in interface ExportFormatServiceLocal

newEntity

public ExportFormat newEntity(Void params)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<ExportFormat,ExportFormatDTO,ExportFormatData,Void>

Specified by:

newEntity in class CRUDServiceImpl<ExportFormat,QExportFormat,ExportFormatDTO,ExportFormatData,Void>

addCustomInternalNameValidations

protected void addCustomInternalNameValidations(Property internalName,
                                                ExportFormatDTO dto)

Description copied from class: CRUDServiceImpl

This method may be overridden to add custom validations for the INTERNAL_NAME property.

Overrides:

addCustomInternalNameValidations in class CRUDServiceImpl<ExportFormat,QExportFormat,ExportFormatDTO,ExportFormatData,Void>

getData

protected ExportFormatData getData(ExportFormat entity)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<ExportFormat,QExportFormat,ExportFormatDTO,ExportFormatData,Void>

isEntityInternalNameRequired

protected boolean isEntityInternalNameRequired()

Description copied from class: CRUDServiceImpl

NOTE: This method will be only invoked if the entity is an IInternalNamedEntity. Subclasses could override it if the internal name is required.

Overrides:

isEntityInternalNameRequired in class CRUDServiceImpl<ExportFormat,QExportFormat,ExportFormatDTO,ExportFormatData,Void>

Returns:

false (optional by default)

onBeforeSave

protected Object onBeforeSave(ExportFormat entity,
                              ExportFormat currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<ExportFormat,QExportFormat,ExportFormatDTO,ExportFormatData,Void>

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

resolveValidator

protected Validator resolveValidator(ExportFormatDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<ExportFormat,QExportFormat,ExportFormatDTO,ExportFormatData,Void>