net.sf.joafip.store.service.objectio.serialize.output

Class AbstractObjectOutput

java.lang.Object

net.sf.joafip.store.service.objectio.serialize.output.AbstractObjectOutput

All Implemented Interfaces:

IObjectOutput

Direct Known Subclasses:

AbstractObjectOutputGeneric, AbstractObjectOutputSerialize, ObjectOutputForArray, ObjectOutputForBasic, ObjectOutputForString

@NotStorableClass
public abstract class AbstractObjectOutput
extends Object
implements IObjectOutput

all common for object output in file

Author:

luc peuvrier

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassInfoFactory	classInfoFactory
protected HelperBinaryConversion	helperBinaryConversion
protected static HelperReflect	helperReflect
protected JoafipLogger	logger
protected static ObjectClassInfoAndDeclared[]	NO_SOONS
protected IObjectIOManagerForObjectIO	objectIOManager
protected IProxyManagerForObjectIO	proxyManager2

Constructor Summary

Constructors

Constructor and Description
AbstractObjectOutput(IObjectIOManagerForObjectIO objectIOManager, ClassInfoFactory classInfoFactory, IProxyManagerForObjectIO proxyManager2, HelperBinaryConversion helperBinaryConversion)

Method Summary

Methods

Modifier and Type	Method and Description
int	byteSize(ObjectAndPersistInfo objectAndItsClassInfo, int headerDataSize) compute bytes needs to store an object state for a class it is number of byte to store object state + bytes to store object class identifier
protected int	byteSizeForFieldOrElement(ClassInfo typeInfo)
protected void	computeReferenceChangeList(ObjectAndPersistInfo objectAndPersistInfo)
protected ObjectClassInfoAndDeclared[]	currentValuesToReferencedSoon(ObjectAndPersistInfo objectAndPersistInfo)
IObjectIOManagerForObjectIO	getObjectIOManager()
boolean	isGenericValueChanged(ObjectAndPersistInfo objectAndPersistInfo) test if value changed also compute reference change list
abstract int	numberOfByteForData(ObjectAndPersistInfo objectAndItsClassInfo) obtains the number of bytes need to store object state
void	setGarbageManagement(boolean garbageManagement)
protected void	setReferenceChangeListForGeneric(ObjectAndPersistInfo objectAndItsClassInfo) compute reference change list for new object
ObjectClassInfoAndDeclared[]	willNotBeWrote(ObjectAndPersistInfo objectAndPersistInfo)
protected abstract ObjectClassInfoAndDeclared[]	willNotBeWroteImpl(ObjectAndPersistInfo objectAndPersistInfo)
ObjectClassInfoAndDeclared[]	writeBody(byte[] binary, int bodyBeginOffset, ObjectAndPersistInfo objectAndPersistInfo, boolean updateOriginalValue) write body: body is data after number of link that represent object state
protected abstract ObjectClassInfoAndDeclared[]	writeBodyAndItsHeader(byte[] binary, int bodyBeginOffset, ObjectAndPersistInfo objectAndItsClassInfo, boolean updateOriginalValue)
ObjectClassInfoAndDeclared[]	writeCurrentValue(byte[] binary, int fieldBeginOffset, ObjectAndPersistInfo objectAndPersistInfo, boolean updateOriginalValue)
protected int	writeSignature(byte[] binary, int signatureBeginOffset, ClassInfo classInfo) check signature according off object class
protected int	writeStaticFieldSignature(byte[] binary, int signatureBeginOffset, ClassInfo classInfo)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.joafip.store.service.objectio.serialize.output.IObjectOutput

isValueChanged, prepareWrite, setReferenceChangeListForNewObject

Field Detail

logger

protected final JoafipLogger logger

NO_SOONS

protected static final ObjectClassInfoAndDeclared[] NO_SOONS

classInfoFactory

protected final ClassInfoFactory classInfoFactory

helperBinaryConversion

protected final HelperBinaryConversion helperBinaryConversion

helperReflect

protected static final HelperReflect helperReflect

objectIOManager

protected final IObjectIOManagerForObjectIO objectIOManager

proxyManager2

protected final IProxyManagerForObjectIO proxyManager2

Constructor Detail

AbstractObjectOutput

public AbstractObjectOutput(IObjectIOManagerForObjectIO objectIOManager,
                    ClassInfoFactory classInfoFactory,
                    IProxyManagerForObjectIO proxyManager2,
                    HelperBinaryConversion helperBinaryConversion)

Method Detail

setGarbageManagement

public void setGarbageManagement(boolean garbageManagement)

Specified by:

setGarbageManagement in interface IObjectOutput

getObjectIOManager

public IObjectIOManagerForObjectIO getObjectIOManager()

byteSize

public int byteSize(ObjectAndPersistInfo objectAndItsClassInfo,
           int headerDataSize)
             throws ObjectIOException,
                    ObjectIOInvalidClassException,
                    ObjectIONotSerializableException,
                    ObjectIODataRecordNotFoundException,
                    ObjectIOClassNotFoundException,
                    ObjectIODataCorruptedException

Description copied from interface: IObjectOutput

compute bytes needs to store an object state for a class
it is number of byte to store object state + bytes to store object class identifier

Specified by:

byteSize in interface IObjectOutput

Parameters:

objectAndItsClassInfo - the object

Returns:

byte size for class instance storing

Throws:

ObjectIOException - data to store size error

ObjectIOInvalidClassException

ObjectIONotSerializableException

ObjectIODataRecordNotFoundException

ObjectIOClassNotFoundException

ObjectIODataCorruptedException

numberOfByteForData

public abstract int numberOfByteForData(ObjectAndPersistInfo objectAndItsClassInfo)
                                 throws ObjectIOException,
                                        ObjectIOInvalidClassException,
                                        ObjectIONotSerializableException,
                                        ObjectIODataRecordNotFoundException,
                                        ObjectIOClassNotFoundException,
                                        ObjectIODataCorruptedException

obtains the number of bytes need to store object state

Parameters:

objectAndItsClassInfo - the object

Returns:

number of bytes need to store object state ( persistable data fields )

Throws:

ObjectIOException

ObjectIONotSerializableException

ObjectIOInvalidClassException

ObjectIODataCorruptedException

ObjectIOClassNotFoundException

ObjectIODataRecordNotFoundException

writeBody

public ObjectClassInfoAndDeclared[] writeBody(byte[] binary,
                                     int bodyBeginOffset,
                                     ObjectAndPersistInfo objectAndPersistInfo,
                                     boolean updateOriginalValue)
                                       throws ObjectIOException,
                                              ObjectIOInvalidClassException,
                                              ObjectIONotSerializableException,
                                              ObjectIODataCorruptedException

Description copied from interface: IObjectOutput

write body: body is data after number of link that represent object state

Specified by:

writeBody in interface IObjectOutput

Parameters:

binary - binary data of data record associated to object

bodyBeginOffset - offset in binary data of begin of body, it is the header data size

objectAndPersistInfo - the object which for state is to write

updateOriginalValue - true if set original value to current value ( true only when serialization is done to update heap file )

Returns:

son object referenced in wrote data record

Throws:

ObjectIOException

ObjectIOInvalidClassException

ObjectIONotSerializableException

ObjectIODataCorruptedException

willNotBeWrote

public ObjectClassInfoAndDeclared[] willNotBeWrote(ObjectAndPersistInfo objectAndPersistInfo)
                                            throws ObjectIOException

Specified by:

willNotBeWrote in interface IObjectOutput

Parameters:

objectAndPersistInfo - the object which for state will not be wrote

Returns:

soon object referenced if was wrote

Throws:

ObjectIOException

willNotBeWroteImpl

protected abstract ObjectClassInfoAndDeclared[] willNotBeWroteImpl(ObjectAndPersistInfo objectAndPersistInfo)
                                                            throws ObjectIOException

Throws:

ObjectIOException

writeBodyAndItsHeader

protected abstract ObjectClassInfoAndDeclared[] writeBodyAndItsHeader(byte[] binary,
                                                 int bodyBeginOffset,
                                                 ObjectAndPersistInfo objectAndItsClassInfo,
                                                 boolean updateOriginalValue)
                                                               throws ObjectIOException,
                                                                      ObjectIODataCorruptedException,
                                                                      ObjectIOInvalidClassException,
                                                                      ObjectIONotSerializableException

Parameters:

binary - binary data of data record associated to object

bodyBeginOffset - offset in binary data of begin of body

objectAndItsClassInfo - the object which for state is to write

updateOriginalValue - true if set original value to current value ( true only when serialization is done to update heap file )

Returns:

son object referenced in wrote data record

Throws:

ObjectIOException

ObjectIODataCorruptedException

ObjectIOInvalidClassException

ObjectIONotSerializableException

byteSizeForFieldOrElement

protected int byteSizeForFieldOrElement(ClassInfo typeInfo)

Parameters:

typeInfo - the field type or component type

Returns:

number of bytes needed to store a type

writeSignature

protected int writeSignature(byte[] binary,
                 int signatureBeginOffset,
                 ClassInfo classInfo)
                      throws ObjectIOException

check signature according off object class

Parameters:

binary - binary data to write to

signatureBeginOffset - signature offset in binary data

classInfo - class information of object used for signature

Returns:

offset after signature

Throws:

ObjectIOException

writeStaticFieldSignature

protected int writeStaticFieldSignature(byte[] binary,
                            int signatureBeginOffset,
                            ClassInfo classInfo)
                                 throws ObjectIOException

Throws:

ObjectIOException

writeCurrentValue

public ObjectClassInfoAndDeclared[] writeCurrentValue(byte[] binary,
                                             int fieldBeginOffset,
                                             ObjectAndPersistInfo objectAndPersistInfo,
                                             boolean updateOriginalValue)
                                               throws ObjectIOException,
                                                      ObjectIODataCorruptedException

Parameters:

binary - binary data of data record associated to object

fieldBeginOffset - offset in binary data of begin of body

objectAndPersistInfo - the object which for state is to write

updateOriginalValue - true if set original value to current value ( true only when serialization is done to update heap file )

Returns:

son object referenced in wrote data record

Throws:

ObjectIOException

ObjectIODataCorruptedException

isGenericValueChanged

public boolean isGenericValueChanged(ObjectAndPersistInfo objectAndPersistInfo)
                              throws ObjectIOException

test if value changed
also compute reference change list

Parameters:

objectAndPersistInfo -

Returns:

true if value changed

Throws:

ObjectIOException

computeReferenceChangeList

protected void computeReferenceChangeList(ObjectAndPersistInfo objectAndPersistInfo)
                                   throws ObjectIOException

Throws:

ObjectIOException

setReferenceChangeListForGeneric

protected void setReferenceChangeListForGeneric(ObjectAndPersistInfo objectAndItsClassInfo)
                                         throws ObjectIOException

compute reference change list for new object

Parameters:

objectAndItsClassInfo -

Throws:

ObjectIOException

currentValuesToReferencedSoon

protected ObjectClassInfoAndDeclared[] currentValuesToReferencedSoon(ObjectAndPersistInfo objectAndPersistInfo)
                                                              throws ObjectIOException

Throws:

ObjectIOException