Processor

java.lang.Object
- repicea.simulation.processsystem.Processor

All Implemented Interfaces:

java.io.Serializable, java.util.EventListener, javax.swing.event.CaretListener, REpiceaUIObject, REpiceaUIObjectWithParent

Direct Known Subclasses:

AbstractProcessor
```
public class Processor
extends java.lang.Object
implements REpiceaUIObjectWithParent, REpiceaUIObject, javax.swing.event.CaretListener, java.io.Serializable
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`averageIntake` Deprecated.
`protected ProcessorButton`	`guiInterface`
`protected boolean`	`isTerminal`
`protected java.util.List<Processor>`	`subProcessors`

Constructor Summary

Constructors
Constructor and Description

Processor()
General constructor.

Processor(java.lang.String name)
General constructor with name.

Constructors
Constructor and Description
`Processor()` General constructor.
`Processor(java.lang.String name)` General constructor with name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSubProcessor(Processor processor)` This method adds a process to the sub processes.
`void`	`caretUpdate(javax.swing.event.CaretEvent evt)`
`protected java.util.List<ProcessUnit>`	`createProcessUnits(ProcessUnit inputUnit, int intake)`
`protected java.util.List<ProcessUnit>`	`createProcessUnitsFromThisProcessor(ProcessUnit inputUnit, int intake)`
`java.util.Collection<ProcessUnit>`	`doProcess(java.util.List<ProcessUnit> inputUnits)`
`java.lang.String`	`getName()` This method returns the name of the processor.
`protected java.awt.Point`	`getOriginalLocation()`
`protected REpiceaPanel`	`getProcessFeaturesPanel()` This method returns other process features when the processor button is double clicked.
`protected java.util.Map<Processor,java.lang.Integer>`	`getSubProcessorIntakes()` This method returns the processor intakes in a map.
`java.util.List<Processor>`	`getSubProcessors()` This method returns the processes that are subordinated to this one.
`ProcessorButton`	`getUI()` This method returns the GUI interface of the class that implements this interface.
`ProcessorButton`	`getUI(java.awt.Container container)` This method returns the GUI interface of the class that implements this interface.
`boolean`	`hasSubProcessors()` This method returns true if the processor has one or many subprocessors tied to itself or false otherwise.
`boolean`	`isPartOfEndlessLoop()`
`boolean`	`isTerminalProcessor()` This method returns true if the processor is a final processor, which means it cannot send anything to subprocessors.
`boolean`	`isValid()` This method checks if the wood processor is valid as well as all its subprocessors.
`boolean`	`isVisible()` This method returns true if the GUI is visible.
`void`	`removeSubProcessor(Processor processor)` This method removes a process from the sub processes.
`void`	`setName(java.lang.String str)` This method sets the name of the processor.
`protected void`	`setOriginalLocation(java.awt.Point relativePoint)`
`protected void`	`setPartOfEndlessLoop(boolean bool)`
`java.lang.String`	`toString()`

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

- Field Detail
  - guiInterface
```
protected transient ProcessorButton guiInterface
```
  - subProcessors
```
protected java.util.List<Processor> subProcessors
```
  - isTerminal
```
protected boolean isTerminal
```
  - averageIntake
```
@Deprecated
protected double averageIntake
```
    Deprecated.
- Constructor Detail
  - Processor
```
public Processor()
```
    General constructor.
  - Processor
```
public Processor(java.lang.String name)
```
    General constructor with name.
- Method Detail
  - isTerminalProcessor
```
public boolean isTerminalProcessor()
```
    This method returns true if the processor is a final processor, which means it cannot send anything to subprocessors.
    
    Returns:
    
    a boolean
  - doProcess
```
public java.util.Collection<ProcessUnit> doProcess(java.util.List<ProcessUnit> inputUnits)
```
  - createProcessUnits
```
protected final java.util.List<ProcessUnit> createProcessUnits(ProcessUnit inputUnit,
                                                               int intake)
```
  - createProcessUnitsFromThisProcessor
```
protected java.util.List<ProcessUnit> createProcessUnitsFromThisProcessor(ProcessUnit inputUnit,
                                                                          int intake)
```
  - addSubProcessor
```
public void addSubProcessor(Processor processor)
```
    This method adds a process to the sub processes.
    
    Parameters:
    
    processor - a Process instance
  - removeSubProcessor
```
public void removeSubProcessor(Processor processor)
```
    This method removes a process from the sub processes.
    
    Parameters:
    
    processor - a Process instance
  - getSubProcessors
```
public java.util.List<Processor> getSubProcessors()
```
    This method returns the processes that are subordinated to this one.
    
    Returns:
    
    a List of Processor instances.
  - getSubProcessorIntakes
```
protected java.util.Map<Processor,java.lang.Integer> getSubProcessorIntakes()
```
    This method returns the processor intakes in a map.
    
    Returns:
    
    a Map with Processor instances and Integer as keys and values
  - getOriginalLocation
```
protected java.awt.Point getOriginalLocation()
```
  - setOriginalLocation
```
protected void setOriginalLocation(java.awt.Point relativePoint)
```
  - getUI
```
public ProcessorButton getUI(java.awt.Container container)
```
    Description copied from interface: REpiceaUIObjectWithParent
    
    This method returns the GUI interface of the class that implements this interface.
    
    Specified by:
    
    getUI in interface REpiceaUIObjectWithParent
    
    Parameters:
    
    container - a parent Container instance (can be null)
    
    Returns:
    
    a Component instance
  - getName
```
public java.lang.String getName()
```
    This method returns the name of the processor.
    
    Returns:
    
    a String
  - setName
```
public void setName(java.lang.String str)
```
    This method sets the name of the processor.
    
    Parameters:
    
    str - a String instance
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getUI
```
public ProcessorButton getUI()
```
    Description copied from interface: REpiceaUIObject
    
    This method returns the GUI interface of the class that implements this interface.
    
    Specified by:
    
    getUI in interface REpiceaUIObject
    
    Returns:
    
    a Component instance
  - caretUpdate
```
public void caretUpdate(javax.swing.event.CaretEvent evt)
```
    Specified by:
    
    caretUpdate in interface javax.swing.event.CaretListener
  - hasSubProcessors
```
public boolean hasSubProcessors()
```
    This method returns true if the processor has one or many subprocessors tied to itself or false otherwise.
    
    Returns:
    
    a boolean
  - isValid
```
public boolean isValid()
```
    This method checks if the wood processor is valid as well as all its subprocessors.
    
    Returns:
    
    true if everything is alright
  - isPartOfEndlessLoop
```
public boolean isPartOfEndlessLoop()
```
  - getProcessFeaturesPanel
```
protected REpiceaPanel getProcessFeaturesPanel()
```
    This method returns other process features when the processor button is double clicked.
    
    Returns:
    
    a REpiceaPanel instance
  - isVisible
```
public boolean isVisible()
```
    Description copied from interface: REpiceaUIObjectWithParent
    
    This method returns true if the GUI is visible.
    
    Specified by:
    
    isVisible in interface REpiceaUIObject
    
    Specified by:
    
    isVisible in interface REpiceaUIObjectWithParent
    
    Returns:
    
    a boolean
  - setPartOfEndlessLoop
```
protected void setPartOfEndlessLoop(boolean bool)
```

Class Processor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

guiInterface

subProcessors

isTerminal

averageIntake

Constructor Detail

Processor

Processor

Method Detail

isTerminalProcessor

doProcess

createProcessUnits

createProcessUnitsFromThisProcessor

addSubProcessor

removeSubProcessor

getSubProcessors

getSubProcessorIntakes

getOriginalLocation

setOriginalLocation

getUI

getName

setName

toString

getUI

caretUpdate

hasSubProcessors

isValid

isPartOfEndlessLoop

getProcessFeaturesPanel

isVisible

setPartOfEndlessLoop