OutputToInputTransform Class

com.bea.p13n.advisor
OutputToInputTransform Class

public class OutputToInputTransform

    extends AbstractAdviceTransform

This is an AdviceTransform that takes the last RESULT key (getResult return value) from the Advice object and puts it into the key specified in the "output-key" parameter field in the AdviceRequest. If the Advice is null or incomplete no transformation is performed.

Hierarchy
Object
  AbstractAdviceTransform
    OutputToInputTransform
All Implemented Interfaces

AdviceConstants, AdviceRequestConstants, AdviceTransform, AdvisletChainElement
Direct Known Subclasses

OutputListItemToInputTransform

Constructor Summary
OutputToInputTransform(Advisor ignore, Metadata metadata)

Construct an instance of this object and bind it to its Advisor and Metadata instances.
 

Method Summary
public String
getRequestKey()
Returns the request key.
public String
getSpecificKey()
Returns the request-specific key.
public String
getSpecificValue()
Returns the request-specific value.
public boolean
initialize(Map parameters, Object parameterDocument)
Initializes this with the given parameters and a parameterDocument.
public void
transform(Advice input, AdviceRequest output)
Transforms the given Advice into AdviceRequest to pass it to another Advisor in the advislet chain defined in the advislet registry.
 
Methods from  com.bea.p13n.advisor.AbstractAdviceTransform
getMetadata, toString,
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   
Methods from interface com.bea.p13n.advisor.AdviceTransform
transform
 
Methods from interface com.bea.p13n.advisor.AdvisletChainElement
getMetadata, initialize
 

Constructor Detail

OutputToInputTransform

public OutputToInputTransform(Advisor ignore, 
                              Metadata metadata)
Construct an instance of this object and bind it to its Advisor and Metadata instances.
 

Method Detail

getRequestKey() Method

public String getRequestKey()
Returns the request key.

Returns

The request key.

getSpecificKey() Method

public String getSpecificKey()
Returns the request-specific key.

Returns

the request-specific key.

getSpecificValue() Method

public String getSpecificValue()
Returns the request-specific value.

Returns

the request-specific value.

initialize(Map, Object) Method

public boolean initialize(Map parameters, 
                          Object parameterDocument)
     throws AdvisorException
Description copied from AbstractAdviceTransform.initialize(Map, Object)
Initializes this with the given parameters and a parameterDocument.

Overrides
AbstractAdviceTransform.initialize(Map, Object)

Parameters

parameters
A map containing key-value pairs.
parameterDocument
An Object representing a parameter document.

Returns

returns true if this operation is successful, otherwise returns false.

Exceptions

AdvisorException

transform(Advice, AdviceRequest) Method

public void transform(Advice input, 
                      AdviceRequest output)
     throws AdvisorException
Description copied from AbstractAdviceTransform.transform(Advice, AdviceRequest)
Transforms the given Advice into AdviceRequest to pass it to another Advisor in the advislet chain defined in the advislet registry.

Overrides
AbstractAdviceTransform.transform(Advice, AdviceRequest)

Parameters

input
An Advice from which the parameters are extracted and transformed.
output
An AdviceRequest that is prepared from the given Advice.

Exceptions

AdvisorException