AbstractAdviceTransform Class

com.bea.p13n.advisor
AbstractAdviceTransform Class

public abstract class AbstractAdviceTransform

    extends Object
    implements AdviceConstants, AdviceRequestConstants, AdviceTransform

This is an abstract base class useful for defining new AdviceTransform classes.

Hierarchy
Object
  AbstractAdviceTransform
All Implemented Interfaces

AdviceConstants, AdviceRequestConstants, AdviceTransform, AdvisletChainElement
Direct Known Subclasses

OutputToInputTransform, ResultsToRulesInputTransform, RulesInputTransform

Constructor Summary
AbstractAdviceTransform(Metadata metadata)

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

Method Summary
public Metadata
getMetadata()
Returns the Metadata that is associated with this.
public boolean
initialize(Map parameters, Object parameterDocument)
Initializes this with the given parameters and a parameterDocument.
public String
toString()
Constructs and returns a String representation of this object.
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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
   
Methods from interface com.bea.p13n.advisor.AdviceTransform
transform
 
Methods from interface com.bea.p13n.advisor.AdvisletChainElement
getMetadata, initialize
 

Constructor Detail

AbstractAdviceTransform

public AbstractAdviceTransform(Metadata metadata)
Construct an instance of this object and bind it to its Metadata instance.
 

Method Detail

getMetadata() Method

public Metadata getMetadata()
Returns the Metadata that is associated with this.

Returns

The Metadata.

initialize(Map, Object) Method

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

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
If an error occurs during initialization process.

toString() Method

public String toString()
Constructs and returns a String representation of this object.

Overrides
Object.toString()

Returns

a String representation of this object.

transform(Advice, AdviceRequest) Method

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

Parameters

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

Exceptions

AdvisorException
If an error occurs during the transformation process.