com.viaoa.object

Class OAObjectSerializer<TYPE>

java.lang.Object

com.viaoa.object.OAObjectSerializer<TYPE>

All Implemented Interfaces:

Serializable

public final class OAObjectSerializer<TYPE>
extends Object
implements Serializable

OAObjectSerializer is used to control object serialization for an OAObject and its reference objects.

OAObject serialization will then call the serializer to determine which reference properties should be included in the serialization.

Note: this is final so that it can not be subclassed, which would cause serialization problems when it tries to recreate with the new subclass instance - remember this is a wrapper that is serialized and transported, then unserialized (trust me, painful lessons here ha) Use setCallback(..) to be able to control each object's setting as it is serialized.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	bReadId
int	dupCount
int	newCount

Constructor Summary

Constructors

Constructor and Description
OAObjectSerializer(TYPE object, boolean bCompress)
OAObjectSerializer(TYPE object, boolean bCompress, boolean bAllReferences) Used to serialize an object.
OAObjectSerializer(TYPE object, boolean bCompress, OAObjectSerializerCallback callback)
OAObjectSerializer(TYPE object, Object extraObject, boolean bCompress, OAObjectSerializerCallback callback)

Method Summary

Modifier and Type	Method and Description
protected void	excludeAllProperties()
void	excludedClasses(Class... classes)
protected void	excludeProperties(String[] props)
OAObjectSerializerCallback	getCallback()
int	getClientId()
long	getCompressedWritten()
Object	getExtraObject()
int	getId()
boolean	getIncludeBlobs() OAObject blob properties default to transient.
int	getLevelsDeep() Number of objects currently being serialized.
int	getMax()
int	getMaxSize()
TYPE	getObject() The object that is being wrapped.
protected Object	getPreviousObject()
Object	getReferenceValueToSend(Object obj)
protected Object	getStackObject(int pos)
protected int	getStackSize()
int	getTotalObjectsWritten()
boolean	hasReachedMax()
protected void	includeAllProperties()
protected void	includeProperties(String[] props)
static void	main(String[] args)
void	setCallback(OAObjectSerializerCallback callback) Used to dynamically determine which objects are serialized.
void	setClientId(int id)
void	setExcludedReferences(Class... classes) Classes that should not be serialized.
void	setExtraObject(Object extraObject)
void	setId(int id)
void	setIncludeBlobs(boolean b)
void	setMax(int max) Max number of objects to serialize.
void	setMaxSize(int maxSize)
protected boolean	shouldSerializeReference(OAObject oaObj, String propertyName, Object obj) Called by OAObjectSerializeDelegate._writeObject() to determine if an object reference property should be included for serialization.
protected boolean	shouldSerializeReference(OAObject oaObj, String propertyName, Object obj, OALinkInfo linkInfo)

Methods inherited from class java.lang.Object

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

Field Detail

bReadId

public static boolean bReadId

newCount

public transient int newCount

dupCount

public transient int dupCount

Constructor Detail

OAObjectSerializer

public OAObjectSerializer(TYPE object,
                          boolean bCompress,
                          OAObjectSerializerCallback callback)

Parameters:

object - root object to serialize

callback - object that will be called (setupProperties(obj)) for each object that will be serialized, used to determine which reference properties to include.

OAObjectSerializer

public OAObjectSerializer(TYPE object,
                          boolean bCompress)

OAObjectSerializer

public OAObjectSerializer(TYPE object,
                          Object extraObject,
                          boolean bCompress,
                          OAObjectSerializerCallback callback)

OAObjectSerializer

public OAObjectSerializer(TYPE object,
                          boolean bCompress,
                          boolean bAllReferences)

Used to serialize an object.

Parameters:

object - root object to serialize.

bCompress - use compression (not needed if the stream is compressed)

bAllReferences - flag to know if all references or no references should be serialized with object. see #setExcludedClasses(Class[]) to include reference classes should not be serialized.

Method Detail

setId

public void setId(int id)

getId

public int getId()

setClientId

public void setClientId(int id)

getClientId

public int getClientId()

getIncludeBlobs

public boolean getIncludeBlobs()

OAObject blob properties default to transient. Setting this to true will have them included.

setIncludeBlobs

public void setIncludeBlobs(boolean b)

setExcludedReferences

public void setExcludedReferences(Class... classes)

Classes that should not be serialized.

excludedClasses

public void excludedClasses(Class... classes)

getReferenceValueToSend

public Object getReferenceValueToSend(Object obj)

setMax

public void setMax(int max)

Max number of objects to serialize.

getMax

public int getMax()

getTotalObjectsWritten

public int getTotalObjectsWritten()

setMaxSize

public void setMaxSize(int maxSize)

getMaxSize

public int getMaxSize()

includeProperties

protected void includeProperties(String[] props)

excludeProperties

protected void excludeProperties(String[] props)

includeAllProperties

protected void includeAllProperties()

excludeAllProperties

protected void excludeAllProperties()

getStackSize

protected int getStackSize()

getPreviousObject

protected Object getPreviousObject()

Returns:

previous object on the stack.

getStackObject

protected Object getStackObject(int pos)

getLevelsDeep

public int getLevelsDeep()

Number of objects currently being serialized. first object is level 0 This is incremented by beforeSerialize() and decremented by afterSerialize()

Returns:

shouldSerializeReference

protected boolean shouldSerializeReference(OAObject oaObj,
                                           String propertyName,
                                           Object obj)

Called by OAObjectSerializeDelegate._writeObject() to determine if an object reference property should be included for serialization. If the levelsDeep is > overflowLimit, then the reference will be added to a list to serialize once the wrapper object is serialized.

shouldSerializeReference

protected boolean shouldSerializeReference(OAObject oaObj,
                                           String propertyName,
                                           Object obj,
                                           OALinkInfo linkInfo)

hasReachedMax

public boolean hasReachedMax()

getCompressedWritten

public long getCompressedWritten()

getObject

public TYPE getObject()

The object that is being wrapped.

getExtraObject

public Object getExtraObject()

setExtraObject

public void setExtraObject(Object extraObject)

setCallback

public void setCallback(OAObjectSerializerCallback callback)

Used to dynamically determine which objects are serialized.

Parameters:

callback -

getCallback

public OAObjectSerializerCallback getCallback()

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception