|
|||||||||||
| 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 by using a local instance. For publishing reports by using a remote web service, see RemoteDocumentGenerator.
| Constructor Summary | |
|---|---|
LocalDocumentGenerator(com.ibm.rational.rpe.engine.RRDGEngine engine)
Builds a LocalDocument generator instance by using the provided RRDGEngine. |
|
| Method Summary | |
|---|---|
void |
addStatusListener(RPEListener listener)
Deprecated. |
void |
enableDebug(boolean debug)
Enables the core debug mode for this document generation. |
java.lang.String |
getConfigurationPath(java.net.URI path)
Deprecated. |
IConnectionConfigurator |
getConnectionConfigurator()
Returns the IConnectionConfigurator object that is used by the generator, if any. |
java.util.List<RPEResult> |
getResults()
Retrieves the results of a publishing process. |
com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus |
getStatus()
See IDocumentGenerator.getStatus() |
com.ibm.rational.rpe.common.utils.IURIResolver |
getURIResolver()
Returns the IURIResolver object that is used by the generator, if any. |
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 in a separate thread. |
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 in the calling thread. |
void |
registerListener(RPEListener listener)
See IDocumentGenerator#registerListener(). |
void |
removeStatusListener(RPEListener listener)
Deprecated. |
void |
resume()
Resumes a paused publishing process. |
void |
setConnectionConfigurator(IConnectionConfigurator connectionConfigurator)
Optional: Sets the IConnectionConfigurator object to be used by the generator |
void |
setMCData(com.ibm.rational.rpe.api.monitor.MCData mcdata)
Set the MCData information to be used if this document generation is to be made available to the Rational Publishing Engine Monitor & Control service. |
void |
setURIResolver(com.ibm.rational.rpe.common.utils.IURIResolver uriResolver)
Optional: Sets the IURIResolver object to be used by the generator |
void |
stop()
Stops a running publishing process. |
void |
unregisterListener(RPEListener listener)
See IDocumentGenerator#unregisterListener(). |
| 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)
engine - | Method Detail |
|---|
public void enableDebug(boolean debug)
IDocumentGenerator.enableDebug(boolean).
enableDebug in interface IDocumentGenerator@Deprecated public java.lang.String getConfigurationPath(java.net.URI path)
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 IDocumentGeneratordocSpec - the document specification to be published
Thread
RPEException
public com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus publishSync(RPEDocumentSpecification docSpec,
int previewLimit)
throws RPEException
NOTE: This operation can be time consuming and locks the caller thread until it completes.
This method does not return until the publishing thread has ended its execution.
publishSync in interface IDocumentGeneratordocSpec - the Document Specification to be published
RPEExceptionpublic java.util.List<RPEResult> getResults()
IDocumentGenerator.getResults().
getResults in interface IDocumentGeneratorpublic void pause()
IControl.pause().
pause in interface IControlpublic void resume()
IControl.resume().
resume in interface IControlpublic void stop()
IControl.stop().
stop in interface IControlpublic void setConnectionConfigurator(IConnectionConfigurator connectionConfigurator)
public 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().
registerListener in interface IDocumentGeneratorpublic void unregisterListener(RPEListener listener)
IDocumentGenerator#unregisterListener().
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
RPEExceptionpublic com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus getStatus()
IDocumentGenerator.getStatus()
getStatus in interface IDocumentGenerator
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||