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

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

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

Runtime configuration for a RPEDocumentSpecification object. This class is usually used to retrieve the templates or outputs defined by a document specification.


Constructor Summary
RPERuntime()
           
 
Method Summary
 void accept(com.ibm.rational.rpe.api.docspec.visitor.DocumentSpecificationVisitor v)
           
 void addLog(com.ibm.rational.rpe.api.docspec.RPELogging log)
          Adds a log to the run time section.
 void addOutput(RPEOutput out)
          Adds an output to the run time section.
 void addTemplate(RPETemplate templ)
          Adds a template to the run time information.
 com.ibm.rational.rpe.api.docspec.RPELogging getLog(java.lang.String logName)
          Retrieves a log element by its name.
 java.util.List<com.ibm.rational.rpe.api.docspec.RPELogging> getLogs()
          Retrieves the logs associated with the run time.
 RPEMetadata getMetadata()
          Retrieves the metadata associated with the run time section.
 RPEOutput getOutput(java.lang.String outputPath)
          Retrieves the output with a given path.
 int getOutputPosition(RPEOutput output)
          Retrieves the output position.
 java.util.List<RPEOutput> getOutputs()
          Retrieves the outputs from the run time section.
 RPETemplate getTemplate(java.lang.String templName)
          Retrieves a template with a given name.
 int getTemplatePosition(RPETemplate templ)
          Retrieves the position of a template.
 java.util.List<RPETemplate> getTemplates()
          Retrieves the list of templates associated with a document specification.
 void removeLog(com.ibm.rational.rpe.api.docspec.RPELogging log)
          Removes a log from the run time section.
 void removeOutput(RPEOutput output)
          Removes an output from the run time section.
 void removeTemplate(RPETemplate templ)
          Removes a template from the run time information.
 void setMetadata(RPEMetadata metadata)
          Sets the metadata for the run time section.
 void setOutputPosition(RPEOutput output, int position)
          Sets the position of an output in the run time section.
 void setTemplatePosition(RPETemplate templ, int position)
          Sets a template position in the run time section.
 
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

RPERuntime

public RPERuntime()
Method Detail

getTemplates

public java.util.List<RPETemplate> getTemplates()
Retrieves the list of templates associated with a document specification.

Returns:
a List of RPETemplate o

getTemplate

public RPETemplate getTemplate(java.lang.String templName)
Retrieves a template with a given name.

Parameters:
templName - the template name
Returns:
the template

addTemplate

public void addTemplate(RPETemplate templ)
Adds a template to the run time information.

Parameters:
templ - the template to add

removeTemplate

public void removeTemplate(RPETemplate templ)
Removes a template from the run time information.

Parameters:
templ - the template to remove

setTemplatePosition

public void setTemplatePosition(RPETemplate templ,
                                int position)
Sets a template position in the run time section.

template position will start with: 0

Parameters:
templ - the template for which the position will be set
position - the new template position

getTemplatePosition

public int getTemplatePosition(RPETemplate templ)
Retrieves the position of a template.

Parameters:
templ - the template for which the position is determined
Returns:
the template position

getOutputPosition

public int getOutputPosition(RPEOutput output)
Retrieves the output position.

Parameters:
output - the output for which the position is determined
Returns:
the output position

setOutputPosition

public void setOutputPosition(RPEOutput output,
                              int position)
Sets the position of an output in the run time section.

Parameters:
output - the output for which position is set
position - the new output position

getLogs

public java.util.List<com.ibm.rational.rpe.api.docspec.RPELogging> getLogs()
Retrieves the logs associated with the run time.

Returns:
a List of RPELogging objects

getLog

public com.ibm.rational.rpe.api.docspec.RPELogging getLog(java.lang.String logName)
Retrieves a log element by its name.

Parameters:
logName - the name of the log that will be retrieved
Returns:
the log with the given name

addLog

public void addLog(com.ibm.rational.rpe.api.docspec.RPELogging log)
Adds a log to the run time section.

Parameters:
log - the log to add

removeLog

public void removeLog(com.ibm.rational.rpe.api.docspec.RPELogging log)
Removes a log from the run time section.

Parameters:
log - the log to remove

getOutputs

public java.util.List<RPEOutput> getOutputs()
Retrieves the outputs from the run time section.

Returns:
a List of RPEOutput elements

getOutput

public RPEOutput getOutput(java.lang.String outputPath)
Retrieves the output with a given path.

Parameters:
outputPath - the path of the output
Returns:
the output

addOutput

public void addOutput(RPEOutput out)
Adds an output to the run time section.

Parameters:
out - the output to add

removeOutput

public void removeOutput(RPEOutput output)
Removes an output from the run time section.

Parameters:
output - the output to remove

getMetadata

public RPEMetadata getMetadata()
Retrieves the metadata associated with the run time section.

Returns:
the metadata

setMetadata

public void setMetadata(RPEMetadata metadata)
Sets the metadata for the run time section.

Parameters:
metadata - the metadata to set

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