ist.palcom.visualization.manager
Class VisualizationManager

java.lang.Object
  extended by ist.palcom.visualization.manager.VisualizationManager
All Implemented Interfaces:
IHgraphNode, HgraphBrowserInHandlerCallback, MirrorInCallback, MirrorOutCallback

public class VisualizationManager
extends java.lang.Object
implements IHgraphNode, MirrorOutCallback, MirrorInCallback, HgraphBrowserInHandlerCallback


Field Summary
static java.lang.String CMD_SYNC
           
 
Fields inherited from interface ist.palcom.hgraph.IHgraphNode
CHILD_NAME_CLASH, CIRCULARITY_CLASH, COMMAND_OR_NODE_MISSING, ERROR, HANDLER_MISSING, INVOKATOR_MISSING, LISTENER_MISSING, NODE_NOT_CHILD, PATH_MISSING, SIBLING_ALREADY_EXISTS, SIBLING_NONEXISTENT, SIBLING_REFERENCE_ALREADY_EXISTS, SIBLING_REFERENCE_NONEXISTENT, STATUS_OK, VALUE_ALREADY_EXISTS, VALUE_NOT_PRESENT
 
Constructor Summary
VisualizationManager(IVisualizationEngine engine)
           
 
Method Summary
 int addNodeChild(IHgraphNode node, Path callerPath)
          Adds a child to the node's private list of children.
 void forceUpdatePosition()
           
 java.util.Iterator getChildIterator()
           
 FuncFunc getFuncFunc()
           
 java.lang.String getNodeName()
          hgraph impl below
 IHgraphNode getNodeParent()
           
 Path getPath()
           
 SiblingFunc getSiblingFunc()
           
 ValueFunc getValueFunc()
           
 void gotConnect()
           
 void gotDisconnect()
           
 void gotLive(java.lang.String path, java.lang.String command, java.lang.String valueXML)
           
 void gotNode(java.lang.String node)
           
 boolean hasChildNamed(java.lang.String name)
          Checks whether the node has a child with a given name
 boolean isAncestorOf(IHgraphNode node)
          Checks whether this node is an ancestor of the parameter node.
 void mirrorIn(HgraphEvent event)
           
 void mirrorOut(Path path, java.lang.String command, Value value)
           
 int removeNodeChild(java.lang.String name, Path callerPath)
          Removes a child based on its name.
 void setLive(java.lang.String path)
           
 int setNodeName(java.lang.String name, Path callerPath)
          Sets the name of the node.
 int setNodeParent(IHgraphNode newParent, Path callerPath)
          Sets the parent of the HgraphNode.
 void setTypeManagerName(IHgraphNode tm)
           
 void toggleHgraphOff()
           
 void toggleHgraphOn(java.lang.String deviceID, java.lang.String initialPath, java.lang.String nodeName, int x, int y, int offset)
           
 java.lang.String toXML()
           
 java.lang.String toXMLFull()
           
 java.lang.String toXMLFullRecursively()
           
 java.lang.String toXMLRecursively()
           
 void unsetLive(java.lang.String path)
           
 void updatePath()
          Updates the path of the H-Graph node along with its offspring recursively.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CMD_SYNC

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

VisualizationManager

public VisualizationManager(IVisualizationEngine engine)
Method Detail

forceUpdatePosition

public void forceUpdatePosition()

toggleHgraphOff

public void toggleHgraphOff()

toggleHgraphOn

public void toggleHgraphOn(java.lang.String deviceID,
                           java.lang.String initialPath,
                           java.lang.String nodeName,
                           int x,
                           int y,
                           int offset)

setLive

public void setLive(java.lang.String path)

unsetLive

public void unsetLive(java.lang.String path)

gotNode

public void gotNode(java.lang.String node)
Specified by:
gotNode in interface HgraphBrowserInHandlerCallback

gotLive

public void gotLive(java.lang.String path,
                    java.lang.String command,
                    java.lang.String valueXML)
Specified by:
gotLive in interface HgraphBrowserInHandlerCallback

gotDisconnect

public void gotDisconnect()
Specified by:
gotDisconnect in interface HgraphBrowserInHandlerCallback

gotConnect

public void gotConnect()
Specified by:
gotConnect in interface HgraphBrowserInHandlerCallback

setTypeManagerName

public void setTypeManagerName(IHgraphNode tm)

mirrorIn

public void mirrorIn(HgraphEvent event)
Specified by:
mirrorIn in interface MirrorInCallback

mirrorOut

public void mirrorOut(Path path,
                      java.lang.String command,
                      Value value)
Specified by:
mirrorOut in interface MirrorOutCallback

getNodeName

public java.lang.String getNodeName()
hgraph impl below

Specified by:
getNodeName in interface IHgraphNode
Returns:
The name of the node.

setNodeName

public int setNodeName(java.lang.String name,
                       Path callerPath)
Description copied from interface: IHgraphNode
Sets the name of the node. If a sibling already has the name, an error control message is returned

Specified by:
setNodeName in interface IHgraphNode
Parameters:
name - The new name
Returns:
IHgraphNode.STATUS_OK if the change succeeded. IHgraphNode.CHILD_NAME_CLASH if a sibling with the given name already exists.

getPath

public Path getPath()
Specified by:
getPath in interface IHgraphNode
Returns:
the Path object pertaining to the path of the node

updatePath

public void updatePath()
Description copied from interface: IHgraphNode
Updates the path of the H-Graph node along with its offspring recursively. The path is updated when the node name and the node parent is sat.

Specified by:
updatePath in interface IHgraphNode

hasChildNamed

public boolean hasChildNamed(java.lang.String name)
Description copied from interface: IHgraphNode
Checks whether the node has a child with a given name

Specified by:
hasChildNamed in interface IHgraphNode
Parameters:
name - The name to check
Returns:
True iff the node has an actual child with the given name. False if not.

isAncestorOf

public boolean isAncestorOf(IHgraphNode node)
Description copied from interface: IHgraphNode
Checks whether this node is an ancestor of the parameter node. It does so with a depth-first sharch of its offspring (children etc.)

Specified by:
isAncestorOf in interface IHgraphNode
Returns:
true if this node is an ancestor of the parameter node. false if not.

removeNodeChild

public int removeNodeChild(java.lang.String name,
                           Path callerPath)
Description copied from interface: IHgraphNode
Removes a child based on its name.

Specified by:
removeNodeChild in interface IHgraphNode
Parameters:
name - The name of the child to be removed
Returns:
IHgraphNode.STATUS_OK if the operation succeeds

toXML

public java.lang.String toXML()
Specified by:
toXML in interface IHgraphNode
Returns:
A simple xml'ified String of the node (type, name, path, children)

toXMLFull

public java.lang.String toXMLFull()
Specified by:
toXMLFull in interface IHgraphNode
Returns:
A complete xml'ified String of the node (same as simple + handlers, invokators, listeners, values)

toXMLRecursively

public java.lang.String toXMLRecursively()
Specified by:
toXMLRecursively in interface IHgraphNode
Returns:
A simple recursive xml'ified String of the node (type, name, path, children)

toXMLFullRecursively

public java.lang.String toXMLFullRecursively()
Specified by:
toXMLFullRecursively in interface IHgraphNode
Returns:
A complete recursive xml'ified String of the node (same as simple + handlers, invokators, listeners, values) HEAVY!!!

setNodeParent

public int setNodeParent(IHgraphNode newParent,
                         Path callerPath)
Description copied from interface: IHgraphNode
Sets the parent of the HgraphNode. This triggers a recalculation of the path of the node and its offspring

Specified by:
setNodeParent in interface IHgraphNode
Parameters:
newParent - the new parent
Returns:
IHgraphNode.STATUS_OK if the operation succeeds. IHgraphNode.CIRCULARITY_CLASH if the operation causes a circularity.

addNodeChild

public int addNodeChild(IHgraphNode node,
                        Path callerPath)
Description copied from interface: IHgraphNode
Adds a child to the node's private list of children. Ensures that names amongst children are unique

Specified by:
addNodeChild in interface IHgraphNode
Parameters:
node - The new child to be added
Returns:
IHgraphNode.STATUS_OK if the change succeeded. IHgraphNode.CHILD_NAME_CLASH if a sibling with the given name already exists.

getSiblingFunc

public SiblingFunc getSiblingFunc()
Specified by:
getSiblingFunc in interface IHgraphNode
Returns:
The SiblingFunc Sibling functionality object for the given node.

getValueFunc

public ValueFunc getValueFunc()
Specified by:
getValueFunc in interface IHgraphNode
Returns:
The ValueFunc Value functionality object for the given node.

getFuncFunc

public FuncFunc getFuncFunc()
Specified by:
getFuncFunc in interface IHgraphNode
Returns:
The FuncFunc functional functionality (ie. handlers, invokators and listeners) object for the given node.

getNodeParent

public IHgraphNode getNodeParent()
Specified by:
getNodeParent in interface IHgraphNode
Returns:
The parent of the node. null if the parent is root

getChildIterator

public java.util.Iterator getChildIterator()
Specified by:
getChildIterator in interface IHgraphNode
Returns:
An Iterator over the children of the node