org.das2.util.filesystem

Class FileSystemUtil

java.lang.Object

org.das2.util.filesystem.FileSystemUtil

public class FileSystemUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FileSystemUtil()

Method Summary

Modifier and Type	Method and Description
static void	copyStream(java.io.InputStream is, java.io.OutputStream out, ProgressMonitor monitor) copies data from in to out, sending the number of bytesTransferred to the monitor.
static java.io.File	createTempFile(java.io.File localFile, int timeoutSeconds) create a temporary file, based on the name of the localFile.
static void	deleteAllFiles(java.io.File dir, java.lang.String regex) delete all files under the directory, with names matching the regex.
static java.io.File	downloadResourceAsFile(java.net.URI uri, ProgressMonitor monitor) download the URI as a file.
static void	dumpToFile(java.io.InputStream in, java.io.File f) Dump the contents of the InputStream into a file.
static java.lang.String	fromUri(java.net.URI uri) canonical method for converting URI to human-readable string, containing spaces and other illegal characters.
static javax.swing.filechooser.FileFilter	getFileNameExtensionFilter(java.lang.String description, java.lang.String ext) get simple filter based on extension for use with JFileChooser.
static java.net.URI	getParentUri(java.net.URI ruri) return the parent of the URI, or null if this is not possible.
static void	gunzip(java.io.File fz, java.io.File file) un-gzip the file.
static java.net.URI	isCacheable(java.net.URI ruri) return null if the URI is not cacheable, or the URI of the parent if it is.
static void	maybeMkdirs(java.io.File file) create the file folder if it does not exist.
static java.net.URI	toUri(java.lang.String s) encode the string as a URI.
static void	unzip(java.io.File fz, java.io.File file) Deprecated. use gunzip instead.
static void	unzipFile(java.io.File zipFilePath, java.io.File destDir) Extracts a zip file specified by the zipFilePath to a directory specified by destDirectory (will be created if does not exists).
static java.lang.String	uriDecode(java.lang.String s) convert "%20" to " ", etc, by using URLDecoder and catching the UnsupportedEncodingException that will never occur.
static java.lang.String	uriEncode(java.lang.String surl) convert " " to "%20", etc, by looking for and encoding illegal characters.
static void	zip(java.io.File fz, java.io.File dir) create a zip file of everything with and under the directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemUtil

public FileSystemUtil()

Method Detail

dumpToFile

public static void dumpToFile(java.io.InputStream in,
                              java.io.File f)
                       throws java.io.FileNotFoundException,
                              java.io.IOException

Dump the contents of the InputStream into a file. If the inputStream comes from a file, then java.nio is used to transfer the data quickly.

Parameters:

in -

f -

Throws:

java.io.FileNotFoundException

java.io.IOException

unzip

public static void unzip(java.io.File fz,
                         java.io.File file)
                  throws java.io.IOException

Deprecated. use gunzip instead.

un-gzip the file. This is similar to the unix gunzip command. To unzip a file, see fileUnzip

Parameters:

fz - zipped input file

file - unzipped destination file

Throws:

java.io.IOException

gunzip

public static void gunzip(java.io.File fz,
                          java.io.File file)
                   throws java.io.IOException

un-gzip the file. This is similar to the unix gunzip command.

Parameters:

fz - zipped input file

file - unzipped destination file

Throws:

java.io.IOException

zip

public static void zip(java.io.File fz,
                       java.io.File dir)
                throws java.io.IOException

create a zip file of everything with and under the directory.

Parameters:

fz - the output

dir - the root directory.

Throws:

java.io.IOException

unzipFile

public static void unzipFile(java.io.File zipFilePath,
                             java.io.File destDir)
                      throws java.io.IOException

Extracts a zip file specified by the zipFilePath to a directory specified by destDirectory (will be created if does not exists). From http://www.codejava.net/java-se/file-io/programmatically-extract-a-zip-file-using-java

Parameters:

zipFilePath -

destDir -

Throws:

java.io.IOException

deleteAllFiles

public static void deleteAllFiles(java.io.File dir,
                                  java.lang.String regex)

delete all files under the directory, with names matching the regex.

Parameters:

dir - the directory

regex - the regular expression, like ".*\.png"

See Also:

Glob.getRegex(java.lang.String)

copyStream

public static void copyStream(java.io.InputStream is,
                              java.io.OutputStream out,
                              ProgressMonitor monitor)
                       throws java.io.IOException

copies data from in to out, sending the number of bytesTransferred to the monitor. The input and output are not closed.

Parameters:

is - the input stream, which will not be closed.

out - the output stream, which will not be closed.

monitor - a monitor, or null.

Throws:

java.io.IOException

isCacheable

public static java.net.URI isCacheable(java.net.URI ruri)

return null if the URI is not cacheable, or the URI of the parent if it is. For example,

 
 URI uri= new URL("http://autoplot.org/data/demos2011.xml").toURI();
 URI parentUri= FileSystemUtil.isCacheable( uri );
 if ( parentUri ) {
     FileSystem fd= FileSystem.create(parentUri);
     FileObject fo= fd.getFileObject( ruri.relativize(parentUri).toString() );
     in= fo.getInputStream();
 }
 
 

Parameters:

ruri -

Returns:

the URI of the parent, or null.

getParentUri

public static java.net.URI getParentUri(java.net.URI ruri)

return the parent of the URI, or null if this is not possible.

Parameters:

ruri -

Returns:

maybeMkdirs

public static void maybeMkdirs(java.io.File file)
                        throws java.io.IOException

create the file folder if it does not exist. Throw an IOException if it failed.

Parameters:

file -

Throws:

java.io.IOException

uriEncode

public static java.lang.String uriEncode(java.lang.String surl)

convert " " to "%20", etc, by looking for and encoding illegal characters. We can't just aggressively convert... Note too that colons still cause problems on Windows and should not be used in file names!

Parameters:

surl -

Returns:

uriDecode

public static java.lang.String uriDecode(java.lang.String s)

convert "%20" to " ", etc, by using URLDecoder and catching the UnsupportedEncodingException that will never occur.

Parameters:

s -

Returns:

fromUri

public static java.lang.String fromUri(java.net.URI uri)

canonical method for converting URI to human-readable string, containing spaces and other illegal characters. Note pluses in the query part are interpreted as spaces. This was borrowed from Autoplot's URISplit code.

Parameters:

uri - URI like URI("file:/home/jbf/ct/autoplot/bugs/1830227625/%5BajbTest%5D/")

Returns:

string representation of a path like file:/home/jbf/ct/autoplot/bugs/1830227625/[ajbTest]/

toUri

public static java.net.URI toUri(java.lang.String s)

encode the string as a URI. The following characters are encoded: " " % < > [ ]

Parameters:

s - string representation of a path like file:/home/jbf/ct/autoplot/bugs/1830227625/[ajbTest]/

Returns:

URI like URI("file:/home/jbf/ct/autoplot/bugs/1830227625/%5BajbTest%5D/")

createTempFile

public static java.io.File createTempFile(java.io.File localFile,
                                          int timeoutSeconds)

create a temporary file, based on the name of the localFile. This will be a different name, and may exist already. The problem with using deleteOnExit, is that Autoplot may be running within a webserver that doesn't exit. Java7 nio2 introduces more methods for cleaning up temporary files, but even delete-on-close doesn't work because often a file is opened and closed several times.

Parameters:

localFile - which need not exist.

timeoutSeconds - the minimum number of seconds this file will exist.

Returns:

a new file that is a different but predictable name.

getFileNameExtensionFilter

public static javax.swing.filechooser.FileFilter getFileNameExtensionFilter(java.lang.String description,
                                                                            java.lang.String ext)

get simple filter based on extension for use with JFileChooser.

Parameters:

description - descriptions, like "png image file"

ext - file extension, like ".png"

Returns:

the FileFilter

downloadResourceAsFile

public static java.io.File downloadResourceAsFile(java.net.URI uri,
                                                  ProgressMonitor monitor)
                                           throws java.io.IOException

download the URI as a file. Presently these must be files which can be in a FileSystem.

Parameters:

uri -

monitor -

Returns:

Throws:

java.io.IOException