net.sf.joafip.store.service.export_import.out

Class AbstractExporter

java.lang.Object

net.sf.joafip.store.service.export_import.out.AbstractExporter

All Implemented Interfaces:

IExporter

Direct Known Subclasses:

XmlExporter

@NotStorableClass
public abstract class AbstractExporter
extends Object
implements IExporter

Author:

luc peuvrier

Field Summary

Fields

Modifier and Type	Field and Description
protected JoafipLogger	logger

Constructor Summary

Constructors

Constructor and Description
AbstractExporter(IStore store)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	basicValueToString(Object basicValue) convert basic value to string ( primitives and correspond java.lang class )
protected abstract void	beginExportArray(DataRecordIdentifier arrayDataRecordIdentifier, int arrayLength, ClassInfo arrayComponentClassInfo) begin of array export
protected abstract void	beginExportArrayNotPersisted(int arrayIdentifier, int arrayLength, ClassInfo arrayComponentClassInfo)
protected abstract void	beginExportEnum(DataRecordIdentifier enumDataRecordIdentifier, ClassInfo enumClassInfo, Enum<?> enumInstance) begin enum export
protected abstract void	beginExportEnumNotPersisted(int enumIdentifier, ClassInfo enumClassInfo, Enum<?> enumInstance)
protected abstract void	beginExportField(String fieldClassName, String fieldName, String fieldDeclaringClassName, boolean staticField, boolean transientField) begin of an object field export
protected abstract void	beginExportGeneric(DataRecordIdentifier objectDataRecordIdentifier, ClassInfo objectClassInfo) begin generic object export
protected abstract void	beginExportNotPersistedGeneric(int objectIdentifier, ClassInfo objectClassInfo) begin generic not persisted object export
protected abstract void	beginExportRoot() begin of root export
protected abstract void	beginExportStatic(DataRecordIdentifier objectDataRecordIdentifier, ClassInfo objectClassInfo)
protected abstract void	beginExportStaticField()
protected abstract void	beginExportVisit(String joafipRelease, int dataModelIdentifier, long lastRecordId) begin of the visit for export
protected abstract void	close() close export
protected abstract void	closeWriterAfterError() close export after an error
protected abstract void	endExportArray() end of array export
protected abstract void	endExportArrayNotPersisted()
protected abstract void	endExportEnum() end enum export
protected abstract void	endExportEnumNotPersisted()
protected abstract void	endExportField() end of object field export
protected abstract void	endExportGeneric() end of generic object export
protected abstract void	endExportNotPersistedGeneric() end of generic not persisted object export
protected abstract void	endExportRoot() end of root export
protected abstract void	endExportStatic()
protected abstract void	endExportStaticField()
protected abstract void	endExportVisit() end visit for export
void	export(String directoryName, String temporaryDirectoryName, boolean exportPersistedClassByteCode) FIXMELUC x generic export or xml export ?
void	export(String directoryName, String temporaryDirectoryName, Object objectToExport)
protected abstract void	exportBasicValue(Object value) export a basic value
protected abstract void	exportNotPersistedReference(int objectIdentifier) export reference to not persisted object
protected abstract void	exportNullReference() export null reference
protected abstract void	exportReference(DataRecordIdentifier dataRecordIdentifier) export not null reference
protected abstract void	exportString(DataRecordIdentifier dataRecordIdentifier, String string) export string
protected abstract void	exportString(int objectIdentifier, String string) export not persisted string
int	getNumberOfObjectExported()
protected abstract void	open(File directory) opening for export
void	setListener(IExporterListener listener)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final JoafipLogger logger

Constructor Detail

AbstractExporter

public AbstractExporter(IStore store)
                 throws StoreException

Throws:

StoreException

Method Detail

setListener

public void setListener(IExporterListener listener)

Specified by:

setListener in interface IExporter

export

public void export(String directoryName,
          String temporaryDirectoryName,
          boolean exportPersistedClassByteCode)
            throws StoreException,
                   StoreClassNotFoundException,
                   StoreInvalidClassException,
                   StoreDataCorruptedException,
                   StoreNotSerializableException,
                   StoreTooBigForSerializationException

Description copied from interface: IExporter

FIXMELUC x generic export or xml export ?
export persisted data in file export.xml put in directoryName directory
also export byte code of class of persisted object


Specified by:

export in interface IExporter

Parameters:

directoryName - directory name where store export

temporaryDirectoryName - temporary directory name used to store temporary files while exporting

exportPersistedClassByteCode - true if export persisted class byte code

Throws:

StoreException

StoreClassNotFoundException

StoreInvalidClassException

StoreDataCorruptedException

StoreNotSerializableException

StoreTooBigForSerializationException

export

public void export(String directoryName,
          String temporaryDirectoryName,
          Object objectToExport)
            throws StoreException,
                   StoreClassNotFoundException,
                   StoreInvalidClassException,
                   StoreDataCorruptedException,
                   StoreNotSerializableException

Specified by:

export in interface IExporter

Throws:

StoreException

StoreClassNotFoundException

StoreInvalidClassException

StoreDataCorruptedException

StoreNotSerializableException

open

protected abstract void open(File directory)
                      throws StoreException

opening for export

Parameters:

directory -

Throws:

StoreException

close

protected abstract void close()
                       throws StoreException

close export

Throws:

StoreException

closeWriterAfterError

protected abstract void closeWriterAfterError()

close export after an error

getNumberOfObjectExported

public int getNumberOfObjectExported()

Specified by:

getNumberOfObjectExported in interface IExporter

exportNotPersistedReference

protected abstract void exportNotPersistedReference(int objectIdentifier)
                                             throws StoreException

export reference to not persisted object

Parameters:

objectIdentifier - the not persisted object identifier

Throws:

StoreException

beginExportVisit

protected abstract void beginExportVisit(String joafipRelease,
                    int dataModelIdentifier,
                    long lastRecordId)
                                  throws StoreException

begin of the visit for export

Parameters:

joafipRelease -

dataModelIdentifier -

lastRecordId -

Throws:

StoreException

endExportVisit

protected abstract void endExportVisit()
                                throws StoreException

end visit for export

Throws:

StoreException

beginExportRoot

protected abstract void beginExportRoot()
                                 throws StoreException

begin of root export

Throws:

StoreException

endExportRoot

protected abstract void endExportRoot()
                               throws StoreException

end of root export

Throws:

StoreException

beginExportStaticField

protected abstract void beginExportStaticField()
                                        throws StoreException

Throws:

StoreException

endExportStaticField

protected abstract void endExportStaticField()
                                      throws StoreException

Throws:

StoreException

exportString

protected abstract void exportString(DataRecordIdentifier dataRecordIdentifier,
                String string)
                              throws StoreException

export string

Parameters:

dataRecordIdentifier -

string - the string instance

Throws:

StoreException

exportString

protected abstract void exportString(int objectIdentifier,
                String string)
                              throws StoreException

export not persisted string

Parameters:

objectIdentifier -

string - the string instance

Throws:

StoreException

beginExportStatic

protected abstract void beginExportStatic(DataRecordIdentifier objectDataRecordIdentifier,
                     ClassInfo objectClassInfo)
                                   throws StoreException

Throws:

StoreException

endExportStatic

protected abstract void endExportStatic()
                                 throws StoreException

Throws:

StoreException

beginExportGeneric

protected abstract void beginExportGeneric(DataRecordIdentifier objectDataRecordIdentifier,
                      ClassInfo objectClassInfo)
                                    throws StoreException

begin generic object export

Parameters:

objectDataRecordIdentifier - the object data record identifier

objectClassInfo - the object class information

Throws:

StoreException

beginExportNotPersistedGeneric

protected abstract void beginExportNotPersistedGeneric(int objectIdentifier,
                                  ClassInfo objectClassInfo)
                                                throws StoreException

begin generic not persisted object export

Parameters:

objectIdentifier - the object data record identifier

objectClassInfo - the object class information

Throws:

StoreException

endExportGeneric

protected abstract void endExportGeneric()
                                  throws StoreException

end of generic object export

Throws:

StoreException

endExportNotPersistedGeneric

protected abstract void endExportNotPersistedGeneric()
                                              throws StoreException

end of generic not persisted object export

Throws:

StoreException

beginExportField

protected abstract void beginExportField(String fieldClassName,
                    String fieldName,
                    String fieldDeclaringClassName,
                    boolean staticField,
                    boolean transientField)
                                  throws StoreException

begin of an object field export

Parameters:

fieldClassName - the field class name

fieldName - the field name

fieldDeclaringClassName - the field declaring class name

staticField -

transientField -

Throws:

StoreException

endExportField

protected abstract void endExportField()
                                throws StoreException

end of object field export

Throws:

StoreException

exportBasicValue

protected abstract void exportBasicValue(Object value)
                                  throws StoreException

export a basic value

Parameters:

value - the value to export

Throws:

StoreException

exportNullReference

protected abstract void exportNullReference()
                                     throws StoreException

export null reference

Throws:

StoreException

exportReference

protected abstract void exportReference(DataRecordIdentifier dataRecordIdentifier)
                                 throws StoreException

export not null reference

Parameters:

dataRecordIdentifier - the data record identifier as reference

Throws:

StoreException

beginExportArray

protected abstract void beginExportArray(DataRecordIdentifier arrayDataRecordIdentifier,
                    int arrayLength,
                    ClassInfo arrayComponentClassInfo)
                                  throws StoreException

begin of array export

Parameters:

arrayDataRecordIdentifier - the array instance data record identifier

arrayLength - the array length

arrayComponentClassInfo - the array component class information

Throws:

StoreException

endExportArrayNotPersisted

protected abstract void endExportArrayNotPersisted()
                                            throws StoreException

Throws:

StoreException

endExportArray

protected abstract void endExportArray()
                                throws StoreException

end of array export

Throws:

StoreException

beginExportArrayNotPersisted

protected abstract void beginExportArrayNotPersisted(int arrayIdentifier,
                                int arrayLength,
                                ClassInfo arrayComponentClassInfo)
                                              throws StoreException

Throws:

StoreException

beginExportEnum

protected abstract void beginExportEnum(DataRecordIdentifier enumDataRecordIdentifier,
                   ClassInfo enumClassInfo,
                   Enum<?> enumInstance)
                                 throws StoreException

begin enum export

Parameters:

enumDataRecordIdentifier - the enum instance data record identifier

enumClassInfo - the enum class information

enumInstance - the enum

Throws:

StoreException

beginExportEnumNotPersisted

protected abstract void beginExportEnumNotPersisted(int enumIdentifier,
                               ClassInfo enumClassInfo,
                               Enum<?> enumInstance)
                                             throws StoreException

Throws:

StoreException

endExportEnum

protected abstract void endExportEnum()
                               throws StoreException

end enum export

Throws:

StoreException

endExportEnumNotPersisted

protected abstract void endExportEnumNotPersisted()
                                           throws StoreException

Throws:

StoreException

basicValueToString

protected String basicValueToString(Object basicValue)
                             throws StoreException

convert basic value to string ( primitives and correspond java.lang class )

Parameters:

basicValue -

Returns:

value in string form

Throws:

StoreException