wjhk.jupload2.gui.filepanel.treeview

Class FolderNode

java.lang.Object

wjhk.jupload2.gui.filepanel.treeview.FolderNode

All Implemented Interfaces:

FileData, MyTreeNode, TreeFileDataNode

Direct Known Subclasses:

RootNode

public class FolderNode
extends Object
implements TreeFileDataNode

Author:

etienne_sf

Constructor Summary

Constructors

Modifier	Constructor and Description
	FolderNode(File file, UploadPolicy uploadPolicy, MyTreeTableModel<TreeFileDataNode> model, FilePanelFlatDataModel2 flatModel) Creates a node, with no link to any parent.
protected	FolderNode(UploadPolicy uploadPolicy, MyTreeTableModel<TreeFileDataNode> model, FilePanelFlatDataModel2 flatModel)

Method Summary

Modifier and Type	Method and Description
TreeFileDataNode	addChild(File f) Adds a given file as a Child of the current node.
TreeFileDataNode	addChild(FileData fileData) This method adds a new FileData in the children list, for the current object.
TreeFileDataNode	addChild(TreeFileDataNode child) Add a new child to the children of this folder.
int	addChildAndDescendants(File f) Adds a given file as a Child of the current node.
void	afterUpload() This function is called after upload, whether it is successful or not.
void	appendFileProperties(ByteArrayEncoder bae, int index) Called during the upload, by the FileUploadThread.
void	beforeUpload(String uploadPathRoot) Prepare the fileData to upload.
boolean	canRead() Indicate if this file can be read.
String	getAbsolutePath() Returns the absolute path, as it will be sent during the upload.
static String	getAbsolutePath(TreeFileDataNode node) Retrieves the Absolute Path of a node, within the current visible hierarchy.
TreeFileDataNode	getChild(File file)
TreeFileDataNode	getChild(int index) Get the child with the given index number, from the direct children of this node
TreeFileDataNode	getChild(String name) Get the child with the name, from the direct children of this node.
int	getChildCount() Returns the number of direct children for this node
List<MyTreeNode>	getChildren() Returns the list of direct children for this node
String	getDirectory() Get the directory of the file.
protected File	getFile()
String	getFileExtension()
long	getFileLength()
String	getFileName() Get the original filename.
static String	getFilename(File file) Returns the filename of the file.
InputStream	getInputStream() This function creates an InputStream from this file.
static int[]	getIntArray(int... indexOf)
static TreeFileDataNode[]	getItemArray(TreeFileDataNode... child)
Date	getLastModified()
String	getMD5() Retrieves the MD5 sum of the file.
String	getMimeType() This function return the FileData content type.
MyTreeNode	getParent() Returns the parent for this node.
String	getRelativeDir() Retrieves the path of this file relative to the root directory
FolderNode	getSubfolderOrCreateIt(File file) This method checks if this the given subfolder has already been created.
int	getTotalChildCount() Returns the number of children (direct children children of children...) for this node
TreeFileDataNode	getTreeFileDataNode() Links this FileData to the associated TreeFileDataNode, from the hierarchical view.
TreePath	getTreePath() Get the TreePath for this node, in the hierarchy.
boolean	getUploadFlag() Indicates whether the check box is checked or not.
long	getUploadLength() Get size of upload, which may be different from the actual file length.
boolean	isLeaf() Indicates whether this node has children or not ('terminal' node)
boolean	isPreparedForUpload() Indicates whether the file can be uploaded or not.
void	removeChild(MyTreeNode child) Removes one child from the children list.
void	setFlatModel(FilePanelFlatDataModel2 flatModel) Sets the flat model for the current node.
void	setParent(MyTreeNode parent) Sets the parent for this node.
void	setTreeFileDataNode(TreeFileDataNode node) Setters for the to the associated TreeFileDataNode, from the hierarchical view.
void	setTreeModel(TreeModel model) Sets the tree model for the current node.
void	setUploadFlag(boolean uploadFlag) Allows to set or unset the upload flag.
String	toString() Important: this method is called by the JTree class, as the 'main' name for the node.

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderNode

protected FolderNode(UploadPolicy uploadPolicy,
                     MyTreeTableModel<TreeFileDataNode> model,
                     FilePanelFlatDataModel2 flatModel)

FolderNode

public FolderNode(File file,
                  UploadPolicy uploadPolicy,
                  MyTreeTableModel<TreeFileDataNode> model,
                  FilePanelFlatDataModel2 flatModel)

Creates a node, with no link to any parent. This constructor add no children (subfolders, files) to the newly created FolderNode.

Parameters:

file - The FileData instance to which all calls to the FileData interface are delegated

Method Detail

getFilename

public static String getFilename(File file)

Returns the filename of the file. This utility method is specially used, to manage root folders. For instance new File("E:\\").getName() returns the empty String, instead of "E:\"!

Parameters:

f -

Returns:

The filename, when File.getname() returns a non empty String. Otherwise, it returns File.getCanonical() (for instance, C:\ for a root in Windows)

getAbsolutePath

public static String getAbsolutePath(TreeFileDataNode node)

Retrieves the Absolute Path of a node, within the current visible hierarchy. All node names are concatanated, separated by File.separator. The path starts with a leading File.separator.

Parameters:

node -

Returns:

getIntArray

public static int[] getIntArray(int... indexOf)

getItemArray

public static TreeFileDataNode[] getItemArray(TreeFileDataNode... child)

getTotalChildCount

public int getTotalChildCount()

Description copied from interface: MyTreeNode

Returns the number of children (direct children children of children...) for this node

Specified by:

getTotalChildCount in interface MyTreeNode

Returns:

Number of direct children

See Also:

MyTreeNode.getTotalChildCount()

getChildren

public List<MyTreeNode> getChildren()

Description copied from interface: MyTreeNode

Returns the list of direct children for this node

Specified by:

getChildren in interface MyTreeNode

Returns:

the children for this node

appendFileProperties

public void appendFileProperties(ByteArrayEncoder bae,
                                 int index)
                          throws JUploadIOException

Called during the upload, by the FileUploadThread. The FileData instance should then call the ByteArrayEncoder.appendTextProperty(String, String, int) method to add each file property to the current upload.

Specified by:

appendFileProperties in interface FileData

Parameters:

bae - The byte encoder, where the properties must be added

index - Index of the file concerned by this value. -1 if this is a global parameter.

Throws:

JUploadIOException - Encapsulation of the IOException, if any would occurs.

See Also:

ByteArrayEncoder.appendTextProperty(String, String, int)

beforeUpload

public void beforeUpload(String uploadPathRoot)
                  throws JUploadException

Prepare the fileData to upload. For instance, picture data can be resized before upload (see PictureFileData. This method is called before the upload of this file. If no exception is thrown, then the file is correctly prepared.

Specified by:

beforeUpload in interface FileData

Parameters:

uploadPathRoot - The biggest path which is common to all uploaded files. Used to calculate the relativeDir to this root path, for each file. This relative path is sent as metadata during the upload

Throws:

JUploadException - Encapsulation of the Exception, if any error would occurs.

See Also:

FileUploadThread, FileData.getRelativeDir()

getUploadLength

public long getUploadLength()

Get size of upload, which may be different from the actual file length. This call is valid only after a call to #beforeUpload() and before the call to FileData.afterUpload().

Specified by:

getUploadLength in interface FileData

Returns:

The length of upload. In this class, this is the size of the file, as it isn't transformed for upload. This size may change if encoding is necessary (needs a new FileData class), or if picture is to be resized or rotated.

See Also:

PictureFileData

afterUpload

public void afterUpload()

This function is called after upload, whether it is successful or not. It allows fileData to free any resource created for the upload. For instance, PictureFileData.afterUpload() removes the temporary file, if any was created.

Specified by:

afterUpload in interface FileData

getInputStream

public InputStream getInputStream()
                           throws JUploadException

This function creates an InputStream from this file. The FileUploadThread class then reads bytes from it and transfers them to the webserver. The caller is responsible for closing this stream.
This method may only be called when FileData.isPreparedForUpload() returns true.

Specified by:

getInputStream in interface FileData

Returns:

An InputStream, representing this instance.

Throws:

JUploadException - Encapsulation of the Exception, if any would occurs.

getFileName

public String getFileName()

Get the original filename. This is the name of the file, into the local hardrive

Specified by:

getFileName in interface FileData

Returns:

The original filename

getFileExtension

public String getFileExtension()

Specified by:

getFileExtension in interface FileData

Returns:

The extension for the original file.

getFileLength

public long getFileLength()

Specified by:

getFileLength in interface FileData

Returns:

The length of the original file.

getLastModified

public Date getLastModified()

Specified by:

getLastModified in interface FileData

Returns:

The original file date.

getUploadFlag

public boolean getUploadFlag()

Indicates whether the check box is checked or not. That is: whether the file should be uploaded or not.

Specified by:

getUploadFlag in interface FileData

Returns:

setUploadFlag

public void setUploadFlag(boolean uploadFlag)

Allows to set or unset the upload flag.

Specified by:

setUploadFlag in interface FileData

getDirectory

public String getDirectory()

Get the directory of the file.

Specified by:

getDirectory in interface FileData

Returns:

The directory where this file is stored.

getMD5

public String getMD5()
              throws JUploadException

Retrieves the MD5 sum of the file.
Since 5.0.0, this method is is in DefaultFileData, and is calculated depending on the sendMD5Sum applet parameter, during the file preparation file.

Specified by:

getMD5 in interface FileData

Returns:

The corresponding MD5 sum.

Throws:

JUploadException

See Also:

#beforeUpload()

getMimeType

public String getMimeType()

This function return the FileData content type.

Specified by:

getMimeType in interface FileData

Returns:

The mimeType for the file.

canRead

public boolean canRead()

Indicate if this file can be read. Take care of the File.canRead() methods, that seems to be wrong from time to time.

Specified by:

canRead in interface FileData

Returns:

indicates whether the file can be read or not.

getFile

protected File getFile()

getRelativeDir

public String getRelativeDir()

Retrieves the path of this file relative to the root directory

Specified by:

getRelativeDir in interface FileData

Returns:

This instance's relative path or an empty string if it was not created using a root parameter.

getAbsolutePath

public String getAbsolutePath()

Returns the absolute path, as it will be sent during the upload. In standard mode, it is the concatenation of the root and the relative path, that is: the absolute path of the File to upload on the local file system. In hierarchical mode, it is the path relative to the (empty) upload root.

Specified by:

getAbsolutePath in interface FileData

Returns:

isPreparedForUpload

public boolean isPreparedForUpload()

Indicates whether the file can be uploaded or not. This boolean should be set to true in the call to #beforeUpload(), and the to false in the call to FileData.afterUpload().

Specified by:

isPreparedForUpload in interface FileData

Returns:

True if the file is ready for upload.

getChildCount

public int getChildCount()

Returns the number of direct children for this node

Specified by:

getChildCount in interface MyTreeNode

Returns:

Number of direct children

getChild

public TreeFileDataNode getChild(int index)

Get the child with the given index number, from the direct children of this node

Specified by:

getChild in interface MyTreeNode

Returns:

getChild

public TreeFileDataNode getChild(String name)

Get the child with the name, from the direct children of this node.

Specified by:

getChild in interface MyTreeNode

Parameters:

name - The name of the item we're looking for. For a file, it's the filename, not the absolute path.

Returns:

The child with this name, or null of no such child exists

getChild

public TreeFileDataNode getChild(File file)

getParent

public MyTreeNode getParent()

Returns the parent for this node.

Specified by:

getParent in interface MyTreeNode

Returns:

setParent

public void setParent(MyTreeNode parent)

Sets the parent for this node.

Specified by:

setParent in interface MyTreeNode

setTreeModel

public void setTreeModel(TreeModel model)

Description copied from interface: MyTreeNode

Sets the tree model for the current node. Necessary to properly send the TreeModelEvent.

Specified by:

setTreeModel in interface MyTreeNode

Parameters:

model - The model in which this node is, and to which TreeModelEvent must be sent.

See Also:

MyTreeNode.setTreeModel(TreeModel)

setFlatModel

public void setFlatModel(FilePanelFlatDataModel2 flatModel)

Sets the flat model for the current node. It is necessary, as this flat model must be kept synchronized with the tree model. Each adding o f a child in the tree, must also be done in the flat model.

Specified by:

setFlatModel in interface MyTreeNode

Parameters:

flatModel - The model, which must be kept synchronized.

removeChild

public void removeChild(MyTreeNode child)

Removes one child from the children list.

Specified by:

removeChild in interface MyTreeNode

Parameters:

child - The child to remove

See Also:

MyTreeNode.removeChild(wjhk.jupload2.gui.filepanel.treeview.MyTreeNode)

addChild

public TreeFileDataNode addChild(FileData fileData)

This method adds a new FileData in the children list, for the current object. It checks if this the given child has already been created. If yes, it displays a warning, and returns it. If node, it created a new node, and add it to the children list for this node.

Parameters:

node -

addChild

public TreeFileDataNode addChild(TreeFileDataNode child)

Add a new child to the children of this folder. It first checks that this child doesn't already exists. If yes, an error is displayed.

Parameters:

child -

Returns:

getSubfolderOrCreateIt

public FolderNode getSubfolderOrCreateIt(File file)
                                  throws JUploadExceptionStopAddingFiles

This method checks if this the given subfolder has already been created. And it returns it, if it wasn't. The new node is also added to the children list of this node.

Parameters:

node -

Throws:

JUploadExceptionStopAddingFiles

isLeaf

public boolean isLeaf()

Indicates whether this node has children or not ('terminal' node)

Specified by:

isLeaf in interface MyTreeNode

toString

public String toString()

Important: this method is called by the JTree class, as the 'main' name for the node.

Overrides:

toString in class Object

See Also:

Object.toString()

getTreeFileDataNode

public TreeFileDataNode getTreeFileDataNode()

Links this FileData to the associated TreeFileDataNode, from the hierarchical view.

Specified by:

getTreeFileDataNode in interface FileData

Returns:

setTreeFileDataNode

public void setTreeFileDataNode(TreeFileDataNode node)

Setters for the to the associated TreeFileDataNode, from the hierarchical view. Allows link between the flat and hierarchical view.

Specified by:

setTreeFileDataNode in interface FileData

getTreePath

public TreePath getTreePath()

Get the TreePath for this node, in the hierarchy.

Specified by:

getTreePath in interface MyTreeNode

Returns:

addChild

public TreeFileDataNode addChild(File f)
                          throws JUploadExceptionStopAddingFiles

Adds a given file as a Child of the current node. This file may or may not be in the file of the parent node.

Parameters:

f - The file to add. If f is a folder, none of its descendants (files, folders) will be added. Only f is added.

Returns:

The created child

Throws:

JUploadExceptionStopAddingFiles

addChildAndDescendants

public int addChildAndDescendants(File f)
                           throws JUploadExceptionStopAddingFiles

Adds a given file as a Child of the current node. This file may or may not be in the file of the parent node.

Parameters:

f - The file to add.

Returns:

The total number of files that have been added, not counting the folders.

Throws:

JUploadExceptionStopAddingFiles