org.kuali.rice.krad.service.impl

Class SerializerServiceBase

java.lang.Object

org.kuali.rice.krad.service.impl.SerializerServiceBase

All Implemented Interfaces:

SerializerService

Direct Known Subclasses:

BusinessObjectSerializerServiceImpl, DataObjectSerializerServiceImpl, DocumentSerializerServiceImpl

public abstract class SerializerServiceBase
extends Object
implements SerializerService

Default implementation of the DocumentSerializerService. If no <workflowProperties> have been defined in the data dictionary for a document type (i.e. Document.getDocumentPropertySerizabilityEvaluator() returns an instance of AlwaysTruePropertySerializibilityEvaluator), then this service will revert to using the XmlObjectSerializerService bean, which was the old way of serializing a document for routing. If workflowProperties are defined, then this implementation will selectively serialize items.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SerializerServiceBase.AutoPopulatingListConverter
class	SerializerServiceBase.ProxyAndStateAwareJavaReflectionProvider
class	SerializerServiceBase.ProxyConverter

Field Summary

Fields

Modifier and Type	Field and Description
protected ThreadLocal<PropertySerializabilityEvaluator>	evaluators
protected LegacyDataAdapter	legacyDataAdapter
protected ThreadLocal<SerializationState>	serializationStates
protected XmlObjectSerializerService	xmlObjectSerializerService
protected com.thoughtworks.xstream.XStream	xstream

Constructor Summary

Constructors

Constructor and Description
SerializerServiceBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected SerializationState	createNewDocumentSerializationState(Document document)
protected abstract PropertySerializabilityEvaluator	getPropertySerizabilityEvaluator(Object dataObject) Get the appropriate PropertySerializabilityEvaluator for the given dataObject.
protected XmlObjectSerializerService	getXmlObjectSerializerService()
protected boolean	ignoreField(Field field) Method called by the ProxyAndStateAwareJavaReflectionProvider during serialization to determine if a field should be omitted from the serialized form.
String	serializeBusinessObjectToXml(Object businessObject)
void	setLegacyDataAdapter(LegacyDataAdapter legacyDataAdapter)
void	setXmlObjectSerializerService(XmlObjectSerializerService xmlObjectSerializerService)

Methods inherited from class java.lang.Object

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

Field Detail

legacyDataAdapter

protected LegacyDataAdapter legacyDataAdapter

xmlObjectSerializerService

protected XmlObjectSerializerService xmlObjectSerializerService

xstream

protected com.thoughtworks.xstream.XStream xstream

serializationStates

protected ThreadLocal<SerializationState> serializationStates

evaluators

protected ThreadLocal<PropertySerializabilityEvaluator> evaluators

Constructor Detail

SerializerServiceBase

public SerializerServiceBase()

Method Detail

serializeBusinessObjectToXml

public String serializeBusinessObjectToXml(Object businessObject)

See Also:

DocumentSerializerService.serializeDocumentToXmlForRouting(org.kuali.rice.krad.document.Document)

ignoreField

protected boolean ignoreField(Field field)

Method called by the ProxyAndStateAwareJavaReflectionProvider during serialization to determine if a field should be omitted from the serialized form.

This is a short circuit check that will avoid more expensive calls in to the PropertySerializabilityEvaluator if it returns true.

Parameters:

field - the field

Returns:

true if the field should be omitted

getPropertySerizabilityEvaluator

protected abstract PropertySerializabilityEvaluator getPropertySerizabilityEvaluator(Object dataObject)

Get the appropriate PropertySerializabilityEvaluator for the given dataObject.

Parameters:

dataObject - the data object

Returns:

the evaluator

getXmlObjectSerializerService

protected XmlObjectSerializerService getXmlObjectSerializerService()

setXmlObjectSerializerService

public void setXmlObjectSerializerService(XmlObjectSerializerService xmlObjectSerializerService)

createNewDocumentSerializationState

protected SerializationState createNewDocumentSerializationState(Document document)

setLegacyDataAdapter

public void setLegacyDataAdapter(LegacyDataAdapter legacyDataAdapter)