com.ibm.rational.rpe.api.docspec
Class RPEOutputConfig

java.lang.Object
  extended by com.ibm.rational.rpe.api.docspec.RPEDocumentElement
      extended by com.ibm.rational.rpe.api.docspec.RPEOutputConfig
All Implemented Interfaces:
com.ibm.rational.rpe.api.docspec.visitor.DocumentSpecificationVisitable

public class RPEOutputConfig
extends com.ibm.rational.rpe.api.docspec.RPEDocumentElement
implements com.ibm.rational.rpe.api.docspec.visitor.DocumentSpecificationVisitable

Represents the output configuration.


Constructor Summary
RPEOutputConfig()
           
 
Method Summary
 void accept(com.ibm.rational.rpe.api.docspec.visitor.DocumentSpecificationVisitor v)
           
 void addNodeRenderer(com.ibm.rational.rpe.api.docspec.RPEOutputNodeRenderer nodeRenderer)
          Adds an output node renderer.
 void addOutputConfiguration(RPEOutputConfiguration outputConfig)
          Adds an output configuration.
 void addOutputDriver(com.ibm.rational.rpe.api.docspec.RPEOutputDriver outputDriver)
          Adds an output driver.
 void addValueRenderer(com.ibm.rational.rpe.api.docspec.RPEOutputValueRenderer valueRenderer)
          Adds an output value renderer.
 com.ibm.rational.rpe.api.docspec.RPEOutputDriver getDefaultOutputDriver(java.lang.String outDriverType)
          Retrieves the default output driver for a certain output driver type.
 java.util.List<com.ibm.rational.rpe.api.docspec.RPEOutputNodeRenderer> getNodeRenderers()
          Retrieves the output node renderers.
 java.util.List<RPEOutputConfiguration> getOutputConfigurations()
          Retrieves the output configurations.
 java.util.List<com.ibm.rational.rpe.api.docspec.RPEOutputDriver> getOutputDrivers()
          Retrieves the output drivers.
 java.util.List<com.ibm.rational.rpe.api.docspec.RPEOutputValueRenderer> getValueRenderers()
          Retrieves the output value renderers
 
Methods inherited from class com.ibm.rational.rpe.api.docspec.RPEDocumentElement
addProperties, addProperty, getProperties, getProperty, makeFeature, removeProperty
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RPEOutputConfig

public RPEOutputConfig()
Method Detail

getOutputConfigurations

public java.util.List<RPEOutputConfiguration> getOutputConfigurations()
Retrieves the output configurations.

Returns:
a List of RPEOutputConfiguration.

addOutputConfiguration

public void addOutputConfiguration(RPEOutputConfiguration outputConfig)
Adds an output configuration.

Parameters:
outputConfig - the output configuration

getOutputDrivers

public java.util.List<com.ibm.rational.rpe.api.docspec.RPEOutputDriver> getOutputDrivers()
Retrieves the output drivers.

Returns:
a List of RPEOutputDriver objects

addOutputDriver

public void addOutputDriver(com.ibm.rational.rpe.api.docspec.RPEOutputDriver outputDriver)
Adds an output driver.

Parameters:
outputDriver - the output driver to add

getNodeRenderers

public java.util.List<com.ibm.rational.rpe.api.docspec.RPEOutputNodeRenderer> getNodeRenderers()
Retrieves the output node renderers.

Returns:
a List of RPEOutputNodeRenderer

addNodeRenderer

public void addNodeRenderer(com.ibm.rational.rpe.api.docspec.RPEOutputNodeRenderer nodeRenderer)
Adds an output node renderer.

Parameters:
nodeRenderer - the output node renderer to add

getValueRenderers

public java.util.List<com.ibm.rational.rpe.api.docspec.RPEOutputValueRenderer> getValueRenderers()
Retrieves the output value renderers

Returns:
a List of RPEOutputValueRenderer

addValueRenderer

public void addValueRenderer(com.ibm.rational.rpe.api.docspec.RPEOutputValueRenderer valueRenderer)
Adds an output value renderer.

Parameters:
valueRenderer - the output value renderer to add

getDefaultOutputDriver

public com.ibm.rational.rpe.api.docspec.RPEOutputDriver getDefaultOutputDriver(java.lang.String outDriverType)
Retrieves the default output driver for a certain output driver type.

Parameters:
outDriverType - the driver type
Returns:
the default output driver

accept

public void accept(com.ibm.rational.rpe.api.docspec.visitor.DocumentSpecificationVisitor v)
            throws RPEException
Specified by:
accept in interface com.ibm.rational.rpe.api.docspec.visitor.DocumentSpecificationVisitable
Throws:
RPEException