org.apache.commons.chain.generic
Class CopyCommand

java.lang.Object
  extended by org.apache.commons.chain.generic.CopyCommand
All Implemented Interfaces:
Command

public class CopyCommand
extends Object
implements Command

Copy a specified literal value, or a context attribute stored under the fromKey (if any), to the toKey.

Version:
$Revision: 480477 $ $Date: 2006-11-29 08:34:52 +0000 (Wed, 29 Nov 2006) $
Author:
Craig R. McClanahan

Field Summary
 
Fields inherited from interface org.apache.commons.chain.Command
CONTINUE_PROCESSING, PROCESSING_COMPLETE
 
Constructor Summary
CopyCommand()
           
 
Method Summary
 boolean execute(Context context)
          Copy a specified literal value, or a context attribute stored under the fromKey (if any), to the toKey.
 String getFromKey()
          Return the context attribute key for the source attribute.
 String getToKey()
          Return the context attribute key for the destination attribute.
 String getValue()
          Return the literal value to be copied.
 void setFromKey(String fromKey)
          Set the context attribute key for the source attribute.
 void setToKey(String toKey)
          Set the context attribute key for the destination attribute.
 void setValue(String value)
          Set the literal value to be copied.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CopyCommand

public CopyCommand()
Method Detail

getFromKey

public String getFromKey()

Return the context attribute key for the source attribute.

Returns:
The source attribute key.

setFromKey

public void setFromKey(String fromKey)

Set the context attribute key for the source attribute.

Parameters:
fromKey - The new key

getToKey

public String getToKey()

Return the context attribute key for the destination attribute.

Returns:
The destination attribute key.

setToKey

public void setToKey(String toKey)

Set the context attribute key for the destination attribute.

Parameters:
toKey - The new key

getValue

public String getValue()

Return the literal value to be copied.

Returns:
The literal value.

setValue

public void setValue(String value)

Set the literal value to be copied.

Parameters:
value - The new value

execute

public boolean execute(Context context)
                throws Exception

Copy a specified literal value, or a context attribute stored under the fromKey (if any), to the toKey.

Specified by:
execute in interface Command
Parameters:
context - Context in which we are operating
Returns:
false so that processing will continue
Throws:
Exception - in the if an error occurs during execution.


Copyright © 2003-2010 The Apache Software Foundation. All Rights Reserved.