|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.ibm.rational.rpe.api.docspec.RPEDocumentElement
com.ibm.rational.rpe.api.docspec.RPETemplate
public class RPETemplate
Represents a document template object. Use DocumentSpecificationBuilder for constructing RPETemplate objects in client applications.
| Constructor Summary | |
|---|---|
RPETemplate(java.lang.String templatePath)
Constructor for the RPETemplate class. |
|
| Method Summary | |
|---|---|
void |
accept(com.ibm.rational.rpe.api.docspec.visitor.DocumentSpecificationVisitor v)
|
void |
addDataSource(RPEDataSource dataSource)
Adds a data source to the template. |
void |
addVariable(com.ibm.rational.rpe.api.docspec.RPEVariable var)
Adds a variable to the template. |
RPEDataSource |
getDataSource(java.lang.String dsName)
Retrieves a data source object with a certain name. |
java.util.List<RPEDataSource> |
getDataSources()
Retrieves the data sources used in the template. |
RPEMetadata |
getMetadata()
Retrieves the metadata associated with the template. |
java.lang.String |
getURI()
Gets the URI property of this object, which is the location from where the template has been loaded. |
com.ibm.rational.rpe.api.docspec.RPEVariable |
getVariable(java.lang.String varName)
Retrieves a variable with a certain name. |
java.util.List<com.ibm.rational.rpe.api.docspec.RPEVariable> |
getVariables()
Retrieves the variables contained in the template. |
boolean |
isAvailable()
Synchronization method. |
void |
setMetadata(RPEMetadata metadata)
Sets the metadata associated with the template. |
void |
setURI(java.lang.String uri)
Sets the URI property of this object, which is the location from where the template has been 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 |
|---|
public RPETemplate(java.lang.String templatePath)
RPETemplate class.
templatePath - the absolute template path| Method Detail |
|---|
public boolean isAvailable()
public RPEMetadata getMetadata()
public void setMetadata(RPEMetadata metadata)
metadata - the metadata to addpublic java.util.List<RPEDataSource> getDataSources()
List of data sourcespublic RPEDataSource getDataSource(java.lang.String dsName)
dsName - the data source name to retrieve
public void addDataSource(RPEDataSource dataSource)
dataSource - the data source to addpublic java.util.List<com.ibm.rational.rpe.api.docspec.RPEVariable> getVariables()
List of variablespublic com.ibm.rational.rpe.api.docspec.RPEVariable getVariable(java.lang.String varName)
varName - the name of the variable to retrieve
public void addVariable(com.ibm.rational.rpe.api.docspec.RPEVariable var)
var - the variable to add
public void accept(com.ibm.rational.rpe.api.docspec.visitor.DocumentSpecificationVisitor v)
throws RPEException
accept in interface com.ibm.rational.rpe.api.docspec.visitor.DocumentSpecificationVisitableRPEExceptionpublic void setURI(java.lang.String uri)
public java.lang.String getURI()
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||