public class GenerateTask
extends com.nomagic.magicdraw.magicreport.ObserverTask
implements java.util.Observer
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ADD_ADDITIONAL_ELEMENT |
static java.lang.String |
ATTACHED_FILE |
static java.lang.String |
PACKAGES |
static java.lang.String |
SMART_AND_PACKAGES |
static java.lang.String |
TEMPLATE_WARN_EXCEPTION
Key for enable warning message when exception occurs in template.
|
static java.lang.String |
TEMPLATE_WARN_INVALID_METHOD
Key for enable warning message when invalid method use in template.
|
static java.lang.String |
TEMPLATE_WARN_INVALID_PROPERTY
Key for enable warning message when invalid property use in template.
|
static java.lang.String |
TEMPLATE_WARN_INVALID_REFERENCE
Key for enable warning message when invalid reference use in template.
|
Constructor and Description |
---|
GenerateTask(TemplateBean templateBean)
Create task for template.
|
Modifier and Type | Method and Description |
---|---|
void |
clearTemplate() |
static com.nomagic.magicreport.ExtensionClassLoader |
createExtensionClassLoader(java.lang.ClassLoader classLoader,
TemplateBean templateBean)
Creates class loader which is able to access extension classes (tools), including those who comes from MagicDraw plugins
|
protected com.nomagic.magicreport.engine.ITemplateEngine |
createTemplateEngine(java.lang.String templateExt) |
void |
execute()
Perform executing task.
|
void |
finished()
This method is call automatically when task has been finishing.
|
java.lang.Object |
getProperty(java.lang.String name)
Return an engine Runtime property.
|
TemplateBean |
getTemplateBean()
Return TemplateBean.
|
com.nomagic.magicreport.engine.ITemplateEngine |
getTemplateEngine()
Gets the initialized TemplateEngine.
|
void |
interrupt()
Interrupt task.
|
void |
needWaitForUploader(boolean needToWait)
Tells this task to wait with displaying the report.
|
java.lang.String |
resolveReportPath(java.lang.String string)
Resolve each variable of string that matches the report variable.
|
void |
setProperty(java.lang.String name,
java.lang.Object value)
Set an engine Runtime property.
|
void |
showReport()
Show the report.
|
void |
update(java.util.Observable o,
java.lang.Object arg)
This method is called whenever the template engine is changed.
|
addObserver, countObservers, deleteObserver, deleteObservers, notifyObservers, notifyObservers
addPropertyChangedListener, construct, currentTaskStatus, doFinished, getException, getName, getState, getStatus, interruptAndStop, isActiveTasks, isCancelable, isCanceled, isCompleted, isException, isFinished, isPrintStackTraceFor, isReady, isWorking, removePropertyChangedListener, setCancelable, setDoFinishedExecuter, setException, setFinished, setInterruptThreadOnCancel, setName, setState, setStatus, stopTask
public static final java.lang.String TEMPLATE_WARN_INVALID_METHOD
public static final java.lang.String TEMPLATE_WARN_INVALID_REFERENCE
public static final java.lang.String TEMPLATE_WARN_INVALID_PROPERTY
public static final java.lang.String TEMPLATE_WARN_EXCEPTION
public static final java.lang.String ADD_ADDITIONAL_ELEMENT
public static final java.lang.String SMART_AND_PACKAGES
public static final java.lang.String ATTACHED_FILE
public static final java.lang.String PACKAGES
public GenerateTask(TemplateBean templateBean)
templateBean
- a templatepublic static com.nomagic.magicreport.ExtensionClassLoader createExtensionClassLoader(java.lang.ClassLoader classLoader, @CheckForNull TemplateBean templateBean)
protected com.nomagic.magicreport.engine.ITemplateEngine createTemplateEngine(java.lang.String templateExt)
public java.lang.String resolveReportPath(java.lang.String string)
string
- path stringpublic void setProperty(java.lang.String name, java.lang.Object value)
name
- the key to be placed into this property list.value
- the value corresponding to key.public java.lang.Object getProperty(java.lang.String name)
name
- the property keypublic void update(java.util.Observable o, java.lang.Object arg)
update
in interface java.util.Observer
o
- the observable objectarg
- an argument passed to the notifyObservers method.public void execute() throws java.lang.Exception
execute
in class com.nomagic.task.Task
java.lang.Exception
- when error occursTask.execute()
public void interrupt()
interrupt
in class com.nomagic.task.Task
Task.interrupt()
public void finished()
finished
in class com.nomagic.task.SwingWorker<java.lang.Object>
SwingWorker.finished()
public void clearTemplate()
public void showReport()
public void needWaitForUploader(boolean needToWait)
needToWait
- true if the uploader needs to runpublic TemplateBean getTemplateBean()
public com.nomagic.magicreport.engine.ITemplateEngine getTemplateEngine()