net.sf.joafip.store.service.export_import.in

Class AbstractImporter

java.lang.Object

net.sf.joafip.store.service.export_import.in.AbstractImporter

All Implemented Interfaces:

IImporter

Direct Known Subclasses:

XmlImporter

@NotStorableClass
public abstract class AbstractImporter
extends Object
implements IImporter

commons operations and data for importation

Author:

luc peuvrier

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassLoaderProvider	classLoaderProvider
protected JoafipLogger	logger

Constructor Summary

Constructors

Constructor and Description
AbstractImporter(IStore store)

Method Summary

Methods

Modifier and Type	Method and Description
protected ClassDef	classDefForClass(Class<?> clazz)
protected ClassDef	classForName(String className)
protected ClassDef	classReplacementDef(ClassInfo classInfo)
protected ValuedFieldList	convert(ValuedFieldList valuedFieldList, Deque<ClassReplacementDef> replacementDef, FieldInfo[] fieldInfos)
Object	createArray(Class<?> componentClass, int objectIdentifier, int size) create an array instance
ObjectModelForImport	createArray(ClassDef componentClassDef, DataRecordIdentifier dataRecordIdentifier, int arraySize) create an array instance
ObjectModelForImport	createBasicValue(ClassDef classDef, String value, boolean createDataRecordIdentifierIfNeeded) create a basic object value ( primitive or class associated to primitive type )
protected DataRecordIdentifier	createDataRecordIdentifierAssociatedToObject(Object object) allocate a new data record identifier for an object
ObjectModelForImport	createDummyValueObject(ClassDef classDef, DataRecordIdentifier dataRecordIdentifier) create a dummy object for specified argument class, class can be abstract or interface
Object	createEnum(ClassDef classDef, int objectIdentifier, String constantName) create enum object instance.
ObjectModelForImport	createEnum(DataRecordIdentifier dataRecordIdentifier, ClassDef classDef, String constantName) create enum object instance.
Object	createObject(ClassDef classDef, int objectIdentifier) create object instance, construction in memory without calling constructor
ObjectModelForImport	createObject(DataRecordIdentifier dataRecordIdentifier, ClassDef classDef) Create object instance, construction in memory without calling constructor.
ObjectModelForImport	createRootObject()
Object	createString(DataRecordIdentifier dataRecordIdentifier, String string)
ObjectModelForImport	createString(int objectIdentifier, String string)
void	doImport(String directoryName, boolean validating) import from exported data in directoryName directory
ClassInfoFactory	getClassInfoFactory()
protected ClassDef	getClassReplacementDef(Class<?> clazz)
Object	getObject(int objectIdentifier)
int	getPreviousDataModelIdentifier()
int	getPreviousRelesase()
protected abstract void	importImpl(File directory, boolean validating) specific implementation of import from exported data in directoryName directory
protected boolean	isBasicClass(Class<?> clazz) test is class is basic class ( primitive or class associated to primitive )
DataRecordIdentifier	newDataRecordIdentifier(String value)
void	recordObject(Object object)
void	recordObject(Object object, boolean stateSet, ClassInfo classInfo, ValuedFieldList valuedFieldList) record objects
void	setArrayElement(ObjectModelForImport arrayObjectModel, int index, Object elementValue)
protected ObjectAndPersistInfo	setDataRecordIdentifierAssociatedToObject(Object object, DataRecordIdentifier dataRecordIdentifier) set the data record identifier of an object
protected void	setLastRecordId(long lastRecordId) to set last data record identifier from import data
void	setListener(IImportListener listener)
void	setObjectState(Object object, ClassInfo classInfo, ValuedFieldList valuedFieldList)
protected void	setReleaseAndDataModelIdentifier(String previousReleaseName, int previousDataModelIdentifier)

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

classLoaderProvider

protected final ClassLoaderProvider classLoaderProvider

Constructor Detail

AbstractImporter

public AbstractImporter(IStore store)
                 throws ImportException

Throws:

ImportException

Method Detail

setListener

public void setListener(IImportListener listener)

Specified by:

setListener in interface IImporter

getClassInfoFactory

public ClassInfoFactory getClassInfoFactory()

doImport

public void doImport(String directoryName,
            boolean validating)
              throws ImportException,
                     ImportClassNotFoundException,
                     ImportDataCorruptedException,
                     ImportInvalidClassException,
                     ImportNotSerializableException

Description copied from interface: IImporter

import from exported data in directoryName directory


Specified by:

doImport in interface IImporter

Parameters:

directoryName - directory name where are stored exported data to import

Throws:

ImportException

ImportClassNotFoundException

ImportDataCorruptedException

ImportInvalidClassException

ImportNotSerializableException

importImpl

protected abstract void importImpl(File directory,
              boolean validating)
                            throws ImportException,
                                   ImportClassNotFoundException,
                                   ImportDataCorruptedException,
                                   ImportInvalidClassException,
                                   ImportNotSerializableException

specific implementation of import from exported data in directoryName directory


Parameters:

directoryName - directory name where are stored exported data to import

validating - true if validating according to joafip.xsd

Throws:

ImportException

ImportClassNotFoundException

ImportDataCorruptedException

ImportInvalidClassException

ImportNotSerializableException

setReleaseAndDataModelIdentifier

protected void setReleaseAndDataModelIdentifier(String previousReleaseName,
                                    int previousDataModelIdentifier)
                                         throws ImportException

Throws:

ImportException

getPreviousDataModelIdentifier

public int getPreviousDataModelIdentifier()

getPreviousRelesase

public int getPreviousRelesase()

setLastRecordId

protected void setLastRecordId(long lastRecordId)
                        throws ImportException

to set last data record identifier from import data

Parameters:

lastRecordId -

Throws:

StoreException

ImportException

createRootObject

public ObjectModelForImport createRootObject()
                                      throws ImportException

Throws:

ImportException

createDummyValueObject

public ObjectModelForImport createDummyValueObject(ClassDef classDef,
                                          DataRecordIdentifier dataRecordIdentifier)
                                            throws ImportException

create a dummy object for specified argument class, class can be abstract or interface

Parameters:

classDef - the class definition of class which for an object is to be created

dataRecordIdentifier - the data record identifier to associate to this object

Returns:

the created dummy object

Throws:

ImportException

createObject

public ObjectModelForImport createObject(DataRecordIdentifier dataRecordIdentifier,
                                ClassDef classDef)
                                  throws ImportException

Create object instance, construction in memory without calling constructor. May be a NullMarker instance if class does not exist

Parameters:

dataRecordIdentifier - data record identifier of the object

classDef - the object class definition

Returns:

the created object

Throws:

ImportException

createObject

public Object createObject(ClassDef classDef,
                  int objectIdentifier)
                    throws ImportException

create object instance, construction in memory without calling constructor

Parameters:

classDef - the object class definition

objectIdentifier - the object identifier of this object

Returns:

the created object

Throws:

ImportException

getObject

public Object getObject(int objectIdentifier)

createEnum

public ObjectModelForImport createEnum(DataRecordIdentifier dataRecordIdentifier,
                              ClassDef classDef,
                              String constantName)
                                throws ImportException,
                                       ImportInvalidClassException

create enum object instance.

Parameters:

dataRecordIdentifier -

classDef -

constantName -

Returns:

the created enum

Throws:

ImportException

ImportInvalidClassException

createEnum

public Object createEnum(ClassDef classDef,
                int objectIdentifier,
                String constantName)
                  throws ImportException

create enum object instance.

Parameters:

classDef - the enum object class definition

objectIdentifier - the object identifier of this enum object

constantName -

Returns:

the created enum

Throws:

ImportException

createArray

public ObjectModelForImport createArray(ClassDef componentClassDef,
                               DataRecordIdentifier dataRecordIdentifier,
                               int arraySize)
                                 throws ImportException

create an array instance

Parameters:

componentClassDef - the array component class definition

dataRecordIdentifier - the data record identifier to associate to this array

arraySize - the array number of elements

Returns:

the created array

Throws:

ImportException

createArray

public Object createArray(Class<?> componentClass,
                 int objectIdentifier,
                 int size)
                   throws ImportException

create an array instance

Parameters:

componentClass - the array component class

objectIdentifier - the identifier of this array

size - the array number of elements

Returns:

the created array

Throws:

ImportException

createString

public Object createString(DataRecordIdentifier dataRecordIdentifier,
                  String string)
                    throws ImportException

Parameters:

dataRecordIdentifier - the data record identifier to associate to this string

string - the string

Returns:

the string argument

Throws:

ImportException

createString

public ObjectModelForImport createString(int objectIdentifier,
                                String string)
                                  throws ImportException

Parameters:

objectIdentifier - the identifier of this string

string - the string

Returns:

the string argument

Throws:

ImportException

createBasicValue

public ObjectModelForImport createBasicValue(ClassDef classDef,
                                    String value,
                                    boolean createDataRecordIdentifierIfNeeded)
                                      throws ImportException,
                                             ImportDataCorruptedException,
                                             ImportInvalidClassException,
                                             ImportNotSerializableException,
                                             ImportClassNotFoundException

create a basic object value ( primitive or class associated to primitive type )

Parameters:

valueClass - the class of the value

value - the value

createDataRecordIdentifierIfNeeded - if true and a not primitive created then associate a data record identifier to instance created

Returns:

the resulting object

Throws:

ImportException

ImportClassNotFoundException

ImportNotSerializableException

ImportInvalidClassException

ImportDataCorruptedException

createDataRecordIdentifierAssociatedToObject

protected DataRecordIdentifier createDataRecordIdentifierAssociatedToObject(Object object)
                                                                     throws ImportException

allocate a new data record identifier for an object

Parameters:

object - the object that need to be associated to a new data record identifier

Returns:

Throws:

ImportException

setDataRecordIdentifierAssociatedToObject

protected ObjectAndPersistInfo setDataRecordIdentifierAssociatedToObject(Object object,
                                                             DataRecordIdentifier dataRecordIdentifier)
                                                                  throws ImportException

set the data record identifier of an object

Parameters:

object - the object

dataRecordIdentifier - the object data record identifier

Returns:

Throws:

ImportException

setArrayElement

public void setArrayElement(ObjectModelForImport arrayObjectModel,
                   int index,
                   Object elementValue)
                     throws ImportException

Throws:

ImportException

isBasicClass

protected boolean isBasicClass(Class<?> clazz)
                        throws ImportException

test is class is basic class ( primitive or class associated to primitive )

Parameters:

clazz - the class

Returns:

true if basic class

Throws:

ImportException

convert

protected ValuedFieldList convert(ValuedFieldList valuedFieldList,
                      Deque<ClassReplacementDef> replacementDef,
                      FieldInfo[] fieldInfos)
                           throws ImportException

Throws:

ImportException

recordObject

public void recordObject(Object object,
                boolean stateSet,
                ClassInfo classInfo,
                ValuedFieldList valuedFieldList)
                  throws ImportException,
                         ImportDataCorruptedException,
                         ImportInvalidClassException,
                         ImportNotSerializableException,
                         ImportClassNotFoundException,
                         ImportTooBigForSerializationException

record objects

Parameters:

object -

stateSet -

classInfo -

valuedFieldList -

Throws:

ImportException

ImportClassNotFoundException

ImportNotSerializableException

ImportInvalidClassException

ImportDataCorruptedException

ImportTooBigForSerializationException

StoreTooBigForSerializationException

setObjectState

public void setObjectState(Object object,
                  ClassInfo classInfo,
                  ValuedFieldList valuedFieldList)
                    throws ImportException

Throws:

ImportException

recordObject

public void recordObject(Object object)
                  throws ImportException,
                         ImportDataCorruptedException,
                         ImportInvalidClassException,
                         ImportNotSerializableException,
                         ImportClassNotFoundException,
                         ImportTooBigForSerializationException

Throws:

ImportException

ImportDataCorruptedException

ImportInvalidClassException

ImportNotSerializableException

ImportClassNotFoundException

ImportTooBigForSerializationException

getClassReplacementDef

protected ClassDef getClassReplacementDef(Class<?> clazz)
                                   throws ImportException

Throws:

ImportException

classForName

protected ClassDef classForName(String className)
                         throws ImportException,
                                ImportClassNotFoundException

Parameters:

className - the class name

Returns:

class replacement definition for the class name

Throws:

ImportException

ImportClassNotFoundException

classReplacementDef

protected ClassDef classReplacementDef(ClassInfo classInfo)
                                throws ClassInfoException

Throws:

ClassInfoException

classDefForClass

protected final ClassDef classDefForClass(Class<?> clazz)
                                   throws ImportException

Throws:

ImportException

newDataRecordIdentifier

public DataRecordIdentifier newDataRecordIdentifier(String value)
                                             throws ImportException

Parameters:

value - text form of data record identifier, may be null

Returns:

data record identifier for the value, null if value is null

Throws:

ImportException