FileData (JUpload project on Sourceforge 6.0.1 API)

All Known Subinterfaces:

TreeFileDataNode

All Known Implementing Classes:

AudioFileData, DefaultFileData, FileDataNode, FolderNode, PictureFileData, RootNode, UploadFileData, UploadFileDataPoisonned
```
public interface FileData
```
This class contains all data and methods for a file to upload. The current UploadPolicy contains the necessary parameters to personalize the way files must be handled.
The JUpload package provides a default implementation of this class in DefaultFileData. This default implementation contains all necessary methods to allow upload. You can override it to add new file behaviour. For instance, you could add a XMLFileData, that would check that XML is valid before upload. See the package summary for more details about that.
This class is the interface that all FileData must implement. The DefaultFileData class contains the default implementation for this interface. The PictureFileData contains another implementation of this interface, adapted to manage pictures (rotation, resizing...).
The instance of FileData is created by the UploadPolicy#createFileData(File, File) method. This method can be overrided in a new upoad policy, to create an instance of another FileData. See PictureFileData for an example about FileData customization.

Author:

etienne_sf

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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 uploadFileRoot)` 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.
`String`	`getDirectory()` Get the directory of the file.
`String`	`getFileExtension()`
`long`	`getFileLength()`
`String`	`getFileName()` Get the original filename.
`InputStream`	`getInputStream()` This function creates an InputStream from this file.
`Date`	`getLastModified()`
`String`	`getMD5()` Retrieves the MD5 sum of the file.
`String`	`getMimeType()` This function return the FileData content type.
`String`	`getRelativeDir()` Retrieves the path of this file relative to the root directory
`TreeFileDataNode`	`getTreeFileDataNode()` Links this FileData to the associated `TreeFileDataNode`, from the hierarchical view.
`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`	`isPreparedForUpload()` Indicates whether the file can be uploaded or not.
`void`	`setTreeFileDataNode(TreeFileDataNode node)` Setters for the to the associated `TreeFileDataNode`, from the hierarchical view.
`void`	`setUploadFlag(boolean uploadFlag)` Allows to set or unset the upload flag.

- Method Detail
  - appendFileProperties
```
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.
    
    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
```
void beforeUpload(String uploadFileRoot)
           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.
    
    Parameters:
    
    uploadFileRoot - 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, getRelativeDir()
  - getUploadLength
```
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 afterUpload().
    
    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
```
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.
  - getInputStream
```
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 isPreparedForUpload() returns true.
    
    Returns:
    
    An InputStream, representing this instance.
    
    Throws:
    
    JUploadException - Encapsulation of the Exception, if any would occurs.
    
    IllegalStateException - When the upload is not prepared (before a call to #beforeUpload() or after a call to afterUpload()
  - getFileName
```
String getFileName()
```
    Get the original filename. This is the name of the file, into the local hardrive
    
    Returns:
    
    The original filename
  - getFileExtension
```
String getFileExtension()
```
    Returns:
    
    The extension for the original file.
  - getFileLength
```
long getFileLength()
```
    Returns:
    
    The length of the original file.
  - getLastModified
```
Date getLastModified()
```
    Returns:
    
    The original file date.
  - getUploadFlag
```
boolean getUploadFlag()
```
    Indicates whether the check box is checked or not. That is: whether the file should be uploaded or not.
    
    Returns:
  - setUploadFlag
```
void setUploadFlag(boolean uploadFlag)
```
    Allows to set or unset the upload flag.
  - getDirectory
```
String getDirectory()
```
    Get the directory of the file.
    
    Returns:
    
    The directory where this file is stored.
  - getMD5
```
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.
    
    Returns:
    
    The corresponding MD5 sum.
    
    Throws:
    
    JUploadException
    
    See Also:
    
    #beforeUpload()
  - getMimeType
```
String getMimeType()
```
    This function return the FileData content type.
    
    Returns:
    
    The mimeType for the file.
  - canRead
```
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.
    
    Returns:
    
    indicates whether the file can be read or not.
  - getRelativeDir
```
String getRelativeDir()
```
    Retrieves the path of this file relative to the root directory
    
    Returns:
    
    This instance's relative path or an empty string if it was not created using a root parameter.
  - getAbsolutePath
```
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.
    
    Returns:
  - isPreparedForUpload
```
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 afterUpload().
    
    Returns:
    
    True if the file is ready for upload.
    
    Throws:
    
    IllegalStateException - When the upload is not prepared (before a call to #beforeUpload() or after a call to afterUpload()
  - getTreeFileDataNode
```
TreeFileDataNode getTreeFileDataNode()
```
    Links this FileData to the associated TreeFileDataNode, from the hierarchical view.
    
    Returns:
  - setTreeFileDataNode
```
void setTreeFileDataNode(TreeFileDataNode node)
```
    Setters for the to the associated TreeFileDataNode, from the hierarchical view. Allows link between the flat and hierarchical view.

Interface FileData

Method Summary

Method Detail

appendFileProperties

beforeUpload

getUploadLength

afterUpload

getInputStream

getFileName

getFileExtension

getFileLength

getLastModified

getUploadFlag

setUploadFlag

getDirectory

getMD5

getMimeType

canRead

getRelativeDir

getAbsolutePath

isPreparedForUpload

getTreeFileDataNode

setTreeFileDataNode