org.cyclos.impl.system

Interface ImportHandler<DTO extends ImportedFileDTO,D extends ImportedFileData,IF extends ImportedFile>

All Known Subinterfaces:

ImportWithImageHandler<DTO,D,IF>

public interface ImportHandler<DTO extends ImportedFileDTO,D extends ImportedFileData,IF extends ImportedFile>

Handler for imports

Author:

jcomas

Method Summary

Methods

Modifier and Type	Method and Description
void	finishImport(ImportedFile importedFile) Executes some processing when import has finished
java.util.List<java.lang.String>	getAllowedImportFields(ImportedFile importedFile) Returns a list of the allowed fields to be imported
D	getData(ImportedFile importedFile) Returns the data associated to an import
java.lang.Class<IF>	getEntityClass() Returns the main entity of the import
java.util.List<java.lang.String>	getKeywordFields() Returns a list of field names that can be used to search for imported lines
java.util.List<ImportField>	getSearchImportedLineFields() Returns the list of fields that will be used to show the information of import lines.
java.lang.Object	instantiateContext() Returns an import context that will be used in the validation and processing of each import line.
IF	newEntity(DTO dto) Returns a new entity based on a dto
java.lang.Long	processImportedLine(ImportedLine importedLine, java.lang.Object context) Imports an entity with the information in the imported line and returns the new entity id.
org.cyclos.impl.utils.validation.Validator	resolveValidator(DTO dto) Returns a new validator for the import.
void	validateImportedLine(ImportedLine importedLine, java.lang.Object context) Validates the imported line

Method Detail

finishImport

void finishImport(ImportedFile importedFile)

Executes some processing when import has finished

getAllowedImportFields

java.util.List<java.lang.String> getAllowedImportFields(ImportedFile importedFile)

Returns a list of the allowed fields to be imported

getData

D getData(ImportedFile importedFile)

Returns the data associated to an import

getEntityClass

java.lang.Class<IF> getEntityClass()

Returns the main entity of the import

getKeywordFields

java.util.List<java.lang.String> getKeywordFields()

Returns a list of field names that can be used to search for imported lines

getSearchImportedLineFields

java.util.List<ImportField> getSearchImportedLineFields()

Returns the list of fields that will be used to show the information of import lines.

instantiateContext

java.lang.Object instantiateContext()

Returns an import context that will be used in the validation and processing of each import line.

newEntity

IF newEntity(DTO dto)

Returns a new entity based on a dto

processImportedLine

java.lang.Long processImportedLine(ImportedLine importedLine,
                                 java.lang.Object context)

Imports an entity with the information in the imported line and returns the new entity id.

resolveValidator

org.cyclos.impl.utils.validation.Validator resolveValidator(DTO dto)

Returns a new validator for the import.

validateImportedLine

void validateImportedLine(ImportedLine importedLine,
                        java.lang.Object context)
                          throws ValidationException

Validates the imported line

Throws:

ValidationException