com.groiss.store
Interface Exportable

All Superinterfaces:

Persistent

All Known Implementing Classes:

DirectoryServer, ExportablePersistentObject

public interface Exportable
extends Persistent

Classes that want to provide the possibility of being exported/imported by the import/export functionality of @enterprise must implement this interface.

Since:

@enterprise 6.3

Field Summary

static String[][]

emptyKeys Empty String array which can be used by classes which don't want to define keys.

Method Summary

void	beforeImport(Map<String,Persistent> values) This method is called by the importer after the object is filled with data.
List<Field>	exportFields() Here a class can return the names of fields which should be exported during an @enterprise export.
List<Exportable>	getAdditionalObjects(boolean isReference) return a list of objects that must be exported with this object (after it).
String[][]	getKeys() A class has to return key groups in order to identify already existing objects of that class.
List<Exportable>	getRequiredObjects(boolean isReference) This method is called by the exporter before an object is exported.
List<Exportable>	getRequiredReferences() Returns a list of references that cannot be found in the persistent fields.

Methods inherited from interface com.groiss.store.Persistent

dbFields, getOid, getStore, getTableName, isFilled, onDelete, onInsert, onRead, onUpdate, setFilled, setOid, setStore

Field Detail

emptyKeys

static final String[][] emptyKeys

Empty String array which can be used by classes which don't want to define keys.

Method Detail

getKeys

String[][] getKeys()

A class has to return key groups in order to identify already existing objects of that class. A key group must uniquely identify an object. This method returns an array of arrays, because a class can have more than one key group. In that case each of the key groups must be unique for an object to be unique (thus, group1 matches OR group2 matches etc.).

Returns:

An array of arrays containing object field names of the fields which form key groups for uniquely identifying objects of classes implementing this interface. An example would be {{"name", "birthdate"}} for a class defining one key group containing the fields name and birthdate.

exportFields

List<Field> exportFields()
                         throws Exception

Here a class can return the names of fields which should be exported during an @enterprise export.

Returns:

A list containing the fields for export.

Throws:

Exception

getRequiredObjects

List<Exportable> getRequiredObjects(boolean isReference)
                                    throws Exception

This method is called by the exporter before an object is exported. The object can add required objects.

Parameters:

isReference - is this a reference to an exported object

Returns:

preReqObjects List containing required objects. Required objects must be Persistent objects implementing the Exportable interface.

Throws:

Exception

getRequiredReferences

List<Exportable> getRequiredReferences()
                                       throws Exception

Returns a list of references that cannot be found in the persistent fields.

Returns:

a list of exportable

Throws:

Exception

getAdditionalObjects

List<Exportable> getAdditionalObjects(boolean isReference)
                                      throws Exception

return a list of objects that must be exported with this object (after it).

Parameters:

isReference - is this a reference to an exported object

Throws:

Exception

beforeImport

void beforeImport(Map<String,Persistent> values)

This method is called by the importer after the object is filled with data. The object can change itself

Parameters:

values - contains a map of the object identifier (classname:oid) to the new objects.