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

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

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

Represents a document specification object. Use DocumentSpecificationBuilder for building * RPEDocumentSpecification objects in client applications.


Constructor Summary
RPEDocumentSpecification()
           
 
Method Summary
 void accept(com.ibm.rational.rpe.api.docspec.visitor.DocumentSpecificationVisitor v)
           
 com.ibm.rational.rpe.api.docspec.RPEConfiguration getConfig()
          Retrieves the configuration section of the document specification.
 RPERuntime getRuntime()
          Retrieves the run time section of the document specification.
 java.lang.String getURI()
          Returns the URI of the document specification, which is the location from where the document specification was loaded.
 void setConfig(com.ibm.rational.rpe.api.docspec.RPEConfiguration config)
          Sets the configuration section associated with the document specification.
 void setRuntime(RPERuntime runtime)
          Sets the run time information associated with the document specification.
 void setURI(java.lang.String uri)
          Sets the URI of the document specification, which is the location from where the document specification was loaded.
 
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

RPEDocumentSpecification

public RPEDocumentSpecification()
Method Detail

getRuntime

public RPERuntime getRuntime()
Retrieves the run time section of the document specification. This run time section contains the information that is specific to the document specification, such as templates and outputs.

Returns:
the run time information

setRuntime

public void setRuntime(RPERuntime runtime)
Sets the run time information associated with the document specification.

Parameters:
runtime - the run time to set

getConfig

public com.ibm.rational.rpe.api.docspec.RPEConfiguration getConfig()
Retrieves the configuration section of the document specification. This information is independent of the concrete document specification because it contains information from RPEConfig.xml.

Returns:
the run time configuration

setConfig

public void setConfig(com.ibm.rational.rpe.api.docspec.RPEConfiguration config)
Sets the configuration section associated with the document specification.

Parameters:
config - the configuration 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

setURI

public void setURI(java.lang.String uri)
Sets the URI of the document specification, which is the location from where the document specification was loaded.


getURI

public java.lang.String getURI()
Returns the URI of the document specification, which is the location from where the document specification was loaded.