FtpDirectoryDataNode (Starjava Datanode API)

java.lang.Object
- uk.ac.starlink.datanode.nodes.DefaultDataNode
- - uk.ac.starlink.datanode.nodes.FtpDirectoryDataNode

All Implemented Interfaces:

DataNode
```
public class FtpDirectoryDataNode
extends DefaultDataNode
```
A DataNode which represents a directory on an FTP server. In some circumstances this can end up making rather a lot of FTP connections.

Author:

Mark Taylor (Starlink)

Constructor Summary

Constructors
Constructor and Description

FtpDirectoryDataNode(FtpLocation floc)

FtpDirectoryDataNode(java.lang.String location)

Constructors
Constructor and Description
`FtpDirectoryDataNode(FtpLocation floc)`
`FtpDirectoryDataNode(java.lang.String location)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allowsChildren()` The `DefaultDataNode` implementation of this method returns `false`.
`java.util.Iterator`	`getChildIterator()` The `DefaultDataNode` implementation of this method throws `UnsupportedOperationException` (`DefaultDataNode.allowsChildren()` is false).
`java.lang.String`	`getNodeTLA()` The `DefaultDataNode` implementation returns the string "...".
`java.lang.String`	`getNodeType()` Returns a short sentence indicating what kind of node this is.
`java.lang.Object`	`getParentObject()` Returns an object which is in some sense the parent of the one this node is based on.
`java.lang.String`	`getPathSeparator()` Returns a default separator string.

Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode
beep, configureDetail, getChildMaker, getCreator, getDataObject, getDescription, getIcon, getLabel, getName, getPathElement, hasDataObject, makeChild, makeErrorChild, registerDataObject, setChildMaker, setCreator, setDescription, setIconID, setLabel, setName, setParentObject, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FtpDirectoryDataNode
```
public FtpDirectoryDataNode(FtpLocation floc)
```
  - FtpDirectoryDataNode
```
public FtpDirectoryDataNode(java.lang.String location)
                     throws NoSuchDataException
```
    Throws:
    
    NoSuchDataException
- Method Detail
  - getNodeTLA
```
public java.lang.String getNodeTLA()
```
    Description copied from class: DefaultDataNode
    
    The DefaultDataNode implementation returns the string "...".
    
    Specified by:
    
    getNodeTLA in interface DataNode
    
    Overrides:
    
    getNodeTLA in class DefaultDataNode
    
    Returns:
    
    "..."
  - getNodeType
```
public java.lang.String 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 interface DataNode
    
    Overrides:
    
    getNodeType in class DefaultDataNode
    
    Returns:
    
    a short description of the type of this DataNode
  - getPathSeparator
```
public java.lang.String getPathSeparator()
```
    Description copied from class: DefaultDataNode
    
    Returns a default separator string.
    
    Specified by:
    
    getPathSeparator in interface DataNode
    
    Overrides:
    
    getPathSeparator in class DefaultDataNode
    
    Returns:
    
    "."
  - allowsChildren
```
public boolean allowsChildren()
```
    Description copied from class: DefaultDataNode
    
    The DefaultDataNode implementation of this method returns false.
    
    Specified by:
    
    allowsChildren in interface DataNode
    
    Overrides:
    
    allowsChildren in class DefaultDataNode
    
    Returns:
    
    true if the node is of a type which can have child nodes, false otherwise
  - getChildIterator
```
public java.util.Iterator getChildIterator()
```
    Description copied from class: DefaultDataNode
    
    The DefaultDataNode implementation of this method throws UnsupportedOperationException (DefaultDataNode.allowsChildren() is false).
    
    Specified by:
    
    getChildIterator in interface DataNode
    
    Overrides:
    
    getChildIterator in class DefaultDataNode
    
    Returns:
    
    an Iterator over the children. Each object iterated over should be a DataNode. Behaviour is undefined if this method is called on an object for which allowsChildren returns false.
  - getParentObject
```
public java.lang.Object 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 a DataNode, it is something which may get fed to a DataNodeFactory to create DataNode. If no such object exists, which may well be the case, null should be returned.
    
    Specified by:
    
    getParentObject in interface DataNode
    
    Overrides:
    
    getParentObject in class DefaultDataNode
    
    Returns:
    
    an object which is the parent of this one, or null

Class FtpDirectoryDataNode

Constructor Summary

Method Summary

Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode

Methods inherited from class java.lang.Object

Constructor Detail

FtpDirectoryDataNode

FtpDirectoryDataNode

Method Detail

getNodeTLA

getNodeType

getPathSeparator

allowsChildren

getChildIterator

getParentObject