Model

java.lang.Object
- org.barrelorgandiscovery.model.Model

All Implemented Interfaces:

java.io.Serializable
```
public class Model
extends java.lang.Object
implements java.io.Serializable
```
Model mainting a processing model, a collection of modelstep and modellink between model parameters

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Model()

Constructors
Constructor and Description
`Model()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addModelLink(ModelLink link)` Add link to the model
`void`	`addModelStep(ModelStep step)`
`protected int`	`computeSchedule(ModelStep sinkStep)` Compute internal step scheduling from the sink node specified in parameter, the internal orderedScheduleStep define then the executed time schedule
`protected void`	`createNewOrderedCollection()`
`java.lang.String`	`dump()` Dump the model steps and the links of the model (useful for debugging)
`ModelLink`	`findLinkById(java.lang.String id)`
`ModelStep`	`findModelStepById(java.lang.String id)`
`AbstractParameter`	`findParameterById(java.lang.String id)` find a parameter by id
`java.util.Set<ModelLink>`	`getAllLinksAssociatedTo(ModelStep step)` List links associated to a step (origin or destination)
`java.util.Set<ModelLink>`	`getFollowingLinksAssociatedTo(ModelStep step)`
`TerminalParameterModelStep`	`getInTerminalByName(java.lang.String name)`
`java.util.Set<ModelLink>`	`getLinksConnectedToParameter(ModelParameter param, boolean source)`
`TerminalParameterModelStep`	`getOutTerminalByName(java.lang.String name)`
`java.util.Set<ModelLink>`	`getPrecedingLinksAssociatedTo(ModelStep step)` Get all the link that are linked to the destination step "step". this does not depend on the kind of parameter
`java.util.Set<ModelParameter>`	`getRequiredModelParameter(ModelStep step)` List requiered parameters associated to a step
`java.util.ArrayList<TerminalParameterModelStep>`	`getTerminalModelStep(boolean filterOutParameters)` Find all terminalmodelstep
`void`	`hydrateContext(java.util.Map<java.lang.String,java.lang.Object> context)`
`boolean`	`isScheduled()` Is the schedule done ?
`protected void`	`razSchedule()` reset to -1 modelstep schedule
`void`	`removeLink(ModelLink link)` Remove link, this method invalidate the schedule
`void`	`removeLinkById(java.lang.String id)` Remove link by its id
`void`	`removeStepAndDisconnectLinks(ModelStep step)` Remove the step and disconnect from existing links
`java.util.Set<ModelStep>`	`schedule()` Compute the schedule for all terminate elements
`void`	`visit(ModelVisitor visitor)` Visit the model, on all steps
`protected void`	`visit(java.util.Set<ModelStep> elements, ModelVisitor visitor)` Visit the model elements, ordered by the elements passed in parameters
`void`	`visitBySchedule(ModelVisitor visitor)` Visit on scheduled model, on scheduled steps

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Model
```
public Model()
```
- Method Detail
  - addModelStep
```
public void addModelStep(ModelStep step)
                  throws java.lang.Exception
```
    Parameters:
    
    step -
    
    Throws:
    
    java.lang.Exception
  - addModelLink
```
public void addModelLink(ModelLink link)
                  throws java.lang.Exception
```
    Add link to the model
    
    Parameters:
    
    link -
    
    Throws:
    
    java.lang.Exception - if the link is not properly associated to the model
  - removeStepAndDisconnectLinks
```
public void removeStepAndDisconnectLinks(ModelStep step)
                                  throws java.lang.Exception
```
    Remove the step and disconnect from existing links
    
    Parameters:
    
    step -
    
    Throws:
    
    java.lang.Exception
  - removeLink
```
public void removeLink(ModelLink link)
```
    Remove link, this method invalidate the schedule
    
    Parameters:
    
    link -
  - removeLinkById
```
public void removeLinkById(java.lang.String id)
```
    Remove link by its id
    
    Parameters:
    
    id -
  - getAllLinksAssociatedTo
```
public java.util.Set<ModelLink> getAllLinksAssociatedTo(ModelStep step)
```
    List links associated to a step (origin or destination)
  - getLinksConnectedToParameter
```
public java.util.Set<ModelLink> getLinksConnectedToParameter(ModelParameter param,
                                                             boolean source)
```
    Parameters:
    
    param -
    
    Returns:
  - getPrecedingLinksAssociatedTo
```
public java.util.Set<ModelLink> getPrecedingLinksAssociatedTo(ModelStep step)
```
    Get all the link that are linked to the destination step "step". this does not depend on the kind of parameter
    
    Parameters:
    
    step -
    
    Returns:
    
    a set containing the steps
  - getFollowingLinksAssociatedTo
```
public java.util.Set<ModelLink> getFollowingLinksAssociatedTo(ModelStep step)
```
    Parameters:
    
    step -
    
    Returns:
  - isScheduled
```
public boolean isScheduled()
```
    Is the schedule done ?
    
    Returns:
  - computeSchedule
```
protected int computeSchedule(ModelStep sinkStep)
```
    Compute internal step scheduling from the sink node specified in parameter, the internal orderedScheduleStep define then the executed time schedule
    
    Parameters:
    
    sinkStep - the sink step
    
    Returns:
    
    maxlength
  - createNewOrderedCollection
```
protected void createNewOrderedCollection()
```
  - razSchedule
```
protected void razSchedule()
```
    reset to -1 modelstep schedule
  - getRequiredModelParameter
```
public java.util.Set<ModelParameter> getRequiredModelParameter(ModelStep step)
```
    List requiered parameters associated to a step
    
    Parameters:
    
    step -
    
    Returns:
  - findModelStepById
```
public ModelStep findModelStepById(java.lang.String id)
```
  - findLinkById
```
public ModelLink findLinkById(java.lang.String id)
```
  - findParameterById
```
public AbstractParameter findParameterById(java.lang.String id)
```
    find a parameter by id
    
    Parameters:
    
    id -
    
    Returns:
  - getTerminalModelStep
```
public java.util.ArrayList<TerminalParameterModelStep> getTerminalModelStep(boolean filterOutParameters)
```
    Find all terminalmodelstep
    
    Parameters:
    
    filterOutParameters - only terminalmodelstep that have out parameters
    
    Returns:
  - getOutTerminalByName
```
public TerminalParameterModelStep getOutTerminalByName(java.lang.String name)
```
  - getInTerminalByName
```
public TerminalParameterModelStep getInTerminalByName(java.lang.String name)
```
  - schedule
```
public java.util.Set<ModelStep> schedule()
```
    Compute the schedule for all terminate elements
    
    Returns:
  - dump
```
public java.lang.String dump()
```
    Dump the model steps and the links of the model (useful for debugging)
    
    Returns:
  - visitBySchedule
```
public void visitBySchedule(ModelVisitor visitor)
                     throws java.lang.Exception
```
    Visit on scheduled model, on scheduled steps
    
    Parameters:
    
    visitor -
    
    Throws:
    
    java.lang.Exception - raise exception if the model is not scheduled or if the visit raise exception
  - visit
```
public void visit(ModelVisitor visitor)
```
    Visit the model, on all steps
  - visit
```
protected void visit(java.util.Set<ModelStep> elements,
                     ModelVisitor visitor)
```
    Visit the model elements, ordered by the elements passed in parameters
    
    Parameters:
    
    elements -
    
    visitor -
  - hydrateContext
```
public void hydrateContext(java.util.Map<java.lang.String,java.lang.Object> context)
```
    Parameters:
    
    context -

Class Model

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Model

Method Detail

addModelStep

addModelLink

removeStepAndDisconnectLinks

removeLink

removeLinkById

getAllLinksAssociatedTo

getLinksConnectedToParameter

getPrecedingLinksAssociatedTo

getFollowingLinksAssociatedTo

isScheduled

computeSchedule

createNewOrderedCollection

razSchedule

getRequiredModelParameter

findModelStepById

findLinkById

findParameterById

getTerminalModelStep

getOutTerminalByName

getInTerminalByName

schedule

dump

visitBySchedule

visit

visit

hydrateContext