|
|||||||||
| Home >> All >> recoin >> system >> [ session overview ] | PREV CLASS NEXT CLASS | ||||||||
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||
recoin.system.session
Class ComponentOrder
java.lang.Objectrecoin.system.session.ComponentOrder
- public class ComponentOrder
- extends java.lang.Object
A ComponentOrder is used to to tell a Component what it should do with
a RetrievalContainer in terms of the objects it should try to process and
their order.
Therefore it contains information as to what objects in the
container should be processed, whether any results should be stored inside
the container, and if these results - together with a corresponding
ComponentOrder - should be forwarded to another component inside the
ModuleGroup.
A ComponentOrder can have another single ComponentOrder as its parent order and any
number of them as child order thus creating a tree structure to implement
the order in which the ComponentOrders are executed. Naturally, the parent order
is executed before any of its child orders.
- Version:
- 0.2.9
| Field Summary | |
java.util.Vector |
childOrders
A number of child orders that are executed when this ComponentOrder is finished. |
int |
componentID
The ID of the Component this ComponentOrder is destined for. |
java.util.Vector |
csChainIDs
The chain IDs of the ComponentSupport objects that the Component should try to process. |
int |
moduleID
The ID of the Module this ComponentOrder is destined for. |
ComponentOrder |
parentOrder
The parent of this ComponentOrder which has to be executed before this one. |
| Constructor Summary | |
ComponentOrder(ComponentOrder parentOrder,
int moduleID,
int componentID)
Creates a new ComponentOrder for the Module and Component with the specified IDs. |
|
ComponentOrder(int moduleID,
int componentID)
Creates a new ComponentOrder for the Module and Component with the specified IDs. |
|
| Method Summary | |
void |
addChildOrder(ComponentOrder childOrder)
Adds the specified ComponentOrder to the child orders. |
java.util.Vector |
getChildOrders()
Returns the child orders. |
int |
getComponentID()
Returns the ID of the Component this ComponentOrder is destined for. |
ComponentOrder |
getParentOrder()
Returns the parent order. |
java.lang.String[] |
getSupportChainIDs()
Returns the chain IDs of the ComponentSupports that should be processed as a String array. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
csChainIDs
public java.util.Vector csChainIDs
- The chain IDs of the ComponentSupport objects that the Component should
try to process.
parentOrder
public ComponentOrder parentOrder
- The parent of this ComponentOrder which has to be executed before this one.
childOrders
public java.util.Vector childOrders
- A number of child orders that are executed when this ComponentOrder is finished.
moduleID
public int moduleID
- The ID of the Module this ComponentOrder is destined for.
componentID
public int componentID
- The ID of the Component this ComponentOrder is destined for.
| Constructor Detail |
ComponentOrder
public ComponentOrder(int moduleID,
int componentID)
- Creates a new ComponentOrder for the Module and Component with the specified IDs.
ComponentOrder
public ComponentOrder(ComponentOrder parentOrder, int moduleID, int componentID)
- Creates a new ComponentOrder for the Module and Component with the specified IDs.
The specified ComponentOrder is set as this ComponentOrder's parent.
| Method Detail |
getComponentID
public int getComponentID()
- Returns the ID of the Component this ComponentOrder is destined for.
getSupportChainIDs
public java.lang.String[] getSupportChainIDs()
- Returns the chain IDs of the ComponentSupports that should be processed as a String
array.
getChildOrders
public java.util.Vector getChildOrders()
- Returns the child orders.
getParentOrder
public ComponentOrder getParentOrder()
- Returns the parent order.
addChildOrder
public void addChildOrder(ComponentOrder childOrder)
- Adds the specified ComponentOrder to the child orders.
|
|||||||||
| Home >> All >> recoin >> system >> [ session overview ] | PREV CLASS NEXT CLASS | ||||||||
|
SUMMARY: JAVADOC | SOURCE | DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||