com.haulmont.cuba.core.app.importexport

Class EntityImportExportServiceBean

java.lang.Object

com.haulmont.cuba.core.app.importexport.EntityImportExportServiceBean

All Implemented Interfaces:

EntityImportExportService

@Service(value="cuba_EntityImportExportService")
public class EntityImportExportServiceBean
extends java.lang.Object
implements EntityImportExportService

Field Summary

Fields

Modifier and Type	Field and Description
protected EntityImportExportAPI	entityImportExport

Fields inherited from interface com.haulmont.cuba.core.app.importexport.EntityImportExportService

NAME

Constructor Summary

Constructors

Constructor and Description
EntityImportExportServiceBean()

Method Summary

Modifier and Type	Method and Description
java.lang.String	exportEntitiesToJSON(java.util.Collection<? extends Entity> entities) Serializes a collection of entities to JSON using EntitySerializationAPI.
java.lang.String	exportEntitiesToJSON(java.util.Collection<? extends Entity> entities, View view) Serializes a collection of entities to JSON using EntitySerializationAPI.
byte[]	exportEntitiesToZIP(java.util.Collection<? extends Entity> entities) Serializes a collection of entities to JSON using EntitySerializationAPI and packs the JSON file into ZIP archive.
byte[]	exportEntitiesToZIP(java.util.Collection<? extends Entity> entities, View view) Serializes a collection of entities to JSON using EntitySerializationAPI and packs the JSON file into ZIP archive.
java.util.Collection<Entity>	importEntities(java.util.Collection<? extends Entity> entities, EntityImportView entityImportView) See EntityImportExportService.importEntities(Collection, EntityImportView, boolean).
java.util.Collection<Entity>	importEntities(java.util.Collection<? extends Entity> entities, EntityImportView importView, boolean validate) Persists entities according to the rules, described by the entityImportView parameter.
java.util.Collection<Entity>	importEntities(java.util.Collection<? extends Entity> entities, EntityImportView importView, boolean validate, boolean optimisticLocking) Persists entities according to the rules, described by the entityImportView parameter.
java.util.Collection<Entity>	importEntitiesFromJSON(java.lang.String json, EntityImportView entityImportView) Deserializes the JSON and persists deserialized entities according to the rules, described by the entityImportView parameter.
java.util.Collection<Entity>	importEntitiesFromZIP(byte[] zipBytes, EntityImportView view) Reads a zip archive that contains a JSON file, deserializes the JSON and persists deserialized entities according to the rules, described by the entityImportView parameter.

Methods inherited from class java.lang.Object

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

Field Detail

entityImportExport

@Inject
protected EntityImportExportAPI entityImportExport

Constructor Detail

EntityImportExportServiceBean

public EntityImportExportServiceBean()

Method Detail

exportEntitiesToZIP

public byte[] exportEntitiesToZIP(java.util.Collection<? extends Entity> entities)

Description copied from interface: EntityImportExportService

Serializes a collection of entities to JSON using EntitySerializationAPI and packs the JSON file into ZIP archive.

Serialization is described in the EntitySerializationAPI#toJson(Collection) method documentation

Specified by:

exportEntitiesToZIP in interface EntityImportExportService

Parameters:

entities - a collection of entities to export

Returns:

a byte array of zipped JSON file

exportEntitiesToZIP

public byte[] exportEntitiesToZIP(java.util.Collection<? extends Entity> entities,
                                  View view)

Description copied from interface: EntityImportExportService

Serializes a collection of entities to JSON using EntitySerializationAPI and packs the JSON file into ZIP archive. Before the serialization entities will be reloaded with the view passed as method parameter.

Serialization is described in the EntitySerializationAPI#toJson(Collection) method documentation

Specified by:

exportEntitiesToZIP in interface EntityImportExportService

Parameters:

entities - a collection of entities to export

view - before serialization to JSON entities will be reloaded with this view

Returns:

a byte array of zipped JSON file

exportEntitiesToJSON

public java.lang.String exportEntitiesToJSON(java.util.Collection<? extends Entity> entities)

Description copied from interface: EntityImportExportService

Serializes a collection of entities to JSON using EntitySerializationAPI.

Serialization is described in the EntitySerializationAPI#toJson(Collection) method documentation

Specified by:

exportEntitiesToJSON in interface EntityImportExportService

Parameters:

entities - a collection of entities to export

Returns:

a JSON string

exportEntitiesToJSON

public java.lang.String exportEntitiesToJSON(java.util.Collection<? extends Entity> entities,
                                             View view)

Description copied from interface: EntityImportExportService

Serializes a collection of entities to JSON using EntitySerializationAPI. Before the serialization entities will be reloaded with the view passed as method parameter.

Serialization is described in the EntitySerializationAPI#toJson(Collection) method documentation

Specified by:

exportEntitiesToJSON in interface EntityImportExportService

Parameters:

entities - a collection of entities to export

view - before serialization to JSON entities will be reloaded with this view

Returns:

a JSON string

importEntitiesFromJSON

public java.util.Collection<Entity> importEntitiesFromJSON(java.lang.String json,
                                                           EntityImportView entityImportView)

Description copied from interface: EntityImportExportService

Deserializes the JSON and persists deserialized entities according to the rules, described by the entityImportView parameter. If the entity is not present in the database, it will be saved. Otherwise the fields of the existing entity that are in the entityImportView will be updated.

Specified by:

importEntitiesFromJSON in interface EntityImportExportService

Parameters:

json - JSON file containing entities

entityImportView - EntityImportView with the rules that describes how entities should be persisted.

Returns:

a collection of entities that have been imported

See Also:

EntityImportView

importEntitiesFromZIP

public java.util.Collection<Entity> importEntitiesFromZIP(byte[] zipBytes,
                                                          EntityImportView view)

Description copied from interface: EntityImportExportService

Reads a zip archive that contains a JSON file, deserializes the JSON and persists deserialized entities according to the rules, described by the entityImportView parameter. If the entity is not present in the database, it will be saved. Otherwise the fields of the existing entity that are in the entityImportView will be updated.

Specified by:

importEntitiesFromZIP in interface EntityImportExportService

Parameters:

zipBytes - byte array of ZIP archive with JSON file

view - EntityImportView with the rules that describes how entities should be persisted.

Returns:

a collection of entities that have been imported

See Also:

EntityImportView

importEntities

public java.util.Collection<Entity> importEntities(java.util.Collection<? extends Entity> entities,
                                                   EntityImportView entityImportView)

Description copied from interface: EntityImportExportService

See EntityImportExportService.importEntities(Collection, EntityImportView, boolean). The current method doesn't perform bean validation

Specified by:

importEntities in interface EntityImportExportService

importEntities

public java.util.Collection<Entity> importEntities(java.util.Collection<? extends Entity> entities,
                                                   EntityImportView importView,
                                                   boolean validate)

Description copied from interface: EntityImportExportService

Persists entities according to the rules, described by the entityImportView parameter. If the entity is not present in the database, it will be saved. Otherwise the fields of the existing entity that are in the entityImportView will be updated.

If the view contains a property for composition attribute then all composition collection members that are absent in the passed entity will be removed.

Specified by:

importEntities in interface EntityImportExportService

importView - EntityImportView with the rules that describes how entities should be persisted.

validate - whether the passed entities should be validated by the BeanValidation mechanism before entities are persisted

Returns:

a collection of entities that have been imported

importEntities

public java.util.Collection<Entity> importEntities(java.util.Collection<? extends Entity> entities,
                                                   EntityImportView importView,
                                                   boolean validate,
                                                   boolean optimisticLocking)

Description copied from interface: EntityImportExportService

Persists entities according to the rules, described by the entityImportView parameter. If the entity is not present in the database, it will be saved. Otherwise the fields of the existing entity that are in the entityImportView will be updated.

If the view contains a property for composition attribute then all composition collection members that are absent in the passed entity will be removed.

Specified by:

importEntities in interface EntityImportExportService

importView - EntityImportView with the rules that describes how entities should be persisted.

validate - whether the passed entities should be validated by the BeanValidation mechanism before entities are persisted

optimisticLocking - whether the passed entities versions should be validated before entities are persisted

Returns:

a collection of entities that have been imported