org.pentaho.reporting.designer.extensions.pentaho.repository.model

Class RepositoryTreeModel

java.lang.Object

org.pentaho.reporting.designer.extensions.pentaho.repository.model.RepositoryTreeModel

All Implemented Interfaces:

TreeModel

public class RepositoryTreeModel
extends Object
implements TreeModel

Constructor Summary

Constructors

Constructor and Description
RepositoryTreeModel()
RepositoryTreeModel(org.apache.commons.vfs2.FileObject repositoryRoot, String[] filters, boolean showFoldersOnly)

Method Summary

Modifier and Type	Method and Description
void	addTreeModelListener(TreeModelListener l) Adds a listener for the TreeModelEvent posted after the tree changes.
static org.apache.commons.vfs2.FileObject	findNodeByName(org.apache.commons.vfs2.FileObject node, String name)
void	fireTreeDataChanged()
Object	getChild(Object parent, int index) Returns the child of parent at index index in the parent's child array.
int	getChildCount(Object parent) Returns the number of children of parent.
org.apache.commons.vfs2.FileObject	getFileSystemRoot()
String[]	getFilters()
int	getIndexOfChild(Object parent, Object childNode) Returns the index of child in parent.
Object	getRoot() Returns the root of the tree.
TreePath	getTreePathForSelection(org.apache.commons.vfs2.FileObject selectedFolder, String selection)
boolean	isLeaf(Object node) Returns true if node is a leaf.
boolean	isShowFoldersOnly()
boolean	isShowHiddenFiles()
void	removeTreeModelListener(TreeModelListener l) Removes a listener previously added with addTreeModelListener.
void	setFileSystemRoot(org.apache.commons.vfs2.FileObject root)
void	setFilters(String[] filters)
void	setShowFoldersOnly(boolean showFoldersOnly)
void	setShowHiddenFiles(boolean showHiddenFiles)
void	valueForPathChanged(TreePath path, Object newValue) Messaged when the user has altered the value for the item identified by path to newValue.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RepositoryTreeModel

public RepositoryTreeModel()

RepositoryTreeModel

public RepositoryTreeModel(org.apache.commons.vfs2.FileObject repositoryRoot,
                           String[] filters,
                           boolean showFoldersOnly)

Method Detail

setShowFoldersOnly

public void setShowFoldersOnly(boolean showFoldersOnly)

isShowFoldersOnly

public boolean isShowFoldersOnly()

isShowHiddenFiles

public boolean isShowHiddenFiles()

setShowHiddenFiles

public void setShowHiddenFiles(boolean showHiddenFiles)

getFilters

public String[] getFilters()

setFilters

public void setFilters(String[] filters)

getFileSystemRoot

public org.apache.commons.vfs2.FileObject getFileSystemRoot()

setFileSystemRoot

public void setFileSystemRoot(org.apache.commons.vfs2.FileObject root)

getRoot

public Object getRoot()

Returns the root of the tree. Returns null only if the tree has no nodes.

Specified by:

getRoot in interface TreeModel

Returns:

the root of the tree

getChild

public Object getChild(Object parent,
                       int index)

Returns the child of parent at index index in the parent's child array. parent must be a node previously obtained from this data source. This should not return null if index is a valid index for parent (that is index >= 0 && index < getChildCount(parent)).

Specified by:

getChild in interface TreeModel

Parameters:

parent - a node in the tree, obtained from this data source

Returns:

the child of parent at index index

getChildCount

public int getChildCount(Object parent)

Returns the number of children of parent. Returns 0 if the node is a leaf or if it has no children. parent must be a node previously obtained from this data source.

Specified by:

getChildCount in interface TreeModel

Parameters:

parent - a node in the tree, obtained from this data source

Returns:

the number of children of the node parent

isLeaf

public boolean isLeaf(Object node)

Returns true if node is a leaf. It is possible for this method to return false even if node has no children. A directory in a filesystem, for example, may contain no files; the node representing the directory is not a leaf, but it also has no children.

Specified by:

isLeaf in interface TreeModel

Parameters:

node - a node in the tree, obtained from this data source

Returns:

true if node is a leaf

valueForPathChanged

public void valueForPathChanged(TreePath path,
                                Object newValue)

Messaged when the user has altered the value for the item identified by path to newValue. If newValue signifies a truly new value the model should post a treeNodesChanged event.

Specified by:

valueForPathChanged in interface TreeModel

Parameters:

path - path to the node that the user has altered

newValue - the new value from the TreeCellEditor

getIndexOfChild

public int getIndexOfChild(Object parent,
                           Object childNode)

Returns the index of child in parent. If either parent or child is null, returns -1. If either parent or child don't belong to this tree model, returns -1.

Specified by:

getIndexOfChild in interface TreeModel

Parameters:

parent - a note in the tree, obtained from this data source

childNode - the node we are interested in

Returns:

the index of the child in the parent, or -1 if either child or parent are null or don't belong to this tree model

addTreeModelListener

public void addTreeModelListener(TreeModelListener l)

Adds a listener for the TreeModelEvent posted after the tree changes.

Specified by:

addTreeModelListener in interface TreeModel

Parameters:

l - the listener to add

See Also:

removeTreeModelListener(javax.swing.event.TreeModelListener)

removeTreeModelListener

public void removeTreeModelListener(TreeModelListener l)

Removes a listener previously added with addTreeModelListener.

Specified by:

removeTreeModelListener in interface TreeModel

Parameters:

l - the listener to remove

See Also:

addTreeModelListener(javax.swing.event.TreeModelListener)

fireTreeDataChanged

public void fireTreeDataChanged()

getTreePathForSelection

public TreePath getTreePathForSelection(org.apache.commons.vfs2.FileObject selectedFolder,
                                        String selection)
                                 throws org.apache.commons.vfs2.FileSystemException

Throws:

org.apache.commons.vfs2.FileSystemException

findNodeByName

public static org.apache.commons.vfs2.FileObject findNodeByName(org.apache.commons.vfs2.FileObject node,
                                                                String name)
                                                         throws org.apache.commons.vfs2.FileSystemException

Throws:

org.apache.commons.vfs2.FileSystemException