org.das2.util.filesystem

Class SubFileSystem

java.lang.Object

org.das2.util.filesystem.FileSystem

org.das2.util.filesystem.SubFileSystem

public class SubFileSystem
extends FileSystem

present part of a filesystem as a filesystem.

Nested Class Summary

Nested classes/interfaces inherited from class org.das2.util.filesystem.FileSystem

FileSystem.DirectoryEntry, FileSystem.FileSystemOfflineException

Field Summary

Fields inherited from class org.das2.util.filesystem.FileSystem

logger, loggerUrl, NULL, PROP_CASE_INSENSITIVE, properties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubFileSystem(FileSystem parent, java.lang.String dir)

Method Summary

Modifier and Type	Method and Description
FileSystem	createFileSystem(java.lang.String directory) create a new filesystem that is a part of this filesystem, rooted at directory.
FileObject	getFileObject(java.lang.String filename) return the FileObject that corresponds to the name.
java.io.File	getLocalRoot() return the folder that is a local copy of the filesystem.
protected FileSystem	getParent() return the parent filesystem.
boolean	isDirectory(java.lang.String filename) return true if the name is a directory.
java.lang.String[]	listDirectory(java.lang.String directory) returns a list of the names of the files in a directory.
java.lang.String[]	listDirectory(java.lang.String directory, java.lang.String regex) returns a list of the names of the files in a directory that match regex.
java.lang.String	toString()

Methods inherited from class org.das2.util.filesystem.FileSystem

create, create, create, create, create, create, getExceptionHandler, getListing, getListing, getProperty, getRootURI, listDirectory, listDirectory, listDirectoryDeep, peek, peekInstances, recreate, recreate, registerFileSystemFactory, reset, reset, setExceptionHandler, settings, splitUrl, toCanonicalFilename, toCanonicalFolderName, toCanonicalFolderName

Methods inherited from class java.lang.Object

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

Constructor Detail

SubFileSystem

protected SubFileSystem(FileSystem parent,
                        java.lang.String dir)
                 throws java.net.MalformedURLException,
                        java.net.URISyntaxException

Throws:

java.net.MalformedURLException

java.net.URISyntaxException

Method Detail

getFileObject

public FileObject getFileObject(java.lang.String filename)

Description copied from class: FileSystem

return the FileObject that corresponds to the name.

Specified by:

getFileObject in class FileSystem

Parameters:

filename - the file name within the filesystem

Returns:

the FileObject

isDirectory

public boolean isDirectory(java.lang.String filename)
                    throws java.io.IOException

Description copied from class: FileSystem

return true if the name is a directory.

Specified by:

isDirectory in class FileSystem

Parameters:

filename - the name

Returns:

true if the name is a directory.

Throws:

java.io.IOException

listDirectory

public java.lang.String[] listDirectory(java.lang.String directory)
                                 throws java.io.IOException

Description copied from class: FileSystem

returns a list of the names of the files in a directory. Names ending in "/" are themselves directories, and the "/" is not part of the name. This is optional, and a directory may or may not be tagged with the trailing slash.

Specified by:

listDirectory in class FileSystem

Parameters:

directory - the directory name within the filesystem.

Returns:

list of files and folders within the filesystem.

Throws:

java.io.IOException

See Also:

for listings constrained by regular expressions.

listDirectory

public java.lang.String[] listDirectory(java.lang.String directory,
                                        java.lang.String regex)
                                 throws java.io.IOException

Description copied from class: FileSystem

returns a list of the names of the files in a directory that match regex. Trailing slashes on directory names are not part of the name and need not be part of the regex. Note regex is a regular expression (.*\.dat), not a glob (*.dat)

Specified by:

listDirectory in class FileSystem

Parameters:

directory - the directory

regex - regular expression

Returns:

Throws:

java.io.IOException

getLocalRoot

public java.io.File getLocalRoot()

Description copied from class: FileSystem

return the folder that is a local copy of the filesystem. For LocalFilesystem, this is the same as the filesystem. For remote filesystems, this is a folder within their home directory. Note File.getAbsolutePath() returns the string representation of this root.

Specified by:

getLocalRoot in class FileSystem

Returns:

the folder that is a local copy of the filesystem.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getParent

protected FileSystem getParent()

return the parent filesystem.

Returns:

the parent filesystem.

createFileSystem

public FileSystem createFileSystem(java.lang.String directory)
                            throws java.net.URISyntaxException

Description copied from class: FileSystem

create a new filesystem that is a part of this filesystem, rooted at directory.

Overrides:

createFileSystem in class FileSystem

Parameters:

directory - subdirectory within the filesystem.

Returns:

the new FileSystem

Throws:

java.net.URISyntaxException