Package uk.ac.starlink.datanode.nodes
Class BranchDataNode
java.lang.Object
uk.ac.starlink.datanode.nodes.DefaultDataNode
uk.ac.starlink.datanode.nodes.BranchDataNode
- All Implemented Interfaces:
DataNode
DataNode implementation for a branch of a virtual filestore.
- Since:
- 25 Feb 2005
- Author:
- Mark Taylor (Starlink)
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
TheDefaultDataNode
implementation of this method returnsfalse
.TheDefaultDataNode
implementation of this method throwsUnsupportedOperationException
(DefaultDataNode.allowsChildren()
is false).getIcon()
Returns a default icon, unless setIconID has been called, in which case it returns the one indicated by that call.TheDefaultDataNode
implementation returns the string "...".Returns a short sentence indicating what kind of node this is.Returns an object which is in some sense the parent of the one this node is based on.TheDefaultDataNode
implementation returns the label as a default path element.Returns a default separator string.void
setConnection
(uk.ac.starlink.connect.Connection connection) Sets the Connection object associated with this branch.void
Sets the absolute path of this node.Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode
beep, configureDetail, getChildMaker, getCreator, getDataObject, getDescription, getLabel, getName, hasDataObject, makeChild, makeErrorChild, registerDataObject, setChildMaker, setCreator, setDescription, setIconID, setLabel, setName, setParentObject, toString
-
Constructor Details
-
BranchDataNode
public BranchDataNode(uk.ac.starlink.connect.Branch branch)
-
-
Method Details
-
setConnection
public void setConnection(uk.ac.starlink.connect.Connection connection) Sets the Connection object associated with this branch. It's not compulsory to call this on a BranchDataNode, but it enables it to report more things about itself.- Parameters:
connection
- connection from which this item is derived
-
allowsChildren
public boolean allowsChildren()Description copied from class:DefaultDataNode
TheDefaultDataNode
implementation of this method returnsfalse
.- Specified by:
allowsChildren
in interfaceDataNode
- Overrides:
allowsChildren
in classDefaultDataNode
- Returns:
true
if the node is of a type which can have child nodes,false
otherwise
-
getChildIterator
Description copied from class:DefaultDataNode
TheDefaultDataNode
implementation of this method throwsUnsupportedOperationException
(DefaultDataNode.allowsChildren()
is false).- Specified by:
getChildIterator
in interfaceDataNode
- Overrides:
getChildIterator
in classDefaultDataNode
- Returns:
- an
Iterator
over the children. Each object iterated over should be aDataNode
. Behaviour is undefined if this method is called on an object for whichallowsChildren
returnsfalse
.
-
setPath
Sets the absolute path of this node. -
getParentObject
Description copied from interface:DataNode
Returns an object which is in some sense the parent of the one this node is based on. The parent is not aDataNode
, it is something which may get fed to aDataNodeFactory
to createDataNode
. If no such object exists, which may well be the case,null
should be returned.- Specified by:
getParentObject
in interfaceDataNode
- Overrides:
getParentObject
in classDefaultDataNode
- Returns:
- an object which is the parent of this one, or
null
-
getPathSeparator
Description copied from class:DefaultDataNode
Returns a default separator string.- Specified by:
getPathSeparator
in interfaceDataNode
- Overrides:
getPathSeparator
in classDefaultDataNode
- Returns:
- "."
-
getPathElement
Description copied from class:DefaultDataNode
TheDefaultDataNode
implementation returns the label as a default path element.- Specified by:
getPathElement
in interfaceDataNode
- Overrides:
getPathElement
in classDefaultDataNode
- Returns:
- the node's label
-
getIcon
Description copied from class:DefaultDataNode
Returns a default icon, unless setIconID has been called, in which case it returns the one indicated by that call.- Specified by:
getIcon
in interfaceDataNode
- Overrides:
getIcon
in classDefaultDataNode
- Returns:
- an icon representing this node
-
getNodeTLA
Description copied from class:DefaultDataNode
TheDefaultDataNode
implementation returns the string "...".- Specified by:
getNodeTLA
in interfaceDataNode
- Overrides:
getNodeTLA
in classDefaultDataNode
- Returns:
- "..."
-
getNodeType
Description copied from interface:DataNode
Returns a short sentence indicating what kind of node this is. The return value should be just a few words. As a rough guideline it should indicate what the implementing class is.- Specified by:
getNodeType
in interfaceDataNode
- Overrides:
getNodeType
in classDefaultDataNode
- Returns:
- a short description of the type of this
DataNode
-