|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.change_vision.jude.api.inf.project.ProjectAccessor
Interface to Operate JUDE project.
Field Summary | |
static int |
REFERENCE_PROJECT_STATUS_LATEST
|
static int |
REFERENCE_PROJECT_STATUS_NEED_UPDATE
|
static int |
REFERENCE_PROJECT_STATUS_NOT_FOUND
|
Method Summary | |
abstract void |
addReferenceProject(String path)
Add Reference Project in JUDE Project. |
abstract void |
changeReferenceProject(String fromPath,
String toPath)
Change Reference Project Path in JUDE Project. |
abstract void |
clearReferenceProject(String path)
Clear Reference Project in JUDE Project. |
abstract void |
close()
Close JUDE Project. |
abstract void |
create(String projectPath,
boolean useDefinedTaggedValues)
Create JUDE Project. |
abstract void |
create(String projectPath)
Create JUDE Project without loading the user defined tagged values. |
abstract void |
easyMerge(String path,
boolean isKeepBase)
Merge a project into the current project. |
abstract void |
exportXMI(String fileName)
Save JUDE Project as parameter's name. |
abstract IModel |
getProject()
Get Model of project accessor. |
abstract String[] |
getReferenceProjectPaths()
Get Reference Project Paths in JUDE Project. |
abstract int |
getReferenceProjectStatus(String path)
Get Reference Project Status in JUDE Project. |
abstract void |
importXMI(String projectName)
Open JUDE Project's XMI. |
abstract void |
importXMI(String projectName,
boolean isIgnoreModelVersion)
Open JUDE Project's XMI. |
abstract void |
open(String projectName)
Open JUDE Project. |
abstract void |
open(String projectName,
boolean isIgnoreModelVersion)
Open JUDE Project. |
abstract void |
open(String projectName,
boolean isIgnoreModelVersion,
boolean lockMode,
boolean allowReadOnly)
Open JUDE Project. |
abstract void |
open(InputStream in)
Open JUDE Project. |
abstract void |
open(InputStream in,
boolean isIgnoreModelVersion)
Open JUDE Project. |
abstract void |
removeReferenceProject(String path)
Delete Reference Project in JUDE Project. |
abstract void |
save()
Save JUDE Project. |
abstract void |
saveAs(String projectName)
Save JUDE Project as parameter's name. |
abstract void |
updateReferenceProject(String path)
Update Reference Project in JUDE Project. |
abstract void |
validateProject()
Find invalid models in JUDE project |
Field Detail |
public static final int REFERENCE_PROJECT_STATUS_LATEST
public static final int REFERENCE_PROJECT_STATUS_NEED_UPDATE
public static final int REFERENCE_PROJECT_STATUS_NOT_FOUND
Method Detail |
public abstract void open(String projectName)
projectName
- Project Name
LicenseNotFoundException
- License cannot be found
ProjectNotFoundException
- Project cannot be found
NonCompatibleException
- Old Model Version (The version of API is older than the version of JUDE this project has been last edited with)
ClassNotFoundException
- Cannot read some models
IOException
- input/output error
ProjectLockedException
- Project file has been lockedpublic abstract void open(String projectName, boolean isIgnoreModelVersion)
projectName
- Project NameisIgnoreModelVersion
- Select if you need a Model Version Check
LicenseNotFoundException
- License cannot be found
ProjectNotFoundException
- Project cannot be found
NonCompatibleException
- Old Model Version (The version of API is older than the version of JUDE this project has been last edited with)
ClassNotFoundException
- Cannot read some models
IOException
- input/output error
ProjectLockedException
- Project file has been lockedpublic abstract void open(String projectName, boolean isIgnoreModelVersion, boolean lockMode, boolean allowReadOnly)
projectName
- Project NameisIgnoreModelVersion
- Select if you need a Model Version ChecklockMode
- Select if you lock a project fileallowReadOnly
- Select if you open a project in ReadOnly mode when it has been locked.
LicenseNotFoundException
- License cannot be found
ProjectNotFoundException
- Project cannot be found
NonCompatibleException
- Old Model Version (The version of API is older than the version of JUDE this project has been last edited with)
ClassNotFoundException
- Cannot read some models
IOException
- input/output error
ProjectLockedException
- Project file has been lockedpublic abstract void saveAs(String projectName)
LicenseNotFoundException
- License cannot be found
ProjectNotFoundException
- Project cannot be found
IOException
- input/output error
ProjectLockedException
- Project file has been lockedpublic abstract void importXMI(String projectName)
projectName
- Project Name
LicenseNotFoundException
- License cannot be found
ProjectNotFoundException
- Project cannot be found
NonCompatibleException
- Old Model Version (The version of API is older than the version of JUDE this project has been last edited with)
ClassNotFoundException
- Cannot read some models
IOException
- input/output errorpublic abstract void importXMI(String projectName, boolean isIgnoreModelVersion)
projectName
- Project NameisIgnoreModelVersion
- Select if you need a Model Version Check
LicenseNotFoundException
- License cannot be found
ProjectNotFoundException
- Project cannot be found
NonCompatibleException
- Old Model Version (The version of API is older than the version of JUDE this project has been last edited with)
ClassNotFoundException
- Cannot read some models
IOException
- input/output errorpublic abstract void exportXMI(String fileName)
fileName
- File Name
LicenseNotFoundException
- License cannot be found
ProjectNotFoundException
- Project cannot be found
IOException
- input/output errorpublic abstract void open(InputStream in)
in
- InputStream
LicenseNotFoundException
- License cannot be found
ProjectNotFoundException
- Project cannot be found
NonCompatibleException
- Old Model Version (The version of API is older than the version of JUDE this project has been last edited with)
ClassNotFoundException
- Cannot read some models
IOException
- input/output error
ProjectLockedException
- Project file has been lockedpublic abstract void open(InputStream in, boolean isIgnoreModelVersion)
in
- InputStreamisIgnoreModelVersion
- Select if you need a Model Version Check
LicenseNotFoundException
- License cannot be found
ProjectNotFoundException
- Project cannot be found
NonCompatibleException
- Old Model Version (The version of API is older than the version of JUDE this project has been last edited with)
ClassNotFoundException
- Cannot read some models
IOException
- input/output errorpublic abstract IModel getProject()
public abstract void close()
public abstract void create(String projectPath, boolean useDefinedTaggedValues)
projectPath
- Project PathuseDefinedTaggedValues
- Set if you need to load the user defined tagged values as creating the project
IOException
- input/output errorpublic abstract void create(String projectPath)
projectPath
- Project Path
IOException
- input/output errorpublic abstract void save()
LicenseNotFoundException
- License cannot be found
ProjectNotFoundException
- Project cannot be found
IOException
- input/output error
ProjectLockedException
- Project has been lockedpublic abstract void validateProject()
ProjectNotFoundException
- Project doesn't exist
InvalidEditingException
- Invalid models existpublic abstract void addReferenceProject(String path)
path
- Reference Project Path. Absolute/Relative Path can be specified.
ProjectNotFoundException
- Project doesn't exist
InvalidEditingException
- Invalid models exist
Keys: ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in JUDE/Community. PARAMETER_ERROR_KEY - if a parameter is not set properly.
Values: Error messages for exceptions.
public abstract void removeReferenceProject(String path)
path
- Reference Project Path. Absolute/Relative Path can be specified.
ProjectNotFoundException
- Project doesn't exist
InvalidEditingException
- Invalid models exist
Keys: ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in JUDE/Community. PARAMETER_ERROR_KEY - if a parameter is not set properly.
Values: Error messages for exceptions.
public abstract void updateReferenceProject(String path)
path
- Reference Project Path. Absolute/Relative Path can be specified.
ProjectNotFoundException
- Project doesn't exist
InvalidEditingException
- Invalid models exist
Keys: ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in JUDE/Community. PARAMETER_ERROR_KEY - if a parameter is not set properly.
Values: Error messages for exceptions.
public abstract void clearReferenceProject(String path)
path
- Reference Project Path. Absolute/Relative Path can be specified.
ProjectNotFoundException
- Project doesn't exist
InvalidEditingException
- Invalid models exist
Keys: ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in JUDE/Community. PARAMETER_ERROR_KEY - if a parameter is not set properly.
Values: Error messages for exceptions.
public abstract void changeReferenceProject(String fromPath, String toPath)
fromPath
- Original Reference Project Path. Absolute/Relative Path can be specified.toPath
- New Reference Project Path
Absolute/Relative Path can be specified.
ProjectNotFoundException
- Project doesn't exist
InvalidEditingException
- Invalid models exist
Keys: ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in JUDE/Community. PARAMETER_ERROR_KEY - if a parameter is not set properly.
Values: Error messages for exceptions.
public abstract String[] getReferenceProjectPaths()
ProjectNotFoundException
- Project doesn't existpublic abstract int getReferenceProjectStatus(String path)
path
- Reference Project Path. Absolute/Relative Path can be specified.
ProjectAccessor.REFERENCE_PROJECT_STATUS_LATEST:Latest ProjectAccessor.REFERENCE_PROJECT_STATUS_NEED_UPDATE :Need Update ProjectAccessor.REFERENCE_PROJECT_STATUS_NOT_FOUND :Not Found
ProjectNotFoundException
- Project doesn't existpublic abstract void easyMerge(String path, boolean isKeepBase)
path
- Reference Project Path. Absolute/Relative Path can be specified.isKeepBase
- When differences found, keep current or overwrite with reference.
ProjectNotFoundException
- Project doesn't exist
InvalidEditingException
- Invalid models exist
Keys: ILLEGAL_VERSION_ERROR_KEY - if Editing API is used in JUDE/Community. CAN_NOT_MERGE_IN_TRANSACTION_KEY - if a file is merged in transaction. CAN_NOT_MERGE_WHEN_CURRENT_HAS_REFERENCE_PROJRCT_KEY - if a file is merged to the current project with reference models. PARAMETER_ERROR_KEY - if a parameter is not set properly.
Values: Error messages for exceptions.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |