generated.docs.javadoc.org.eclipse.dawnsci.analysis.api.tree.Tree.html Maven / Gradle / Ivy
Tree (h5jan API)
org.eclipse.dawnsci.analysis.api.tree
Interface Tree
-
- All Known Subinterfaces:
- TreeFile
- All Known Implementing Classes:
- TreeFileImpl, TreeImpl
public interface Tree
A tree has a link to the top group node
-
-
Field Summary
Fields
Modifier and Type
Field and Description
static java.lang.String
FILE_STARTER
static java.lang.String
HOST_SEPARATOR
static java.lang.String
ROOT
-
Method Summary
All Methods Instance Methods Abstract Methods
Modifier and Type
Method and Description
NodeLink
findNodeLink(java.lang.String pathname)
GroupNode
getGroupNode()
java.lang.String
getHostname()
long
getID()
NodeLink
getNodeLink()
java.net.URI
getSourceURI()
void
setGroupNode(GroupNode g)
Set root group node
void
setHostname(java.lang.String hostname)
Set name of host that holds file
-
-
Field Detail
-
HOST_SEPARATOR
static final java.lang.String HOST_SEPARATOR
- See Also:
- Constant Field Values
-
FILE_STARTER
static final java.lang.String FILE_STARTER
- See Also:
- Constant Field Values
-
ROOT
static final java.lang.String ROOT
- See Also:
- Constant Field Values
-
Method Detail
-
getID
long getID()
- Returns:
- ID
-
getSourceURI
java.net.URI getSourceURI()
- Returns:
- source URI
-
getHostname
java.lang.String getHostname()
- Returns:
- hostname (can be null for localhost)
-
setHostname
void setHostname(java.lang.String hostname)
Set name of host that holds file
- Parameters:
hostname
-
-
getGroupNode
GroupNode getGroupNode()
- Returns:
- root group node
-
setGroupNode
void setGroupNode(GroupNode g)
Set root group node
-
getNodeLink
NodeLink getNodeLink()
- Returns:
- link to root group
-
findNodeLink
NodeLink findNodeLink(java.lang.String pathname)
- Parameters:
pathname
-
- Returns:
- node link to given path (needs to be absolute) or null if not found
- Throws:
java.lang.NullPointerException
- if pathname is null