org.cyclos.impl.system

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

All Known Subinterfaces:

ImportWithImageHandler<DTO,D,IF,E>

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

Handler for imports

Author:

jcomas

Method Summary

Modifier and Type	Method and Description
java.lang.String	fieldName(ImportedLine line, java.lang.String field, java.lang.String id) Returns the field display name for the given field and id
void	finishImport(IF importedFile) Executes some processing when import has finished
java.util.List<java.lang.String>	getAllowedImportFields(IF importedFile) Returns a list of the allowed fields to be imported
D	getData(IF importedFile) Returns the data associated to an import
java.lang.Class<E>	getEntityClass() Returns the class of the imported entity
java.lang.Class<IF>	getImportedFileClass() Returns the imported file class
ImportType	getImportType() Returns the type of imports handled by this class
java.util.List<java.lang.String>	getKeywordFields() Returns a list of field names that can be used to search for imported lines
java.util.Set<java.lang.String>	getRequiredFields() Return the minimum required fields to make the importation works.
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	newImportedFile(DTO dto) Instantiates an ImportedFile a new entity based on a dto
E	processImportedLine(ImportedLine importedLine, java.lang.Object context) Imports an entity with the information in the imported line and returns the imported entity.
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

fieldName

java.lang.String fieldName(ImportedLine line,
                           java.lang.String field,
                           java.lang.String id)

Returns the field display name for the given field and id

finishImport

void finishImport(IF importedFile)

Executes some processing when import has finished

getAllowedImportFields

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

Returns a list of the allowed fields to be imported

getData

D getData(IF importedFile)

Returns the data associated to an import

getEntityClass

java.lang.Class<E> getEntityClass()

Returns the class of the imported entity

getImportedFileClass

java.lang.Class<IF> getImportedFileClass()

Returns the imported file class

getImportType

ImportType getImportType()

Returns the type of imports handled by this class

getKeywordFields

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

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

getRequiredFields

java.util.Set<java.lang.String> getRequiredFields()

Return the minimum required fields to make the importation works. Implementors MUST never return null or an empty set.

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.

newImportedFile

IF newImportedFile(DTO dto)

Instantiates an ImportedFile a new entity based on a dto

processImportedLine

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

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

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