org.openxri.pipeline.stages
Class AddXMLElementStage

java.lang.Object
  extended by org.openxri.pipeline.stages.AbstractStage
      extended by org.openxri.pipeline.stages.AddXMLElementStage
All Implemented Interfaces:
java.io.Serializable, Stage

public class AddXMLElementStage
extends AbstractStage

A stage that adds an arbitrary XML element to the XRD. The text value of the element and the element's attributes can be configured using stage parameters. Parameters for the stage's configuration: elementname (required): The name of the element. elementvalue (optional, default: empty string): The text inside the element. [other parameters] (optional): Other parameters are treated as attributes for the XML element. The parameter name is the attribute name, and the parameter value is the attribute value. Recommended pipeline(s) for this stage: CREATE, LOOKUP

Author:
=peacekeeper
See Also:
Serialized Form

Field Summary
static java.lang.String DEFAULT_ELEMENTVALUE
           
static java.lang.String PROPERTIES_KEY_ELEMENTNAME
           
static java.lang.String PROPERTIES_KEY_ELEMENTVALUE
           
 
Fields inherited from class org.openxri.pipeline.stages.AbstractStage
properties
 
Constructor Summary
AddXMLElementStage(java.util.Properties properties)
           
 
Method Summary
 XRD execute(Store store, XRD xrd, XRISegment segment, Authority parentAuthority, java.lang.String subSegmentName, Authority authority, boolean isCreate)
          Called as part of executing a pipeline.
 void init()
          A stage is constructed by the PipelineRegistry by passing a Properties object to its constructor and then calling this init() method.
 
Methods inherited from class org.openxri.pipeline.stages.AbstractStage
getProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTIES_KEY_ELEMENTNAME

public static final java.lang.String PROPERTIES_KEY_ELEMENTNAME
See Also:
Constant Field Values

PROPERTIES_KEY_ELEMENTVALUE

public static final java.lang.String PROPERTIES_KEY_ELEMENTVALUE
See Also:
Constant Field Values

DEFAULT_ELEMENTVALUE

public static final java.lang.String DEFAULT_ELEMENTVALUE
See Also:
Constant Field Values
Constructor Detail

AddXMLElementStage

public AddXMLElementStage(java.util.Properties properties)
Method Detail

init

public void init()
          throws java.lang.Exception
Description copied from interface: Stage
A stage is constructed by the PipelineRegistry by passing a Properties object to its constructor and then calling this init() method.

Throws:
java.lang.Exception

execute

public XRD execute(Store store,
                   XRD xrd,
                   XRISegment segment,
                   Authority parentAuthority,
                   java.lang.String subSegmentName,
                   Authority authority,
                   boolean isCreate)
            throws StageException
Description copied from interface: Stage
Called as part of executing a pipeline.

Parameters:
store - The store from which the authorities were retrieved.
xrd - A XRD as it currently looks like on the pipeline. The stage is free to modify and return it in any way.
segment - The XRI segment that resolves to the XRD being processed.
parentAuthority - The parent authority, i.e. the authority describing the XRD.
subSegmentName - The name of the subsegment that connects the two authorities.
authority - The authority, i.e. the authority described by the XRD.
isCreate - Whether this stage is execute as part of a CREATE pipeline.
Returns:
The XRD that is passed on to the next stage of the pipeline.
Throws:
StageException


Copyright © 2005-2012. All Rights Reserved.