cz.cuni.jagrlib.reg
Class InfoModule

java.lang.Object
  extended by cz.cuni.jagrlib.reg.InfoModule
Direct Known Subclasses:
InfoGroup

public class InfoModule
extends java.lang.Object

Information about one concrete module instance (Piece) stored in XML file (composition).

Since:
0.25
See Also:
InfoModule.java

Field Summary
 InfoModuleGUI infoGUI
          Information about module's GUI.
 Piece instancePiece
          Piece instance.
 java.lang.Integer key
          Key of the module (within the composition/group).
 java.util.Map<java.lang.String,java.lang.Object> nextInfo
          Space for extra information.
 InfoGroup owner
          Owner of the module (composition/group).
 java.util.Map<java.lang.String,InfoParam> params
          Set of all information about module parameters.
 java.util.Map<java.lang.String,InfoPlug> plugs
          Set of all information about module plugs.
 RegPiece reg
          Shared registration data (one concrete template for multi-template modules).
static java.lang.String TI_MODULE
           
 
Constructor Summary
InfoModule(RegPiece r)
          Initialize the instance from the given registration data.
 
Method Summary
 int getState()
          State check - checks connection status..
 InfoModule getTopLevelOwner()
          Looking for top level owner of module.
 int getVisibleParamLines()
          Computes number of visible parameter lines.
 boolean isOwner(java.lang.Integer _key)
          Determines if this module has the key.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

key

public java.lang.Integer key
Key of the module (within the composition/group).


reg

public RegPiece reg
Shared registration data (one concrete template for multi-template modules).


owner

public InfoGroup owner
Owner of the module (composition/group).


infoGUI

public InfoModuleGUI infoGUI
Information about module's GUI.


plugs

public java.util.Map<java.lang.String,InfoPlug> plugs
Set of all information about module plugs.


params

public java.util.Map<java.lang.String,InfoParam> params
Set of all information about module parameters.


nextInfo

public java.util.Map<java.lang.String,java.lang.Object> nextInfo
Space for extra information.


instancePiece

public Piece instancePiece
Piece instance.
Used in run-time of a composition.


TI_MODULE

public static final java.lang.String TI_MODULE
See Also:
Constant Field Values
Constructor Detail

InfoModule

public InfoModule(RegPiece r)
Initialize the instance from the given registration data.

Method Detail

getTopLevelOwner

public InfoModule getTopLevelOwner()
Looking for top level owner of module. If it is null then returns self, if it is not null then it calls recursively for owner.

Returns:
Top level owner.

isOwner

public boolean isOwner(java.lang.Integer _key)
Determines if this module has the key.

Parameters:
_key - In demand key.
Returns:
true if module has the key.

getState

public int getState()
State check - checks connection status..

Returns:
One of InfoState.* constants.

getVisibleParamLines

public int getVisibleParamLines()
Computes number of visible parameter lines.