com.ail.core.xmlbinding
Class FromXMLCommand

java.lang.Object
  com.ail.core.Type
      com.ail.core.command.AbstractCommand
          com.ail.core.command.Command
              com.ail.core.xmlbinding.FromXMLCommand

All Implemented Interfaces:

CommandArg, FromXMLArg, java.io.Serializable, java.lang.Cloneable

public class FromXMLCommand
extends Command
implements FromXMLArg

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

Version:

$Revision: 1.2 $

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ail.core.Type

jXPathContext, NOT_PERSISTED

Constructor Summary

FromXMLCommand()
Default constructor

Method Summary

CommandArg	getArgs() Return the arguments used (processed by) the entry point.
java.lang.Class	getClassIn() Get the value of the ClassIn argument.
java.lang.Object	getObjectOut() Fetch the value of ObjectOut.
XMLString	getXmlIn() Fetch the XMLString that will be unmarshalled by the entry point.
XMLMapping	getXmlMappingInOut() Get the value of XmlMapping.
void	setArgs(CommandArg arg) Accept the argument object to be passed into the entry point.
void	setClassIn(java.lang.Class classIn) Set the value of the ClassIn property.
void	setObjectOut(java.lang.Object objectOut) Set the value of the ObjectOut property.
void	setXmlIn(XMLString xmlIn) Set the value of the XmlIn property.
void	setXmlMappingInOut(XMLMapping xmlMapping) Set the XML mapping 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

FromXMLCommand

public FromXMLCommand()

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 FromXMLArg

getArgs

public CommandArg getArgs()

Return the arguments used (processed by) the entry point.

Specified by:

getArgs in class AbstractCommand

Returns:

An instance of FromXMLArg

getObjectOut

public java.lang.Object getObjectOut()

Fetch the value of ObjectOut. This is the value retured from the FromXML entry point, and represents the object created when XmlIn was unmarshalled.

Specified by:

getObjectOut in interface FromXMLArg

Returns:

Unmarshalled object

setObjectOut

public void setObjectOut(java.lang.Object objectOut)

Set the value of the ObjectOut property.

Specified by:

setObjectOut in interface FromXMLArg

Parameters:

objectOut - The value to be set.

getXmlIn

public XMLString getXmlIn()

Fetch the XMLString that will be unmarshalled by the entry point. This is the input to the unmarshal process, and should represent an instance of the class specificed in ClassIn.

Specified by:

getXmlIn in interface FromXMLArg

Returns:

The XMLString to be unmarshalled.

setXmlIn

public void setXmlIn(XMLString xmlIn)

Set the value of the XmlIn property.

Specified by:

setXmlIn in interface FromXMLArg

Parameters:

xmlIn - The value to be set.

getClassIn

public java.lang.Class getClassIn()

Get the value of the ClassIn argument. This argument specifies the class which XmlIn represents an instance of.

Specified by:

getClassIn in interface FromXMLArg

Returns:

The class to be unmarshalled into.

setClassIn

public void setClassIn(java.lang.Class classIn)

Set the value of the ClassIn property.

Specified by:

setClassIn in interface FromXMLArg

Parameters:

classIn - The value to be set.

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 FromXMLArg

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 FromXMLArg

Parameters:

xmlMapping - The mapping to use.

See Also:

#getXmlMappingIn