alma.acs.entityutil

Class EntitySerializer

java.lang.Object

alma.acs.entityutil.EntitySerializer

public class EntitySerializer
extends java.lang.Object

Serializes entity objects. These are instances of binding classes that represent the XML data in a type-safe Java API. Currently all binding classes are generated using the Castor tool.

Author:

hsommer May 6, 2003 5:31:48 PM

Method Summary

Modifier and Type	Method and Description
protected Marshaller	createMarshaller(java.io.StringWriter wr)
static EntitySerializer	getEntitySerializer(java.util.logging.Logger logger) Singleton accessor.
XmlEntityStruct	serializeEntity(java.lang.Object entityObject) Marshals an entity object to the CORBA struct used for transport.
XmlEntityStruct	serializeEntity(java.lang.Object entityObject, EntityT entityMeta) Marshals an entity object to the CORBA struct used for transport.
java.lang.String	serializeEntityPart(java.lang.Object entityPart) Serializes a binding class object which is a part (child node) of some other full Entity object.
void	setVerbose(boolean verbose)
void	setXmlEntityFactory(XmlEntityStructFactory esf) Makes this EntitySerializer use a client-supplied factory for XmlEntityStruct objects.

Methods inherited from class java.lang.Object

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

Method Detail

getEntitySerializer

public static EntitySerializer getEntitySerializer(java.util.logging.Logger logger)

Singleton accessor.

Parameters:

logger - Logger to be used (may be null in subsequent invocations since only one instance of EntitySerializer is constructed and then reused)

Returns:

single instance

setXmlEntityFactory

public void setXmlEntityFactory(XmlEntityStructFactory esf)

Makes this EntitySerializer use a client-supplied factory for XmlEntityStruct objects.

You should use this method if you wish to get a subclass of alma.xmlentity.XmlEntityStruct returned from the serializeEntity methods.

Parameters:

esf - the factory to be used

serializeEntity

public XmlEntityStruct serializeEntity(java.lang.Object entityObject,
                                       EntityT entityMeta)
                                throws EntityException

Marshals an entity object to the CORBA struct used for transport.

Parameters:

entityObject - the entity object as a binding class, currently generated by castor.

entityMeta - usually subtype of EntityT.

Returns:

the struct that contains the stringified xml and some other data; null if entityObject is null.

Throws:

EntityException

serializeEntity

public XmlEntityStruct serializeEntity(java.lang.Object entityObject)
                                throws EntityException

Marshals an entity object to the CORBA struct used for transport. Unlike in serializeEntity(Object, EntityT), the child of type EntityT that has the administrational information about the entity object, is not given as a parameter. It will be accessed dynamically using EntityTFinder, which makes this method slightly slower than its 2-parameter companion. It's meant to be used rather by generic code that doesn't know about particular entity classes.

Parameters:

entityObject - the entity object as a binding class

Returns:

the struct that contains the stringified xml and some other data; null if entityObject is null.

Throws:

EntityException

serializeEntityPart

public java.lang.String serializeEntityPart(java.lang.Object entityPart)
                                     throws EntityException

Serializes a binding class object which is a part (child node) of some other full Entity object.

Parameters:

entityPart - the binding object, e.g. of type alma.entity.xmlbinding.schedblock.CorrelatorConfigT.

Returns:

a plain XML String that represents the data of entityPart.

Throws:

EntityException - if the operation could not be performed

See Also:

serializeEntity(Object), serializeEntity(Object, EntityT)

createMarshaller

protected Marshaller createMarshaller(java.io.StringWriter wr)
                               throws java.io.IOException

Throws:

java.io.IOException

setVerbose

public void setVerbose(boolean verbose)