public class CommandLine
extends com.nomagic.magicdraw.magicreport.AbstractCommandLine
This CommandLine class is perform generating report by command line for Magic Report. To generate the report, this class requires 4 main arguments or an argument of properties. If the arguments are contained in a Properties File, then no dashes are to be added in front of the Argument Names.
-properties | Specify a file name with path of properties file. |
-generatepassword | Specify password to generates an encrypted password to be used with a properties file. |
Main arguments
Name | Description |
-project | Specify a file name with path of MagicDraw project. |
-output | Specify a file name with path of the output file. |
-template | Specify the name of the template to use in generating the report document. The template should already exist in the MagicDraw application. |
-package | Specify the name of one or more packages from the MagicDraw project that you would like to include in the report. Package entries must be separated by a semicolon (;). |
-element | Specify the name of one or more elements from the MagicDraw project that you would like to include in the report. Element entries must be separated by a semicolon (;). |
-elementID | Specify the id (Element ID for Local Project and Teamwork Project, Server Element ID for TWCloud Project) of one or more elements from the MagicDraw project that you would like to include in the report. Each id must be separated by a semicolon (;). |
Optional arguments
Name | Description |
-report | Specify the name of the report data file. The report data name must already exist in a template file within MagicDraw. The last generating report data will be set as the default. |
-autoImage | Specify how to show the image in the report document. The default value for this argument is "1". |
-imageFormat | Specify the type of image in the report document. The default value for this argument is "jpg". |
-recursive | Select all packages starting from selected package recursively. The default value for this argument is true. |
-includeAuxiliary | Select package include auxiliary module. The default value for this argument is true. |
-outputOnBlankField | Specify string value to show in a blank field in the report document. The default value for this argument is "". |
-category | Specify category of template. |
-fields | Specify user defined fields. |
-overwrite | Specify "true" to overwrite all files automatically. overwrite is true by default. Specify other value to show prompt if specified output file exists. |
-upload | Specify serverAddress consisting of a scheme, userInfo, host, port, and path to connect and upload a generated report to a server |
Example
generate -project "D:\myproject.mdzip" -package "Software design;com"
-output "outputreport.rtf" -template "Use Case (Modern)"
Main arguments
Name | Description |
-server | Specify a server name or IP Address (and port). |
-login | Specify a login name. |
-password | Specify the password. |
-spassword | Specify an encrypted password (Teamwork password) to log on to Teamwork Server. |
Option arguments
Name | Description |
-pversion | Specify a server project version. |
-tag | Specify a server project tag. |
-incremental | Specify incremental method. If the value is true, the output report shall be generated by appending a new generated output file name with the incremental number. This argument will be used with "-tag" only |
-servertype | Specify a type of server to connect. |
-ssl | Specify whether Secured Connection (SSL) is used. |
The additional arguments for Teamwork Cloud project
Name | Description |
-usagepackage | Specify one or more packages in Project Usages of Teamwork Cloud project. |
-usagepackage | Specify one or more elements in Project Usages of Teamwork Cloud project. |
-includeAllProjectUsages | Specify to show all Project Usages, default is false. |
-branch | Specify branch of Teamwork Cloud project. If "-pversion" and "-tag" are not specified, The latest version of specified branch will be returned. |
-updatemodule | Update project usages of Teamwork Cloud project if required. updatemodule is false by default. |
-projectpassword | Specify project password. |
Example
generate -project "myproject" -package "Software design;com" -output "outputreport.rtf"
-template "Use Case (Modern)" -server "161.246.1.1" -login "john" -password "changeit"
For more information, please use code:
generate -help
VTLIDENTIFIER is ...
Modifier and Type | Field and Description |
---|---|
static java.util.regex.Pattern |
FIELDSFORMAT
The valid fields format.
|
protected java.util.List<java.lang.String> |
propertiesFileList
A list of properties files.
|
static java.util.regex.Pattern |
VTLIDENTIFIER
The valid VTL Identifier.
|
protected boolean |
warningPackageNotFound
Show warning message when package/element not found.
|
Constructor and Description |
---|
CommandLine() |
Modifier and Type | Method and Description |
---|---|
void |
clearPVersion()
Set pversion to null
|
void |
clearTag()
Set tagList to null
|
protected com.nomagic.magicdraw.core.Project |
createProject(java.lang.String projectName)
Create project.
|
protected com.nomagic.magicdraw.core.Project |
createProject(java.lang.String projectName,
java.lang.String serverName,
java.lang.String userName,
java.lang.String pwd)
Create project from Teamwork server.
|
protected TemplateBean |
createTemplateBean(java.lang.String catName,
java.lang.String templName)
Create the templateBean by given category name and template name.
|
protected byte |
execute() |
protected void |
executeUpload(com.nomagic.magicreport.engine.ITemplateEngine engine,
java.lang.String outputFile,
com.nomagic.magicdraw.magicreport.upload.profiles.ServerProfileBean profile,
java.net.URI uri)
Call upload client and upload report to server.
|
protected java.lang.String[] |
findElementIds(com.nomagic.magicdraw.core.Project proj,
java.util.List<java.lang.String> elementName)
Find the element id by matching the given element name and element name in project.
|
protected java.lang.String[] |
findElementIds(com.nomagic.magicdraw.core.Project proj,
java.util.List<java.lang.String> elementName,
java.lang.String serverType,
java.util.List<java.lang.String> projectUsagesElementName,
java.lang.Boolean includeAuxiliary)
Find the element id by matching the given element name and element name in project.
|
protected java.lang.String[] |
findElementIds(com.nomagic.magicdraw.core.Project proj,
java.util.List<java.lang.String> elementName,
java.lang.String serverType,
java.util.List<java.lang.String> elementInProjectUsageName,
java.lang.Boolean includeAuxiliary,
java.lang.Boolean includeAllProjectUsages)
Find the element id by matching the given element name and element name in project.
|
protected java.lang.String[] |
findPackageAndElementIds(com.nomagic.magicdraw.core.Project proj,
java.lang.String serverType,
java.util.List<java.lang.String> selectedPacakgeList,
java.util.List<java.lang.String> selectedElementList,
java.util.List<java.lang.String> selectedPackageInUsageList,
java.util.List<java.lang.String> selectedElementInUsageList,
java.lang.Boolean includeAuxiliary,
boolean isIncludeAllProjectUsages)
Find the element and package id by matching the given element/pacakge name and element/package name in
project.
|
protected java.lang.String[] |
findPackageIds(com.nomagic.magicdraw.core.Project proj,
java.util.List<java.lang.String> packageName)
Find the package id by matching the given package name and package name in project.
|
protected java.lang.String[] |
findPackageIds(com.nomagic.magicdraw.core.Project proj,
java.util.List<java.lang.String> packageName,
java.lang.String serverType,
java.util.List<java.lang.String> projectUsagesPackageName,
java.lang.Boolean includeAuxiliary)
Find the package id by matching the given package name and package name in project.
|
protected java.lang.String[] |
findPackageIds(com.nomagic.magicdraw.core.Project proj,
java.util.List<java.lang.String> packageName,
java.lang.String serverType,
java.util.List<java.lang.String> packageInProjectUsageName,
java.lang.Boolean includeAuxiliary,
java.lang.Boolean includeAllProjectUsages)
Find the package id by matching the given package name and package name in project.
|
protected ReportBean |
findReportBean(TemplateBean templateBean,
java.lang.String name)
Find and return instance of ReportBean from given TemplateBean and report name.
|
void |
generate()
Perform the task to generate the report.
|
void |
generate(com.nomagic.magicdraw.core.Project project)
Generate the report from given project.
|
java.lang.String[] |
getAllId() |
java.lang.String |
getAutoImage()
Return the auto image option.
|
java.lang.String |
getBranchName()
Return branch name.
|
java.lang.String |
getCategoryName()
Return the category name.
|
java.util.List<java.lang.String> |
getElementId()
Return the element id.
|
java.util.List<java.lang.String> |
getElementIdList() |
java.util.List<java.lang.String> |
getElementName()
Return the element name.
|
java.util.List<java.lang.String> |
getElementNameList() |
static java.lang.String |
getEncryptedPassword(java.lang.String password)
Generate and return encrypted password.
|
java.util.List<java.lang.String> |
getFields()
Return the fieldsList.
|
java.lang.String |
getImageFormat()
Return the image format.
|
java.lang.Boolean |
getIncludeAuxiliary() |
java.lang.String |
getLogin()
Return the login name.
|
java.lang.String |
getOutputFileName()
Return the output file name.
|
java.lang.String |
getOutputForIncremental()
Real Output file name
|
java.lang.String |
getOutputOnBlankField()
Return the output on Blank Field value.
|
java.util.List<java.lang.String> |
getPackageName()
Return the package name.
|
java.util.List<java.lang.String> |
getPackageNameList() |
java.lang.String |
getPassword()
Return the password.
|
java.lang.String |
getProjectName()
Return the project name.
|
java.lang.String |
getProjectpassword()
Get project password.
|
java.util.List<java.lang.String> |
getPropertiesFileList() |
java.lang.String |
getPropertiesFileName()
Return the properties file name.
|
java.lang.String |
getpVersion()
Gets project version.
|
java.lang.Boolean |
getRecursive()
Gets recursive.
|
java.lang.String |
getReportName()
Return the report name.
|
java.lang.String |
getServer()
Return the server name.
|
java.lang.String |
getServerType()
Get server type.
|
java.lang.String |
getTag()
Get tag name
|
java.lang.String |
getTemplateName()
Return the template name.
|
java.lang.String |
getUrl()
Gets URL for upload generated output.
|
java.util.List<java.lang.String> |
getUsageElementName()
Return the element name in project usages.
|
java.util.List<java.lang.String> |
getUsagePackageName()
Return the package name in project usages.
|
boolean |
isActiveValidationEnabled() |
boolean |
isCameoServer() |
boolean |
isFoundUpload()
Gets foundUpload.
|
boolean |
isGeneratePassword(java.lang.String[] args)
Method for check generatePassword argument.
|
boolean |
isIncludeAllProjectUsages()
Return all project usages option.
For twcloud only |
java.lang.Boolean |
isIncludeAuxiliary()
Return the auxiliary option.
|
java.lang.Boolean |
isIncludeAuxiliaryValue() |
boolean |
isIncremental()
Get incremental value
|
boolean |
isOverwrite()
Gets overwrite.
|
boolean |
isPackageElementSpecified() |
java.lang.Boolean |
isRecursive()
Return the recursive option.
|
boolean |
isShowUsage(java.lang.String[] args)
Method for showing command line usage.
|
boolean |
isSSL()
Return if SSL is enable.
|
boolean |
isTWCloudProject(java.lang.String type)
Check teamwork cloud project type
|
boolean |
isUpdateModule()
Return true if update module, otherwise false.
|
boolean |
isUseEncryptedPassword()
Gets useEncryptedPassword.
|
boolean |
isVerbose()
Return a verbose.
|
boolean |
isWarningPackageNotFound()
Sets warningPackageNotFound.
|
java.util.Properties |
loadProperties(java.io.InputStream inStream,
java.lang.String encodeType)
This function is create for read a property list (key and element pairs) from the input stream.
|
static void |
main(java.lang.String[] args)
Main method to generate the report or teamwork password.
|
protected com.nomagic.magicdraw.core.Project |
openProject() |
protected void |
parseArgs(java.lang.String[] args)
Create command line from given arguments.
|
protected void |
parseArgs(java.lang.String[] args,
boolean skipShutdown)
Create command line from given arguments.
|
void |
parseArguments(java.lang.String[] args)
Parse the arguments and set into the command line.
|
protected static void |
printUsage()
Print command line usage.
|
protected static void |
printUsage(java.io.PrintStream printStream)
Print command line usage to print stream.
|
protected java.lang.String |
promptPassword()
Prompt password when user enter only -server and -login for connecting to Teamwork server or when user enter
-upload and its value not contain password for connecting to server (for upload generated report to server).
|
protected java.lang.String |
promptUsername()
Prompt user name when key argument required user name such as when upload generated report to server.
|
void |
setActiveValidationEnabled(boolean activeValidationEnabled) |
void |
setAllId(java.lang.String[] allId) |
void |
setAutoImage(java.lang.String autoImage)
Set the auto image option.
|
void |
setBranchName(java.lang.String branchName)
Set branch name
|
void |
setCameoServer(java.lang.String cameoServer)
Deprecated.
since 17.0.5
|
void |
setCategoryName(java.lang.String categoryName)
Set the category name.
|
void |
setElementId(java.lang.String elementId)
Specify the id of one or more element.
|
void |
setElementIdList(java.util.List<java.lang.String> elementIdList) |
void |
setElementName(java.lang.String elementName)
Specify the name of one or more element.
|
void |
setElementNameList(java.util.List<java.lang.String> elementNameList) |
void |
setFields(java.lang.String fields)
Specify the field entry text.
|
void |
setFoundUpload(boolean foundUpload)
Sets foundUpload.
|
void |
setImageFormat(java.lang.String imageFormat)
Set the image format.
|
void |
setIncludeAllProjectUsages(java.lang.String includeAllProjectUsages)
Set the show all project usages option.
|
void |
setIncludeAuxiliary(java.lang.Boolean includeAuxiliary) |
void |
setIncludeAuxiliary(java.lang.String auxiliary)
Set the show auxiliary option.
|
void |
setIncremental(boolean incremental)
Set incremental value by boolean
|
void |
setIncremental(java.lang.String incremental)
Set incremental value by string
|
void |
setLogin(java.lang.String login)
Set the login name.
|
void |
setOutputFileName(java.lang.String outputFileName)
Set the output file name.
|
void |
setOutputForIncremental(java.lang.String outputForIncremental)
Set output file name for incremental method
|
void |
setOutputOnBlankField(java.lang.String outputOnBlankField)
Set the output on Blank Field value.
|
void |
setOverwrite(boolean overwrite)
Sets overwrite.
|
void |
setPackageElementSpecified(boolean packageElementSpecified) |
void |
setPackageName(java.lang.String packageName)
Specify the name of one or more packages.
|
void |
setPackageNameList(java.util.List<java.lang.String> packageNameList) |
void |
setPassword(java.lang.String password)
Set the password.
|
void |
setProjectName(java.lang.String projectName)
Set the project name.
|
void |
setProjectpassword(java.lang.String projectpassword)
Set project password.
|
void |
setPropertiesFileList(java.util.List<java.lang.String> propertiesFileList) |
void |
setPropertiesFileName(java.lang.String propertiesFileName)
Set the properties file name.
|
void |
setpVersion(java.lang.String pVersion)
Sets project version.
|
void |
setRecursive(java.lang.Boolean recursive)
Sets recursive.
|
void |
setRecursive(java.lang.String recursive)
Set the recursive option.
|
void |
setReportName(java.lang.String reportName)
Set the report name.
|
void |
setServer(java.lang.String server)
Set the server name.
|
void |
setServerType(java.lang.String serverType)
Get server type.
|
void |
setSSL(java.lang.String isSSL)
Set true to enable SSL
|
void |
setTag(java.lang.String tag)
Set tag name
|
void |
setTemplateName(java.lang.String templateName)
Set the template name.
|
void |
setUpdateModule(java.lang.String updateModule)
Set true to force update module
|
void |
setUrl(java.lang.String url)
Sets URL for upload generated output.
|
void |
setUsageElementName(java.lang.String elementName)
Specify the name of one or more element in project usages.
|
void |
setUsagePackageName(java.lang.String packageName)
Specify the name of one or more packages in project usages.
|
void |
setUseEncryptedPassword(boolean useEncryptedPassword)
Sets useEncryptedPassword.
|
void |
setVerbose(boolean verbose)
Set a verbose.
|
void |
setWarningPackageNotFound(boolean warningPackageNotFound)
Gets warningPackageNotFound.
|
void |
shutdown()
Shutdown the MagicDraw Application.
|
void |
start()
Deprecated.
See
CommandLine.launch(String[]) |
void |
start(java.lang.String[] args)
Deprecated.
See
CommandLine.launch(String[]) |
protected void |
uploadToServer(com.nomagic.magicreport.engine.ITemplateEngine engine,
java.lang.String outputFile)
Parse upload command and upload report output to server.
|
addTWSShutDownHook, checkProjectPassword, closeProject, getLogger, getProjectDescriptorByTag, loadProject, loadProperties, loadPropertiesFromFile, openProject, openServerProject, openServerProject, openTeamworkProject, printErrorMessage, printInformationMessage, printWarningMessage, setLogger, splitQualifiedNames
public static final java.util.regex.Pattern VTLIDENTIFIER
public static final java.util.regex.Pattern FIELDSFORMAT
protected java.util.List<java.lang.String> propertiesFileList
protected boolean warningPackageNotFound
protected void parseArgs(java.lang.String[] args) throws java.lang.Exception
parseArgs
in class com.nomagic.magicdraw.commandline.CommandLine
args
- argumentsjava.lang.IllegalArgumentException
- the IllegalArgumentException may be propagation from setter methodjava.io.IOException
- when unable to read properties file.java.lang.Exception
protected void parseArgs(java.lang.String[] args, boolean skipShutdown) throws java.lang.Exception
args
- argumentsskipShutdown
- true to skip code to shutdown server; otherwise falsejava.lang.IllegalArgumentException
- the IllegalArgumentException may be propagation from setter methodjava.io.IOException
- when unable to read properties file.java.lang.Exception
public java.lang.String getProjectName()
public void setProjectName(java.lang.String projectName) throws java.lang.IllegalArgumentException
projectName
- the project name to be setjava.lang.IllegalArgumentException
- illegal or inappropriate argument has been setpublic java.lang.String getOutputFileName()
public void setOutputFileName(java.lang.String outputFileName) throws java.lang.IllegalArgumentException
outputFileName
- the output file name to be setjava.lang.IllegalArgumentException
- illegal or inappropriate argument has been setpublic java.lang.String getTemplateName()
public void setTemplateName(java.lang.String templateName) throws java.lang.IllegalArgumentException
templateName
- the template name to be setjava.lang.IllegalArgumentException
- illegal or inappropriate argument has been setpublic java.util.List<java.lang.String> getPackageName()
public void setPackageName(java.lang.String packageName) throws java.lang.IllegalArgumentException
packageName
- the package name to be setjava.lang.IllegalArgumentException
- illegal or inappropriate argument has been setpublic java.util.List<java.lang.String> getElementName()
public void setElementName(java.lang.String elementName) throws java.lang.IllegalArgumentException
elementName
- the element name to be setjava.lang.IllegalArgumentException
- illegal or inappropriate argument has been setpublic java.util.List<java.lang.String> getElementId()
public void setElementId(java.lang.String elementId) throws java.lang.IllegalArgumentException
elementId
- the element id to be setjava.lang.IllegalArgumentException
- illegal or inappropriate argument has been setpublic java.util.List<java.lang.String> getUsagePackageName()
public void setUsagePackageName(java.lang.String packageName)
packageName
- the package name in project usages to be setjava.lang.IllegalArgumentException
- illegal or inappropriate argument has been setpublic java.util.List<java.lang.String> getUsageElementName()
public void setUsageElementName(java.lang.String elementName)
elementName
- the element name in project usages to be setjava.lang.IllegalArgumentException
- illegal or inappropriate argument has been setpublic java.util.List<java.lang.String> getFields()
public void setFields(java.lang.String fields) throws java.lang.IllegalArgumentException
[name=value]
pattern strings. The following pattern is valid name for Name string.
[a-zA-Z][a-zA-Z_0-9]*
The following examples show how text is set to field entries.
[author=Foo][version=2]
fields
- text represent to field entry.java.lang.IllegalArgumentException
- illegal or inappropriate argument has been setpublic java.lang.String getReportName()
public void setCategoryName(java.lang.String categoryName)
categoryName
- the category name to be setpublic java.lang.String getCategoryName()
public void setReportName(java.lang.String reportName)
reportName
- the report name to be setpublic java.lang.String getAutoImage()
public void setAutoImage(java.lang.String autoImage) throws java.lang.IllegalArgumentException
null
, the auto image option will be set to default.
(default :"1")autoImage
- the auto image to be setjava.lang.IllegalArgumentException
- if value is not in "0", "1", "2", or "3"public java.lang.String getImageFormat()
public void setImageFormat(java.lang.String imageFormat) throws java.lang.IllegalArgumentException
null
, the image format will be set to default. (default:
"jpg")imageFormat
- the image format to be setjava.lang.IllegalArgumentException
- if the value is not the "jpg", "png", "svg", "emf" or "wmf".public java.lang.Boolean isRecursive()
public void setRecursive(java.lang.String recursive) throws java.lang.IllegalArgumentException
null
, the recursive will be set to default. (default
: true)recursive
- the recursive flag to be setjava.lang.IllegalArgumentException
- if the value is not the "true" or "false".public void setIncludeAllProjectUsages(java.lang.String includeAllProjectUsages) throws java.lang.IllegalArgumentException
null
, it will be set to default.
(default : false)includeAllProjectUsages
- show all project usages flag to be setjava.lang.IllegalArgumentException
- if the value is not the "true" or "false".public boolean isIncludeAllProjectUsages()
public boolean isTWCloudProject(java.lang.String type)
com.nomagic.magicdraw.magicreport.AbstractCommandLine
isTWCloudProject
in class com.nomagic.magicdraw.magicreport.AbstractCommandLine
type
- type of server project.public java.lang.Boolean isIncludeAuxiliary()
public java.lang.Boolean isIncludeAuxiliaryValue()
public void setIncludeAuxiliary(java.lang.String auxiliary) throws java.lang.IllegalArgumentException
null
, the auxiliary will be set to default.
(default : false)auxiliary
- the auxiliary flag to be setjava.lang.IllegalArgumentException
- if the value is not the "true" or "false".public java.lang.String getOutputOnBlankField()
public void setOutputOnBlankField(java.lang.String outputOnBlankField)
null
the outputOnBlankField will be set to
default (default : "")outputOnBlankField
- the output on Blank Filed to be setpublic java.lang.String getServer()
public void setServer(java.lang.String server)
server
- the server name to be set@Deprecated public void setCameoServer(java.lang.String cameoServer) throws java.lang.IllegalArgumentException
cameoServer
- true - use Cameo server, false - use Teamwork server.java.lang.IllegalArgumentException
- if the value is not the "true" or "false".public boolean isCameoServer()
public java.lang.String getLogin()
public void setLogin(java.lang.String login)
login
- the login name to be setpublic java.lang.String getPassword()
public void setPassword(java.lang.String password)
password
- the password to be setpublic java.lang.String getpVersion()
public void setpVersion(java.lang.String pVersion)
pVersion
- project version.public void clearPVersion()
public java.lang.String getTag()
public void setTag(java.lang.String tag)
public void clearTag()
public boolean isIncremental()
public void setIncremental(boolean incremental)
public void setIncremental(java.lang.String incremental)
public java.lang.String getOutputForIncremental()
public void setOutputForIncremental(java.lang.String outputForIncremental)
outputForIncremental
- output file namepublic java.lang.String getServerType()
public void setServerType(java.lang.String serverType)
serverType
- a server type characterpublic boolean isSSL()
public void setSSL(java.lang.String isSSL)
isSSL
- true to enable SSL, otherwise false.public java.lang.String getProjectpassword()
public void setProjectpassword(java.lang.String projectpassword)
projectpassword
- project passwordpublic boolean isUpdateModule()
public void setUpdateModule(java.lang.String updateModule)
updateModule
- true to force update module, otherwise false.public java.lang.String getBranchName()
public void setBranchName(java.lang.String branchName)
branchName
- a branch namepublic java.lang.String getPropertiesFileName()
public void setPropertiesFileName(java.lang.String propertiesFileName) throws java.lang.IllegalArgumentException
propertiesFileName
- the properties file name to setjava.lang.IllegalArgumentException
- if properties file name is null.public boolean isVerbose()
public void setVerbose(boolean verbose)
verbose
- the verbose to setpublic boolean isOverwrite()
public void setOverwrite(boolean overwrite)
overwrite
- the overwrite to setpublic java.lang.Boolean getRecursive()
public void setRecursive(java.lang.Boolean recursive)
recursive
- recursive element or notpublic java.lang.String getUrl()
public void setUrl(java.lang.String url)
url
- URL for upload generated output.public boolean isFoundUpload()
public void setFoundUpload(boolean foundUpload)
foundUpload
- true to upload output after generatedpublic boolean isUseEncryptedPassword()
public void setUseEncryptedPassword(boolean useEncryptedPassword)
useEncryptedPassword
- true if user use encrypted passwordpublic boolean isWarningPackageNotFound()
public void setWarningPackageNotFound(boolean warningPackageNotFound)
warningPackageNotFound
- true if found Package Not Foundpublic java.util.List<java.lang.String> getPropertiesFileList()
public void setPropertiesFileList(java.util.List<java.lang.String> propertiesFileList)
public java.util.List<java.lang.String> getPackageNameList()
public void setPackageNameList(java.util.List<java.lang.String> packageNameList)
public java.util.List<java.lang.String> getElementNameList()
public void setElementNameList(java.util.List<java.lang.String> elementNameList)
public java.util.List<java.lang.String> getElementIdList()
public void setElementIdList(java.util.List<java.lang.String> elementIdList)
public java.lang.Boolean getIncludeAuxiliary()
public void setIncludeAuxiliary(java.lang.Boolean includeAuxiliary)
public java.lang.String[] getAllId()
public void setAllId(java.lang.String[] allId)
public boolean isActiveValidationEnabled()
public void setActiveValidationEnabled(boolean activeValidationEnabled)
public boolean isPackageElementSpecified()
public void setPackageElementSpecified(boolean packageElementSpecified)
protected java.lang.String promptPassword()
protected java.lang.String promptUsername()
public void parseArguments(java.lang.String[] args) throws java.lang.IllegalArgumentException, java.io.IOException
args
- the command line argument.java.lang.IllegalArgumentException
- the IllegalArgumentException may be propagation from setter methodjava.io.IOException
- when unable to read properties file.public void generate() throws java.lang.IllegalArgumentException, java.rmi.RemoteException, com.nomagic.magicreport.TemplateException
com.nomagic.magicreport.TemplateException
- when error occurs while generating report.java.rmi.RemoteException
- failed or I/O error occurs while connecting to team work server.java.lang.IllegalArgumentException
- the given parameter in class is not correct.public void generate(com.nomagic.magicdraw.core.Project project) throws java.lang.IllegalArgumentException, java.rmi.RemoteException, com.nomagic.magicreport.TemplateException
project
- specific projectcom.nomagic.magicreport.TemplateException
- when error occurs while generating report.java.rmi.RemoteException
- failed or I/O error occurs while connecting to team work server.java.lang.IllegalArgumentException
- the given parameter in class is not correct.protected com.nomagic.magicdraw.core.Project openProject() throws java.rmi.RemoteException
java.rmi.RemoteException
protected com.nomagic.magicdraw.core.Project createProject(java.lang.String projectName, java.lang.String serverName, java.lang.String userName, java.lang.String pwd) throws java.lang.IllegalArgumentException, java.rmi.RemoteException
projectName
- project nameserverName
- server nameuserName
- login namepwd
- passwordjava.lang.IllegalArgumentException
- the IllegalArgumentException may be thrown and print the error messagejava.rmi.RemoteException
- the RemoteException may be thrown and print the error messageprotected com.nomagic.magicdraw.core.Project createProject(java.lang.String projectName) throws java.lang.IllegalArgumentException
projectName
- project name to create projectjava.lang.IllegalArgumentException
- the IllegalArgumentException may be thrown and print the error messageprotected java.lang.String[] findPackageIds(com.nomagic.magicdraw.core.Project proj, java.util.List<java.lang.String> packageName)
proj
- project to find package idpackageName
- given package nameprotected java.lang.String[] findPackageIds(com.nomagic.magicdraw.core.Project proj, java.util.List<java.lang.String> packageName, java.lang.String serverType, java.util.List<java.lang.String> projectUsagesPackageName, java.lang.Boolean includeAuxiliary)
proj
- project to find package idpackageName
- given package nameprojectType
- a server type e.g. twcloudprojectUsagesPackageName
- list of package in project usagesincludeAuxiliary
- true to include auxiliaryprotected java.lang.String[] findPackageIds(com.nomagic.magicdraw.core.Project proj, java.util.List<java.lang.String> packageName, java.lang.String serverType, java.util.List<java.lang.String> packageInProjectUsageName, java.lang.Boolean includeAuxiliary, java.lang.Boolean includeAllProjectUsages)
proj
- project to find package idpackageName
- given package nameprojectType
- a server type e.g. twcloudpackageInProjectUsageName
- list of package in project usagesincludeAuxiliary
- true to include auxiliaryincludeAllProjectUsages
- true to show all project usages. (For tw cloud only)protected java.lang.String[] findElementIds(com.nomagic.magicdraw.core.Project proj, java.util.List<java.lang.String> elementName)
proj
- project to find element idelementName
- given element nameprotected java.lang.String[] findElementIds(com.nomagic.magicdraw.core.Project proj, java.util.List<java.lang.String> elementName, java.lang.String serverType, java.util.List<java.lang.String> projectUsagesElementName, java.lang.Boolean includeAuxiliary)
proj
- project to find element idelementName
- given element nameserverType
- a server type e.g. twcloudprojectUsagesElementName
- list of package in project usagesincludeAuxiliary
- true to include auxiliaryprotected java.lang.String[] findElementIds(com.nomagic.magicdraw.core.Project proj, java.util.List<java.lang.String> elementName, java.lang.String serverType, java.util.List<java.lang.String> elementInProjectUsageName, java.lang.Boolean includeAuxiliary, java.lang.Boolean includeAllProjectUsages)
proj
- project to find element idelementName
- given element nameserverType
- a server type e.g. twcloudelementInProjectUsageName
- list of element in project usagesincludeAuxiliary
- true to include auxiliaryincludeAllProjectUsages
- true to show all project usages. (For tw cloud only)protected java.lang.String[] findPackageAndElementIds(com.nomagic.magicdraw.core.Project proj, java.lang.String serverType, java.util.List<java.lang.String> selectedPacakgeList, java.util.List<java.lang.String> selectedElementList, java.util.List<java.lang.String> selectedPackageInUsageList, java.util.List<java.lang.String> selectedElementInUsageList, java.lang.Boolean includeAuxiliary, boolean isIncludeAllProjectUsages)
proj
- project to find element idserverType
- a server type e.g. twcloudselectedPacakgeList
- given package nameselectedElementList
- given element nameselectedPackageInUsageList
- list of package in project usagesselectedElementInUsageList
- list of element in project usagesincludeAuxiliary
- true to include auxiliaryisIncludeAllProjectUsages
- true to show all project usages. (For tw cloud only)protected TemplateBean createTemplateBean(@CheckForNull java.lang.String catName, java.lang.String templName)
catName
- categoryName or nulltemplName
- the template nameprotected ReportBean findReportBean(TemplateBean templateBean, java.lang.String name)
templateBean
- template to fine report beanname
- the report nameprotected static void printUsage()
protected static void printUsage(java.io.PrintStream printStream)
printStream
- the print stream@Deprecated public void start() throws com.nomagic.runtime.ApplicationExitedException
CommandLine.launch(String[])
com.nomagic.runtime.ApplicationExitedException
- when failed to start the application@Deprecated public void start(java.lang.String[] args) throws com.nomagic.runtime.ApplicationExitedException, java.lang.IllegalArgumentException, java.io.IOException
CommandLine.launch(String[])
args
- the command line argument.com.nomagic.runtime.ApplicationExitedException
- when failed to start the applicationjava.lang.IllegalArgumentException
- the IllegalArgumentException may be propagation from setter methodjava.io.IOException
- when I/O error occurs.public void shutdown() throws com.nomagic.runtime.ApplicationExitedException
com.nomagic.runtime.ApplicationExitedException
- when failed to terminal the applicationpublic java.util.Properties loadProperties(java.io.InputStream inStream, java.lang.String encodeType) throws java.io.IOException
inStream
- the stream of properties file to readencodeType
- the encoding type of properties filejava.io.IOException
- IOException might be throwpublic static java.lang.String getEncryptedPassword(java.lang.String password)
password
- password in plain textpublic boolean isGeneratePassword(java.lang.String[] args)
args
- argumentpublic boolean isShowUsage(java.lang.String[] args)
args
- argumentprotected void uploadToServer(com.nomagic.magicreport.engine.ITemplateEngine engine, java.lang.String outputFile) throws java.lang.Exception
engine
- engineoutputFile
- outputFilejava.lang.Exception
- exceptionprotected void executeUpload(com.nomagic.magicreport.engine.ITemplateEngine engine, java.lang.String outputFile, com.nomagic.magicdraw.magicreport.upload.profiles.ServerProfileBean profile, java.net.URI uri) throws java.lang.Exception
engine
- engineoutputFile
- outputFileprofile
- profilejava.lang.Exception
- exceptionprotected byte execute()
execute
in class com.nomagic.magicdraw.commandline.CommandLine
public static void main(java.lang.String[] args)
args
- arguments which given by user