|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HighLevelProcess
Defines the data operations that are available for a high-level process.
Note that the interface specifies the maximum set of high-level information
that can be provided for a process. However, some of these data represent a
different view on the same thing, that is, they are in conflict with each other.
This means that, although all the available information can be provided, eventually
only a subset of it might be used (for example, based on the user's choice).
Note further that there is no need to provide all the information that can be
specified via this interface. If for a specific concept no value is available,
this simply means that it is "unknown".
HighLevelActivity
,
HighLevelChoice
Nested Class Summary | |
---|---|
static class |
HighLevelProcess.Perspective
Class representing a perspective that may be covered by the HighLevelProcess A HighLevelProcess model may cover more than one perspective. |
static class |
HighLevelProcess.TimeUnit
Class representing a time unit, such as "hour" or "millisecond". |
Method Summary | |
---|---|
void |
addChoice(HighLevelChoice choice)
Adds a new choice construct to this high level petri process. |
boolean |
addDataAttribute(HighLevelDataAttribute att)
Adds a new data attribute to this process. |
void |
addDataDependency(HighLevelDataDependency expression)
Adds a data dependency to this process. |
boolean |
addGroup(HighLevelGroup grp)
Adds a group to this process. |
HighLevelGroup |
addGroup(java.lang.String name)
Creates a new group for this process. |
void |
addPerspective(HighLevelProcess.Perspective perspective)
Adds a perspective that is covered by this simulation model |
void |
addProbabilityDependency(HighLevelProbabilityDependency prob)
Add a probability dependency to this process. |
boolean |
addResource(HighLevelResource res)
Adds a new resource to this process. |
HighLevelResource |
addResource(java.lang.String name)
Creates a new resource for this process. |
boolean |
addResourceToGroup(HighLevelGroup group,
HighLevelResource resource)
Adds the given resource to the given group. |
java.lang.Object |
clone()
Clones the highlevelprocess. |
HighLevelProcess |
cloneWithDefaultSimulationInformation()
Clones the highlevelprocess in which the underlying process model is the same, but that the highlevelactivities and the highlevelchoices are cloned. |
boolean |
equals(java.lang.Object obj)
Determines when two highLevelProcesses are the same. |
HighLevelActivity |
findHighLevelActivity(ModelGraphVertex v)
Returns the HighLevelActivity object belonging to the given transition. |
ModelGraphVertex |
findModelGraphVertex(HighLevelActivity act)
Returns the ModelGraphVertex in the graph that corresponds to the given highlevelactivity |
Distribution |
getCaseGenerationScheme()
Retrieves the case arrival distribution for this process. |
java.util.List<HighLevelChoice> |
getChoices()
Retrieves the list of HighLevelChoices contained in this process. |
java.util.Set<HighLevelDataAttribute> |
getDataAttributes()
Retrieves the list of data attributes available for this process. |
java.util.List<HighLevelDataDependency> |
getDataDependencies()
Retrieves the data dependencies specified for this process. |
java.util.List<ModelGraphVertex> |
getGraphNodes()
Retrieves the nodes of the process model that belongs to the highlevel process |
java.util.List<HighLevelGroup> |
getGroups()
Retrieves the list of groups available for this process. |
java.util.List<HighLevelActivity> |
getHighLevelActivities()
Retrieves the high level activities for this process. |
java.lang.String |
getName()
Retrieves the name of this highlevelprocess. |
java.util.Set<HighLevelProcess.Perspective> |
getPerspectives()
Retrieves the set of perspectives that is covered by this HighLevelProcess |
java.util.List<HighLevelProbabilityDependency> |
getProbabilityDependencies()
Retrieves the probability dependencies specified for this process. |
java.util.Set<HighLevelResource> |
getResources()
Retrieves the list of resources available for this process. |
HighLevelProcess.TimeUnit |
getTimeUnit()
Retrieves the unit in which all the provided information related to time can be interpreted. |
javax.swing.JPanel |
getVisualization(java.util.Set<HighLevelProcess.Perspective> perspectivesToShow)
Creates a visualization of the simulation model for the given perspectives. |
int |
getYearOffset()
Retrieves the year offset that is used for logging. |
int |
hashCode()
Retrieves the hashcode value for the object. |
void |
removeAllDataAttributes()
Removes all data attributes from this process |
void |
removeAllGroups()
Remove all groups. |
void |
removeAllResources()
Remove all resources. |
boolean |
removeChoice(HighLevelChoice choice)
Removes the given choice from this process. |
boolean |
removeDataAttribute(HighLevelDataAttribute att)
Removes the given data attribute from this process. |
boolean |
removeGroup(HighLevelGroup grp)
Removes the given group from this process. |
boolean |
removeResource(HighLevelResource src)
Removes the given resource from this process. |
boolean |
removeResourceFromGroup(HighLevelGroup group,
HighLevelResource resource)
Removes the given resource from the given group. |
void |
setCaseGenerationScheme(Distribution dist)
Provides a case arrival distribution for this process. |
void |
setHighLevelActivity(ModelGraphVertex vertex,
HighLevelActivity activity)
Sets the corresponding highlevelactivity for a node of the process model that belongs to the highlevelprocess. |
void |
setName(java.lang.String name)
Sets the name of the highlevelprocess |
void |
setTimeUnit(HighLevelProcess.TimeUnit unit)
Specifies the unit in which all the provided information related to time can be interpreted. |
void |
setYearOffset(int offset)
Sets the year offset that is used for logging. |
java.lang.String |
toString()
Overrides the toString() method. |
void |
writeToTestLog()
Writes the highlevelprocess to the test log. |
Method Detail |
---|
void setName(java.lang.String name)
name
- String the name of the highlevelprocessjava.lang.String getName()
java.lang.String toString()
toString
in class java.lang.Object
java.util.List<HighLevelActivity> getHighLevelActivities()
getChoices()
java.util.List<ModelGraphVertex> getGraphNodes()
void setHighLevelActivity(ModelGraphVertex vertex, HighLevelActivity activity)
vertex
- ModelGraphVertex a node in the process model that belongs to the highlevelprocessactivity
- HighLevelActivity the highlevelactivity that has to be assigned to the node in
the process model.HighLevelActivity findHighLevelActivity(ModelGraphVertex v)
v
- ModelGraphVertex the vertex for which the corresponding simulation information object is to be found
Null
otherwiseModelGraphVertex findModelGraphVertex(HighLevelActivity act)
act
- HighLevelActivity the highlevelactivity for which we want to have the corresponding
modelgraphVertex in the graph
void setTimeUnit(HighLevelProcess.TimeUnit unit)
unit
- the time unit to be used for interpretation#getCaseGenerationScheme(Distribution)
,
HighLevelActivity.getExecutionTime()
,
HighLevelActivity.getWaitingTime()
,
HighLevelActivity.getSojournTime()
HighLevelProcess.TimeUnit getTimeUnit()
Null
otherwise#getCaseGenerationScheme(Distribution)
,
HighLevelActivity.getExecutionTime()
,
HighLevelActivity.getWaitingTime()
,
HighLevelActivity.getSojournTime()
void setYearOffset(int offset)
offset
- intint getYearOffset()
void setCaseGenerationScheme(Distribution dist)
dist
- the distribution of the processDistribution getCaseGenerationScheme()
void addDataDependency(HighLevelDataDependency expression)
expression
- the data dependency to be added#addProbabilityDependency(ProbabilityDependency)
,
HighLevelActivity#addFrequencyDependency(int)
java.util.List<HighLevelDataDependency> getDataDependencies()
getProbabilityDependencies()
,
HighLevelActivity.getFrequencyDependency()
void addProbabilityDependency(HighLevelProbabilityDependency prob)
prob
- the probability dependency to be added#addDataDependency(DataDependency)
,
HighLevelActivity#addFrequencyDependency(int)
java.util.List<HighLevelProbabilityDependency> getProbabilityDependencies()
getDataDependencies()
,
HighLevelActivity#getFrequencyDependencies()
boolean addDataAttribute(HighLevelDataAttribute att)
att
- the attributed to be added
True
if the data attribute was not defined for this process
already (it has been added), false
otherwise (method call had no effect)boolean removeDataAttribute(HighLevelDataAttribute att)
att
- the attribute to be removed
true
if the data attribute was found and removed, false
otherwisevoid removeAllDataAttributes()
java.util.Set<HighLevelDataAttribute> getDataAttributes()
HighLevelResource addResource(java.lang.String name)
res
- the resource to be added
boolean addResource(HighLevelResource res)
res
- the resource to be added
True
if the resource was not defined for this process already (it has been added),
false
otherwise (method call had no effect)boolean removeResource(HighLevelResource src)
src
- the resource to be removed
true
if the resource was found and removed, false
otherwisevoid removeAllResources()
java.util.Set<HighLevelResource> getResources()
addResource(java.lang.String)
method, addResourceToGroup(org.processmining.framework.models.hlprocess.HighLevelGroup, org.processmining.framework.models.hlprocess.HighLevelResource)
method (but were not added via
addResource(java.lang.String)
before), and HighLevelActivity.setGroup(HighLevelGroup)
method.
HighLevelGroup addGroup(java.lang.String name)
name
- the name of the group to be created
getGroups()
,
#addResourceToGroup()
,
#removeResourceFromGroup()
boolean addGroup(HighLevelGroup grp)
grp
- HighLevelGroup the highlevel group
True
if the group was not defined for this process already (it has been added),
false
otherwise (method call had no effect)boolean removeGroup(HighLevelGroup grp)
grp
- the group to be removed
true
if the group was found and removed, false
otherwisevoid removeAllGroups()
java.util.List<HighLevelGroup> getGroups()
addGroup(java.lang.String)
method, addResourceToGroup(org.processmining.framework.models.hlprocess.HighLevelGroup, org.processmining.framework.models.hlprocess.HighLevelResource)
method
(but were not created via addGroup(java.lang.String)
before), and HighLevelActivity.setGroup(HighLevelGroup)
method.
boolean addResourceToGroup(HighLevelGroup group, HighLevelResource resource)
group
- the group to which the specified resource is to be addedresource
- the resource to be added
True
if the resource was not part of this group already (it has been added).
False
otherwise (method call had no effect)addGroup(String)
,
getGroups()
,
removeResourceFromGroup(HighLevelGroup, HighLevelResource)
boolean removeResourceFromGroup(HighLevelGroup group, HighLevelResource resource)
group
- the group to which the specified resource is to be removedresource
- the resource to be removed
True
if the group exists for this process and the resource was
part of this group (it has been removed).
False
otherwise (method call had no effect)addGroup(String)
,
getGroups()
,
addResourceToGroup(HighLevelGroup, HighLevelResource)
void addChoice(HighLevelChoice choice)
choice
- the new choice construct to be addedjava.util.List<HighLevelChoice> getChoices()
boolean removeChoice(HighLevelChoice choice)
grp
- the choice to be removed
true
if the choice was found and removed, false
otherwiseboolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- Object
int hashCode()
hashCode
in class java.lang.Object
void addPerspective(HighLevelProcess.Perspective perspective)
java.util.Set<HighLevelProcess.Perspective> getPerspectives()
java.lang.Object clone()
HighLevelProcess cloneWithDefaultSimulationInformation()
javax.swing.JPanel getVisualization(java.util.Set<HighLevelProcess.Perspective> perspectivesToShow)
perspectivesToShow
- List the perspectives that need to shown in the visualization of the
simulation model.
void writeToTestLog()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |