|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.rational.rpe.api.docgen.LocalDocumentGenerator
public class LocalDocumentGenerator
Utility class for publishing reports using a local instance, also for other
available operations. For publishing reports using a remote web service, see
RemoteDocumentGenerator
.
Constructor Summary | |
---|---|
LocalDocumentGenerator(com.ibm.rational.rpe.engine.RRDGEngine engine)
|
Method Summary | |
---|---|
void |
addStatusListener(RPEListener listener)
Deprecated. |
void |
enableDebug(boolean debug)
Enables the core debug mode for the document generation |
java.lang.String |
getConfigurationPath(java.net.URI path)
Retrieves the path to the configuration file that needs to be passed to DocumentSpecificationBuilder methods. |
com.ibm.rational.rpe.common.utils.IConnectionConfigurator |
getConnectionConfigurator()
|
java.util.List<RPEResult> |
getResults()
Retrieves the results of a publishing process. |
com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus |
getStatus()
Returns the status of the generation |
com.ibm.rational.rpe.common.utils.IURIResolver |
getURIResolver()
|
void |
pause()
Pauses the publishing process. |
java.lang.Thread |
publish(RPEDocumentSpecification docSpec)
Deprecated. |
java.lang.Thread |
publish(RPEDocumentSpecification docSpec,
int previewLimit)
Starts the publishing process for a given Document Specification. |
void |
publishSync(RPEDocumentSpecification docSpec)
Deprecated. |
com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus |
publishSync(RPEDocumentSpecification docSpec,
int previewLimit)
Starts the publishing process for a given Document Specification. |
void |
registerListener(RPEListener listener)
Registers a RPE listener for receiving important progress messages from the document generation |
void |
removeStatusListener(RPEListener listener)
Deprecated. |
void |
resume()
Resumes a paused publishing process. |
void |
setConnectionConfigurator(com.ibm.rational.rpe.common.utils.IConnectionConfigurator connectionConfigurator)
|
void |
setMCData(com.ibm.rational.rpe.api.monitor.MCData mcdata)
Set the MCData information to be used for this local document generation. |
void |
setURIResolver(com.ibm.rational.rpe.common.utils.IURIResolver uriResolver)
|
void |
stop()
Stops a running publishing process. |
void |
unregisterListener(RPEListener listener)
Unregisters the listener from the engine |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LocalDocumentGenerator(com.ibm.rational.rpe.engine.RRDGEngine engine)
Method Detail |
---|
public void enableDebug(boolean debug)
IDocumentGenerator
enableDebug
in interface IDocumentGenerator
public java.lang.String getConfigurationPath(java.net.URI path)
DocumentSpecificationBuilder
methods.
path
- an URI
consisting of a path to the configuration
folder. If this parameter is null, this method returns a path
computed based on the "RPE_HOME" system environment variable.
public void setMCData(com.ibm.rational.rpe.api.monitor.MCData mcdata)
mcdata
- public java.lang.Thread publish(RPEDocumentSpecification docSpec, int previewLimit) throws RPEException
This method returns immediately after it has been called. The returning
Thread
object can be used to determine when the publish process
has ended.
publish
in interface IDocumentGenerator
docSpec
- the Document Specification to be published
Thread
RPEException
public com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus publishSync(RPEDocumentSpecification docSpec, int previewLimit) throws RPEException
This method does not return until the publishing thread has ended its execution.
publishSync
in interface IDocumentGenerator
docSpec
- the Document Specification to be published
RPEException
public java.util.List<RPEResult> getResults()
getResults
in interface IDocumentGenerator
public void pause()
pause
in interface IControl
public void resume()
resume
in interface IControl
public void stop()
stop
in interface IControl
public void setConnectionConfigurator(com.ibm.rational.rpe.common.utils.IConnectionConfigurator connectionConfigurator)
public com.ibm.rational.rpe.common.utils.IConnectionConfigurator getConnectionConfigurator()
public void setURIResolver(com.ibm.rational.rpe.common.utils.IURIResolver uriResolver)
public com.ibm.rational.rpe.common.utils.IURIResolver getURIResolver()
public void registerListener(RPEListener listener)
IDocumentGenerator
registerListener
in interface IDocumentGenerator
public void unregisterListener(RPEListener listener)
IDocumentGenerator
unregisterListener
in interface IDocumentGenerator
@Deprecated public void addStatusListener(RPEListener listener)
@Deprecated public void removeStatusListener(RPEListener listener)
@Deprecated public java.lang.Thread publish(RPEDocumentSpecification docSpec) throws RPEException
RPEException
@Deprecated public void publishSync(RPEDocumentSpecification docSpec) throws RPEException
RPEException
public com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus getStatus()
IDocumentGenerator
getStatus
in interface IDocumentGenerator
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |