com.ail.core.xmlbinding
Class ToXMLCommand

java.lang.Object
  extended by com.ail.core.Type
      extended by com.ail.core.command.AbstractCommand
          extended by com.ail.core.command.Command
              extended by com.ail.core.xmlbinding.ToXMLCommand
All Implemented Interfaces:
CommandArg, ToXMLArg, java.io.Serializable, java.lang.Cloneable

public class ToXMLCommand
extends Command
implements ToXMLArg

This command is responsible for converting objects into strings of XML that represent them. The arguments and returns used during this process are described in (and encapsulated by an instance of) ToXMLArg.

Version:
$Revision: 1.2 $
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ail.core.Type
jXPathContext, NOT_PERSISTED
 
Constructor Summary
ToXMLCommand()
          Default constructor.
 
Method Summary
 CommandArg getArgs()
          Return the arguments used (processed by) the entry point.
 java.lang.Object getObjectIn()
          Fetch the ObjectIn value.
 XMLMapping getXmlMappingInOut()
          Get the value of XmlMapping.
 XMLString getXmlOut()
          Fetch the XmlOut value.
 void setArgs(CommandArg arg)
          Accept the argument object to be passed into the entry point.
 void setObjectIn(java.lang.Object objectIn)
          Set the value of the ObjectIn property.
 void setXmlMappingInOut(XMLMapping xmlMapping)
          Set the XML mapping property.
 void setXmlOut(XMLString xmlOut)
          Set the value of the XmlOut property.
 
Methods inherited from class com.ail.core.command.Command
clone, getAccessor, getCallersCore, getConfiguration, getVersion, invoke, setAccessor, setCallersCore, setConfiguration, setService
 
Methods inherited from class com.ail.core.Type
addAttribute, deleteLock, deleteSerialVersion, fetchJXPathContext, getAttribute, getAttribute, getAttributeCount, getForeignSystemId, getLock, getSerialVersion, getSystemId, hasLock, hasSerialVersion, hasSystemId, isPersisted, markAsNotPersisted, mergeWithDataFrom, removeAttribute, removeAttribute, setAttribute, setForeignSystemId, setLock, setSerialVersion, setSystemId, xpathGet, xpathGet, xpathIterate, xpathSet
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ail.core.command.CommandArg
getCallersCore, setCallersCore
 

Constructor Detail

ToXMLCommand

public ToXMLCommand()
Default constructor.

Method Detail

setArgs

public void setArgs(CommandArg arg)
Accept the argument object to be passed into the entry point.

Specified by:
setArgs in class AbstractCommand
Parameters:
arg - An instance of ToXMLArg

getArgs

public CommandArg getArgs()
Return the arguments used (processed by) the entry point.

Specified by:
getArgs in class AbstractCommand
Returns:
An instance of ToXMLArg

getObjectIn

public java.lang.Object getObjectIn()
Fetch the ObjectIn value. ObjectIn represents the object to be converted into XML.

Specified by:
getObjectIn in interface ToXMLArg
Returns:
The object to be marshalled

setObjectIn

public void setObjectIn(java.lang.Object objectIn)
Set the value of the ObjectIn property.

Specified by:
setObjectIn in interface ToXMLArg
Parameters:
objectIn - The new value.

getXmlOut

public XMLString getXmlOut()
Fetch the XmlOut value. XmlOut represents the result of the marshal process: a string of XML built from objectIn

Specified by:
getXmlOut in interface ToXMLArg
Returns:
marshalled XML object.

setXmlOut

public void setXmlOut(XMLString xmlOut)
Set the value of the XmlOut property.

Specified by:
setXmlOut in interface ToXMLArg
Parameters:
xmlOut - The new value.

getXmlMappingInOut

public XMLMapping getXmlMappingInOut()
Get the value of XmlMapping. This describes how to map from xml into java objects (and the reverse), and map be used by the service to cache marshallers and unmarshallers.

Specified by:
getXmlMappingInOut in interface ToXMLArg
Returns:
The mapping, or null if it is not defined.

setXmlMappingInOut

public void setXmlMappingInOut(XMLMapping xmlMapping)
Set the XML mapping property.

Specified by:
setXmlMappingInOut in interface ToXMLArg
Parameters:
xmlMapping - The mapping to use.
See Also:
#getXmlMappingIn