Constructor and Description |
---|
AbstractAnalysis() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getNotReadyToRunReason()
If for some reason the
run() method could not be called,
the reason is given as a human readable String that can be
displayed to the user. |
boolean |
readyToRun()
For all analyses, this method ensures that the parameter still exists.
|
boolean |
run()
Execute the analysis based on the parameter.
|
void |
setConfiguratorKeysAndValues(java.util.HashMap<java.lang.String,java.lang.String> keysAndValues) |
void |
setParameter(org.eclipse.emf.common.util.URI parameterPath,
java.lang.String readablePath)
Depending on the analysis, the parameter is the model,
ComponentImpl , SystemImpl , or other
AObject that the analysis runs on. |
public final void setParameter(org.eclipse.emf.common.util.URI parameterPath, java.lang.String readablePath)
IAnalysis
ComponentImpl
, SystemImpl
, or other
AObject
that the analysis runs on. The appropriate
parameter is dependent on the specific
org.osate.ui.analysis
extension.
setParameter
does not validate the parameter. It is the
responsibility of this method's caller to ensure that the parameter is
appropriate according to the analysis' plugin.xml
file.setParameter
in interface IAnalysis
parameterPath
- The URI
path of the parameter which
can be found by calling
EcoreUtil.getURI(EObject)
.readablePath
- A textual representation of the parameter including
its location that can be displayed to the user.public final void setConfiguratorKeysAndValues(java.util.HashMap<java.lang.String,java.lang.String> keysAndValues)
setConfiguratorKeysAndValues
in interface IAnalysis
public final boolean readyToRun()
IAnalysis
String
and can be retrieved through getNotReadyToRunReason()
.readyToRun
in interface IAnalysis
true
if the run()
method can be
called; false
if it cannot.public final java.lang.String getNotReadyToRunReason()
IAnalysis
run()
method could not be called,
the reason is given as a human readable String
that can be
displayed to the user.getNotReadyToRunReason
in interface IAnalysis
run()
could not be called.public final boolean run()
IAnalysis
true
is returned. If the analysis failed, then
false
is returned. For most analyses, failure is reported
through problem markers on the model, however this behavior is not
guaranteed for all analyses. See each analysis for failure details.