Module xaos.ui

Package eu.ess.xaos.ui.control.tree.directory

Class TreeDirectoryModel<I,T>

java.lang.Object

eu.ess.xaos.ui.control.tree.directory.TreeDirectoryModel<I,T>

Type Parameters:

I - Type of the initiator of changes to the model.

T - Type of the object returned by TreeItem.getValue().

All Implemented Interfaces:

DirectoryModel<I,T>, io.reactivex.disposables.Disposable

public class TreeDirectoryModel<I,T>
extends Object
implements DirectoryModel<I,T>

A DirectoryModel that can be used in a TreeView.

This model uses the DEFAULT_GRAPHIC_FACTORY to provide graphics to the tree nodes. That can be changed invoking setGraphicFactory(TreeDirectoryModel.GraphicFactory) after this model is built.

Note: dispose() should be called when the model is no more used (typically when the viewer using it is disposed).

Author:

claudio.rosati@esss.se

See Also:

LiveDirsFX:org.fxmisc.livedirs.LiveDirsModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TreeDirectoryModel.DefaultGraphicFactory	Default graphic factory returning a folder icon for a directory and a document icon for a regular file.
static interface	TreeDirectoryModel.GraphicFactory	Factory to create graphics for TreeItems in a DirectoryModel.

Nested classes/interfaces inherited from interface eu.ess.xaos.ui.control.tree.DirectoryModel

DirectoryModel.Reporter<I>, DirectoryModel.Update<I>, DirectoryModel.UpdateType

Field Summary

Fields

Modifier and Type	Field	Description
static TreeDirectoryModel.GraphicFactory	DEFAULT_GRAPHIC_FACTORY	Graphic factory that returns a folder icon for a directory and a document icon for a regular file.
static TreeDirectoryModel.GraphicFactory	NO_GRAPHIC_FACTORY	Graphic factory that always returns null.

Constructor Summary

Constructors

Constructor	Description
TreeDirectoryModel(I defaultInitiator, Function<T,Path> projector, Function<Path,T> injector)	Create a new instance of this model.

Method Summary

Modifier and Type	Method	Description
void	addDirectory(Path directory)	Add a no-top-lever directory to the model.
void	addDirectory(Path directory, I initiator)	Add a no-top-level directory to the model.
void	addFile(Path file, FileTime lastModified)	Add a file to the model.
void	addFile(Path file, FileTime lastModified, I initiator)	Add a file to the model.
void	addTopLevelDirectory(Path directory)	Add a top-lever directory to the model.
void	addTopLevelDirectory(Path directory, Consumer<? super TreeDirectoryItems.DirectoryItem<T>> onCollapse, Consumer<? super TreeDirectoryItems.DirectoryItem<T>> onExpand)	Add a top-lever directory to the model.
boolean	contains(Path path)	Indicates whether this directory model contains the given path.
boolean	containsPrefixOf(Path path)	Indicates whether this directory model contains roots whose name is a prefix in the given path name.
io.reactivex.Observable<DirectoryModel.Update<I>>	creations()
void	delete(Path path)	Delete the given path from the model.
void	delete(Path path, I initiator)	Delete the given path from the model.
io.reactivex.Observable<DirectoryModel.Update<I>>	deletions()
void	dispose()
io.reactivex.Observable<Throwable>	errors()
TreeItem<T>	getRoot()	Returns a tree item that can be used as a root of a TreeView.
boolean	isDisposed()
io.reactivex.Observable<DirectoryModel.Update<I>>	modifications()
void	setGraphicFactory(TreeDirectoryModel.GraphicFactory factory)	Sets graphic factory used to create graphics of TreeItems in this directory model.
void	sync(Path directory)	Synchronize the model with the given directory element.
void	sync(Path directory, I initiator)	Synchronize the model with the given directory element.
void	updateModificationTime(Path path, FileTime lastModified)	Updates the modification time for the item associated to the given Path.
void	updateModificationTime(Path path, FileTime lastModified, I initiator)	Updates the modification time for the item associated to the given Path.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_GRAPHIC_FACTORY

public static final TreeDirectoryModel.GraphicFactory DEFAULT_GRAPHIC_FACTORY

Graphic factory that returns a folder icon for a directory and a document icon for a regular file.

NO_GRAPHIC_FACTORY

public static final TreeDirectoryModel.GraphicFactory NO_GRAPHIC_FACTORY

Graphic factory that always returns null.

Constructor Detail

TreeDirectoryModel

public TreeDirectoryModel(I defaultInitiator,
                          Function<T,Path> projector,
                          Function<Path,T> injector)

Create a new instance of this model.

Parameters:

defaultInitiator - The initiator used when not explicitly provided as parameter in methods.

projector - A Function converting the object returned by TreeItem.getValue()) into the corresponding Path.

injector - A Function converting a Path into the object used as value in the corresponding TreeItem.

Method Detail

addDirectory

public void addDirectory(Path directory)

Add a no-top-lever directory to the model.

Parameters:

directory - The Path to be added as a directory.

addDirectory

public void addDirectory(Path directory,
                         I initiator)

Add a no-top-level directory to the model.

Parameters:

directory - The Path to be added as a directory.

initiator - The initiator of changes to the model.

addFile

public void addFile(Path file,
                    FileTime lastModified)

Add a file to the model.

Parameters:

file - The Path to be added as a file.

lastModified - The timestamp of the last modification to the file.

addFile

public void addFile(Path file,
                    FileTime lastModified,
                    I initiator)

Add a file to the model.

Parameters:

file - The Path to be added as a file.

lastModified - The timestamp of the last modification to the file.

initiator - The initiator of changes to the model.

addTopLevelDirectory

public void addTopLevelDirectory(Path directory)

Add a top-lever directory to the model.

Note: The model is not synchronized automatically with the given directory. An explicit call to sync(Path), or sync(Path, java.lang.Object) has to be performed if synchronization is required.

Parameters:

directory - The Path to be added as a top-level directory.

addTopLevelDirectory

public void addTopLevelDirectory(Path directory,
                                 Consumer<? super TreeDirectoryItems.DirectoryItem<T>> onCollapse,
                                 Consumer<? super TreeDirectoryItems.DirectoryItem<T>> onExpand)

Add a top-lever directory to the model.

Note: The model is not synchronized automatically with the given directory. An explicit call to sync(Path), or sync(Path, java.lang.Object) has to be performed if synchronization is required.

Note: addDirectory(Path) and addDirectory(Path, Object) methods will pass the given onCollapse and onExpand parameters to the newly created TreeDirectoryItems.DirectoryItem.

Parameters:

directory - The Path to be added as a top-level directory.

onCollapse - A Consumer to be invoked when this item is collapsed. Can be null.

onExpand - A Consumer to be invoked when this item is expanded. Can be null.

contains

public boolean contains(Path path)

Description copied from interface: DirectoryModel

Indicates whether this directory model contains the given path.

Specified by:

contains in interface DirectoryModel<I,T>

Parameters:

path - The Path to be verified.

Returns:

true if the given path is contained in this model.

containsPrefixOf

public boolean containsPrefixOf(Path path)

Indicates whether this directory model contains roots whose name is a prefix in the given path name.

Parameters:

path - The Path to be verified.

Returns:

true if this directory model contains roots whose name is a prefix in the given path name.

creations

public io.reactivex.Observable<DirectoryModel.Update<I>> creations()

Specified by:

creations in interface DirectoryModel<I,T>

Returns:

An observable stream of additions to the model.

delete

public void delete(Path path)

Delete the given path from the model.

Parameters:

path - The Path to be removed.

delete

public void delete(Path path,
                   I initiator)

Delete the given path from the model.

Parameters:

path - The Path to be removed.

initiator - The initiator of changes to the model.

deletions

public io.reactivex.Observable<DirectoryModel.Update<I>> deletions()

Specified by:

deletions in interface DirectoryModel<I,T>

Returns:

An observable stream of removals from the model.

dispose

public void dispose()

Specified by:

dispose in interface io.reactivex.disposables.Disposable

errors

public io.reactivex.Observable<Throwable> errors()

Specified by:

errors in interface DirectoryModel<I,T>

Returns:

An observable stream of errors.

getRoot

public TreeItem<T> getRoot()

Description copied from interface: DirectoryModel

Returns a tree item that can be used as a root of a TreeView.

The returned TreeItem does not contain any Path (its TreeItem.getValue() method returns null), but its children are roots of directory trees represented in this model. As a consequence, the returned TreeItem shall be used with TreeView.showRootProperty() set to false.

Specified by:

getRoot in interface DirectoryModel<I,T>

Returns:

A TreeItem object that can be used as a root of a TreeView.

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface io.reactivex.disposables.Disposable

modifications

public io.reactivex.Observable<DirectoryModel.Update<I>> modifications()

Specified by:

modifications in interface DirectoryModel<I,T>

Returns:

An observable stream of file modifications in the model.

setGraphicFactory

public void setGraphicFactory(TreeDirectoryModel.GraphicFactory factory)

Sets graphic factory used to create graphics of TreeItems in this directory model.

DEFAULT_GRAPHIC_FACTORY and NO_GRAPHIC_FACTORY are two factories already available.

TreeItems created before this method is called will be displayed using the previous graphic factory.

Parameters:

factory - The new graphic factory instance. If null, DEFAULT_GRAPHIC_FACTORY will be used.

sync

public void sync(Path directory)

Synchronize the model with the given directory element. Missing items will be added to the model for the expanded tree items, and a callback is registered to update the collapsed tree items when will expand. Items will be removed from the model if no more existing. Files timestamps will be updated too.

Parameters:

directory - The Path used to synchronize the model.

sync

public void sync(Path directory,
                 I initiator)

Synchronize the model with the given directory element. Missing items will be added to the model for the expanded tree items, and a callback is registered to update the collapsed tree items when will expand. Items will be removed from the model if no more existing. Files timestamps will be updated too.

Parameters:

directory - The Path used to synchronize the model.

initiator - The initiator of changes to the model.

updateModificationTime

public void updateModificationTime(Path path,
                                   FileTime lastModified)

Updates the modification time for the item associated to the given Path.

Parameters:

path - The path whose associated item must be updated.

lastModified - The new modification time.

updateModificationTime

public void updateModificationTime(Path path,
                                   FileTime lastModified,
                                   I initiator)

Updates the modification time for the item associated to the given Path.

Parameters:

path - The path whose associated item must be updated.

lastModified - The new modification time.

initiator - The initiator of changes to the model.