FileSystemModel2 (cismet GUI Commons [9.2-SNAPSHOT] 9.2-SNAPSHOT API)

java.lang.Object
- de.cismet.tools.gui.treetable.AbstractTreeTableModel
- - de.cismet.tools.gui.treetable.FileSystemModel2

All Implemented Interfaces:

TreeTableModel, TreeModel
```
public class FileSystemModel2
extends AbstractTreeTableModel
```
FileSystemModel2 is a TreeTableModel representing a hierarchical file system.
This will recursively load all the children from the path it is created with. The loading is done with the method reloadChildren, and happens in another thread. The method isReloading can be invoked to check if there are active threads. The total size of all the files are also accumulated.

By default links are not descended. java.io.File does not have a way to distinguish links, so a file is assumed to be a link if its canonical path does not start with its parent path. This may not cover all cases, but works for the time being.

Reloading happens such that all the files of the directory are loaded and immediately available. The background thread then recursively loads all the files of each of those directories. When each directory has finished loading all its sub files they are attached and an event is generated in the event dispatching thread. A more ambitious approach would be to attach each set of directories as they are loaded and generate an event. Then, once all the direct descendants of the directory being reloaded have finished loading, it is resorted based on total size.

While you can invoke reloadChildren as many times as you want, care should be taken in doing this. You should not invoke reloadChildren on a node that is already being reloaded, or going to be reloaded (meaning its parent is reloading but it hasn't started reloading that directory yet). If this is done odd results may happen. FileSystemModel2 does not enforce any policy in this manner, and it is up to the user of FileSystemModel2 to ensure it doesn't happen.

Version:

1.12 05/12/98

Author:

Philip Milne, Scott Violet

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String[]`	`cNames`
`protected static Class[]`	`cTypes`
`protected boolean`	`descendLinks` Returns true if links are to be descended.
`protected static de.cismet.tools.gui.treetable.FileSystemModel2.FileNode[]`	`EMPTY_CHILDREN`
`protected boolean`	`isValid` True if the receiver is valid, once set to false all Threads loading files will stop.
`protected de.cismet.tools.gui.treetable.FileSystemModel2.FileNode`	`reloadNode` Node currently being reloaded, this becomes somewhat muddy if reloading is happening in multiple threads.
`static Integer`	`ZERO`

Fields inherited from class de.cismet.tools.gui.treetable.AbstractTreeTableModel
listenerList, root

Constructor Summary

Constructors
Constructor and Description
`FileSystemModel2()` Creates a FileSystemModel2 rooted at File.separator, which is usually the root of the file system.
`FileSystemModel2(String rootPath)` Creates a FileSystemModel2 with the root being `rootPath`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`getChild(Object node, int i)` Returns the child of `node` at index `i`.
`int`	`getChildCount(Object node)` Returns the number of children of `node`.
`protected Object[]`	`getChildren(Object node)` DOCUMENT ME!
`Class`	`getColumnClass(int column)` Returns the class for the particular column.
`int`	`getColumnCount()` Returns the number of columns.
`String`	`getColumnName(int column)` Returns the name for a particular column.
`boolean`	`getDescendsLinks()` Returns true if links are to be automatically descended.
`protected File`	`getFile(Object node)` DOCUMENT ME!
`Object`	`getNodeLoading()` Returns the node being loaded.
`String`	`getPath(Object node)` Returns the path `node` represents.
`TreePath`	`getPathLoading()` Returns the path to the node that is being loaded.
`protected static MergeSort`	`getSizeSorter()` Returns a MergeSort that can sort on the totalSize of a FileNode.
`long`	`getTotalSize(Object node)` Returns the total size of the receiver.
`Object`	`getValueAt(Object node, int column)` Returns the value of the particular column.
`boolean`	`isLeaf(Object node)` Returns true if the passed in object represents a leaf, false otherwise.
`boolean`	`isReloading()` Returns true if the receiver is loading any children.
`protected static void`	`recycleSorter(MergeSort sorter)` Should be invoked when a MergeSort is no longer needed.
`void`	`reloadChildren(Object node)` Reloads the children of the specified node.
`void`	`setDescendsLinks(boolean newValue)` If `newValue` is true, links are descended.
`void`	`stopLoading()` Stops and waits for all threads to finish loading.

Methods inherited from class de.cismet.tools.gui.treetable.AbstractTreeTableModel
addTreeModelListener, fireTreeNodesChanged, fireTreeNodesInserted, fireTreeNodesRemoved, fireTreeStructureChanged, getIndexOfChild, getRoot, isCellEditable, removeTreeModelListener, setValueAt, valueForPathChanged

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

- Field Detail
  - cNames
```
protected static String[] cNames
```
  - cTypes
```
protected static Class[] cTypes
```
  - ZERO
```
public static final Integer ZERO
```
  - EMPTY_CHILDREN
```
protected static de.cismet.tools.gui.treetable.FileSystemModel2.FileNode[] EMPTY_CHILDREN
```
  - isValid
```
protected boolean isValid
```
    True if the receiver is valid, once set to false all Threads loading files will stop.
  - reloadNode
```
protected de.cismet.tools.gui.treetable.FileSystemModel2.FileNode reloadNode
```
    Node currently being reloaded, this becomes somewhat muddy if reloading is happening in multiple threads.
  - descendLinks
```
protected boolean descendLinks
```
    Returns true if links are to be descended.
- Constructor Detail
  - FileSystemModel2
```
public FileSystemModel2()
```
    Creates a FileSystemModel2 rooted at File.separator, which is usually the root of the file system. This does not load it, you should invoke reloadChildren with the root to start loading.
  - FileSystemModel2
```
public FileSystemModel2(String rootPath)
```
    Creates a FileSystemModel2 with the root being rootPath. This does not load it, you should invoke reloadChildren with the root to start loading.
    
    Parameters:
    
    rootPath - DOCUMENT ME!
- Method Detail
  - getSizeSorter
```
protected static MergeSort getSizeSorter()
```
    Returns a MergeSort that can sort on the totalSize of a FileNode.
    
    Returns:
    
    DOCUMENT ME!
  - recycleSorter
```
protected static void recycleSorter(MergeSort sorter)
```
    Should be invoked when a MergeSort is no longer needed.
    
    Parameters:
    
    sorter - DOCUMENT ME!
  - getChildCount
```
public int getChildCount(Object node)
```
    Returns the number of children of node.
    
    Parameters:
    
    node - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getChild
```
public Object getChild(Object node,
                       int i)
```
    Returns the child of node at index i.
    
    Parameters:
    
    node - DOCUMENT ME!
    
    i - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - isLeaf
```
public boolean isLeaf(Object node)
```
    Returns true if the passed in object represents a leaf, false otherwise.
    
    Specified by:
    
    isLeaf in interface TreeModel
    
    Overrides:
    
    isLeaf in class AbstractTreeTableModel
    
    Parameters:
    
    node - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getColumnCount
```
public int getColumnCount()
```
    Returns the number of columns.
    
    Returns:
    
    DOCUMENT ME!
  - getColumnName
```
public String getColumnName(int column)
```
    Returns the name for a particular column.
    
    Parameters:
    
    column - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getColumnClass
```
public Class getColumnClass(int column)
```
    Returns the class for the particular column.
    
    Specified by:
    
    getColumnClass in interface TreeTableModel
    
    Overrides:
    
    getColumnClass in class AbstractTreeTableModel
    
    Parameters:
    
    column - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getValueAt
```
public Object getValueAt(Object node,
                         int column)
```
    Returns the value of the particular column.
    
    Parameters:
    
    node - DOCUMENT ME!
    
    column - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - reloadChildren
```
public void reloadChildren(Object node)
```
    Reloads the children of the specified node.
    
    Parameters:
    
    node - DOCUMENT ME!
  - stopLoading
```
public void stopLoading()
```
    Stops and waits for all threads to finish loading.
  - setDescendsLinks
```
public void setDescendsLinks(boolean newValue)
```
    If newValue is true, links are descended. Odd results may happen if you set this while other threads are loading.
    
    Parameters:
    
    newValue - DOCUMENT ME!
  - getDescendsLinks
```
public boolean getDescendsLinks()
```
    Returns true if links are to be automatically descended.
    
    Returns:
    
    DOCUMENT ME!
  - getPath
```
public String getPath(Object node)
```
    Returns the path node represents.
    
    Parameters:
    
    node - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getTotalSize
```
public long getTotalSize(Object node)
```
    Returns the total size of the receiver.
    
    Parameters:
    
    node - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - isReloading
```
public boolean isReloading()
```
    Returns true if the receiver is loading any children.
    
    Returns:
    
    DOCUMENT ME!
  - getPathLoading
```
public TreePath getPathLoading()
```
    Returns the path to the node that is being loaded.
    
    Returns:
    
    DOCUMENT ME!
  - getNodeLoading
```
public Object getNodeLoading()
```
    Returns the node being loaded.
    
    Returns:
    
    DOCUMENT ME!
  - getFile
```
protected File getFile(Object node)
```
    DOCUMENT ME!
    
    Parameters:
    
    node - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getChildren
```
protected Object[] getChildren(Object node)
```
    DOCUMENT ME!
    
    Parameters:
    
    node - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!

Class FileSystemModel2

Field Summary

Fields inherited from class de.cismet.tools.gui.treetable.AbstractTreeTableModel

Constructor Summary

Method Summary

Methods inherited from class de.cismet.tools.gui.treetable.AbstractTreeTableModel

Methods inherited from class java.lang.Object

Field Detail

cNames

cTypes

ZERO

EMPTY_CHILDREN

isValid

reloadNode

descendLinks

Constructor Detail

FileSystemModel2

FileSystemModel2

Method Detail

getSizeSorter

recycleSorter

getChildCount

getChild

isLeaf

getColumnCount

getColumnName

getColumnClass

getValueAt

reloadChildren

stopLoading

setDescendsLinks

getDescendsLinks

getPath

getTotalSize

isReloading

getPathLoading

getNodeLoading

getFile

getChildren