treebolic.model
Interface INode

All Known Implementing Classes:
FsNode, LinkNode, MutableGraphNode, MutableNode, Node, Node, PosNode, Provider.MutableGraphNode, SenseNode, TreeMutableNode, WordNode

public interface INode

Node interface

Author:
Bernard Bou

Method Summary
 java.awt.Color getBackColor()
          Get background color
 java.util.List<INode> getChildren()
          Get children nodes
 double getChildrenWeight()
          Get children weight
 java.lang.String getContent()
          Get node content
 java.awt.Color getEdgeColor()
          Get tree edge color
 java.awt.Image getEdgeImage()
          Get tree edge image
 java.lang.String getEdgeImageFile()
          Get tree edge image file
 java.lang.String getEdgeLabel()
          Get tree edge (to parent) label
 java.lang.Integer getEdgeStyle()
          Get edge style
 java.awt.Color getForeColor()
          Get foreground color
 java.lang.String getId()
          Get node id
 java.awt.Image getImage()
          Get node image
 java.lang.String getImageFile()
          Get node image filename
 java.lang.String getLabel()
          Get node label
 java.lang.String getLink()
          Get URL link
 Location getLocation()
          Get node location
 double getMinWeight()
          Get least weight
 MountPoint getMountPoint()
          Get mountpoint
 INode getParent()
          Get tree node parent
 java.lang.String getTarget()
          Get link target frame
 double getWeight()
          Get node weight computed as a function of the number of descendant nodes.
 void setChildrenWeight(double thisWeight)
          Set children weight
 void setEdgeImage(java.awt.Image thisImage)
          Set tree edge image
 void setImage(java.awt.Image thisImage)
          Set image file
 void setMinWeight(double thisWeight)
          Set least weight
 void setMountPoint(MountPoint thisMountPoint)
          Set mountpoint
 void setParent(INode thisParent)
          Set tree node parent (used by mounting)
 void setWeight(double thisWeight)
          Set node weight (negative values will bypass computations and will be considered preset)
 

Method Detail

getParent

INode getParent()
Get tree node parent

Returns:
tree node parent

setParent

void setParent(INode thisParent)
Set tree node parent (used by mounting)

Parameters:
thisParent - tree node parent

getChildren

java.util.List<INode> getChildren()
Get children nodes

Returns:
children nodes

getMountPoint

MountPoint getMountPoint()
Get mountpoint

Returns:
mountpoint data or null if this node is not a mountpoint

setMountPoint

void setMountPoint(MountPoint thisMountPoint)
Set mountpoint

Parameters:
thisMountPoint - mountpoint data

getWeight

double getWeight()
Get node weight computed as a function of the number of descendant nodes. Can be negative if to be considered preset.

Returns:
node weight

setWeight

void setWeight(double thisWeight)
Set node weight (negative values will bypass computations and will be considered preset)

Parameters:
thisWeight - node weight

getChildrenWeight

double getChildrenWeight()
Get children weight

Returns:
children weight

setChildrenWeight

void setChildrenWeight(double thisWeight)
Set children weight

Parameters:
thisWeight - children weight

getMinWeight

double getMinWeight()
Get least weight

Returns:
least weight

setMinWeight

void setMinWeight(double thisWeight)
Set least weight

Parameters:
thisWeight - least weight

getLocation

Location getLocation()
Get node location

Returns:
node location

getId

java.lang.String getId()
Get node id

Returns:
node id

getLabel

java.lang.String getLabel()
Get node label

Returns:
node label

getEdgeLabel

java.lang.String getEdgeLabel()
Get tree edge (to parent) label

Returns:
tree edge (to parent) label

getContent

java.lang.String getContent()
Get node content

Returns:
node content as string

getBackColor

java.awt.Color getBackColor()
Get background color

Returns:
background color

getForeColor

java.awt.Color getForeColor()
Get foreground color

Returns:
foreground color

getEdgeColor

java.awt.Color getEdgeColor()
Get tree edge color

Returns:
tree edge color

getEdgeStyle

java.lang.Integer getEdgeStyle()
Get edge style

Returns:
edge style

getLink

java.lang.String getLink()
Get URL link

Returns:
URL link

getTarget

java.lang.String getTarget()
Get link target frame

Returns:
link target frame

getImageFile

java.lang.String getImageFile()
Get node image filename

Returns:
node image filename

getEdgeImageFile

java.lang.String getEdgeImageFile()
Get tree edge image file

Returns:
tree edge image file

getImage

java.awt.Image getImage()
Get node image

Returns:
node image

getEdgeImage

java.awt.Image getEdgeImage()
Get tree edge image

Returns:
tree edge image

setImage

void setImage(java.awt.Image thisImage)
Set image file

Parameters:
thisImage - node image

setEdgeImage

void setEdgeImage(java.awt.Image thisImage)
Set tree edge image

Parameters:
thisImage - tree edge image