uk.ac.gla.terrier.utility.io
Class LocalFileSystem

java.lang.Object
  uk.ac.gla.terrier.utility.io.LocalFileSystem

All Implemented Interfaces:

Files.FSCapability, FileSystem

public class LocalFileSystem
extends java.lang.Object
implements FileSystem, Files.FSCapability

This is a Terrier File Abstraction Layer implementation of the local file system. The file system implementation for the "file:" scheme can handle all file system capabilities (READ,WRITE,RANDOM_READ,RANDOM_WRITE,LS_DIR and STAT). Generally speaking, this is a lightweight wrapper around the following four Java SE classes: java.io.File and java.io.FileInputStream and java.io.FileOutputStream, java.io.RandomAccessFile.

On Windows, this FileSystem also advertises support for all the single-letter file systems, eg A:, C:, D:

Since:

2.1

Version:

$Revision: 1.6 $

Author:

Craig Macdonald

Field Summary

Fields inherited from interface uk.ac.gla.terrier.utility.Files.FSCapability

DEL_ON_EXIT, LS_DIR, RANDOM_READ, RANDOM_WRITE, READ, STAT, WRITE

Constructor Summary

LocalFileSystem()

Method Summary

boolean	canRead(java.lang.String filename) returns true if filename can be read
boolean	canWrite(java.lang.String filename) returns true if filename can be written to
byte	capabilities() capabilities of the filesystem
boolean	delete(java.lang.String filename) delete the named file
boolean	deleteOnExit(java.lang.String pathname) delete the file after the JVM exits
boolean	exists(java.lang.String filename) returns true if the path exists
java.lang.String	getParent(java.lang.String path) whats the parent path to this path - eg directory containing a file
boolean	isDirectory(java.lang.String path) returns true if path is a directory
long	length(java.lang.String filename) returns the length of the specified file
java.lang.String[]	list(java.lang.String path) list contents of a directory etc
boolean	mkdir(java.lang.String filename) mkdir the specified path
java.lang.String	name() returns a name for the filesystem
RandomDataInput	openFileRandom(java.lang.String filename) open a file for random input
java.io.InputStream	openFileStream(java.lang.String filename) open a file of given filename for readinng
boolean	rename(java.lang.String source, java.lang.String destination) rename a file/dir to another name, on the same file system
java.lang.String[]	schemes() URI schemes supported by this class
RandomDataOutput	writeFileRandom(java.lang.String filename) open a file of given filename for random writing
java.io.OutputStream	writeFileStream(java.lang.String filename) open a file of given filename for writing

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalFileSystem

public LocalFileSystem()

Method Detail

name

public java.lang.String name()

Description copied from interface: FileSystem

returns a name for the filesystem

Specified by:

name in interface FileSystem

capabilities

public byte capabilities()

Description copied from interface: FileSystem

capabilities of the filesystem

Specified by:

capabilities in interface FileSystem

schemes

public java.lang.String[] schemes()

Description copied from interface: FileSystem

URI schemes supported by this class

Specified by:

schemes in interface FileSystem

exists

public boolean exists(java.lang.String filename)

Description copied from interface: FileSystem

returns true if the path exists

Specified by:

exists in interface FileSystem

canRead

public boolean canRead(java.lang.String filename)

returns true if filename can be read

Specified by:

canRead in interface FileSystem

canWrite

public boolean canWrite(java.lang.String filename)

returns true if filename can be written to

Specified by:

canWrite in interface FileSystem

openFileStream

public java.io.InputStream openFileStream(java.lang.String filename)
                                   throws java.io.IOException

Description copied from interface: FileSystem

open a file of given filename for readinng

Specified by:

openFileStream in interface FileSystem

Throws:

java.io.IOException

writeFileStream

public java.io.OutputStream writeFileStream(java.lang.String filename)
                                     throws java.io.IOException

Description copied from interface: FileSystem

open a file of given filename for writing

Specified by:

writeFileStream in interface FileSystem

Throws:

java.io.IOException

openFileRandom

public RandomDataInput openFileRandom(java.lang.String filename)
                               throws java.io.IOException

Description copied from interface: FileSystem

open a file for random input

Specified by:

openFileRandom in interface FileSystem

Throws:

java.io.IOException

writeFileRandom

public RandomDataOutput writeFileRandom(java.lang.String filename)
                                 throws java.io.IOException

Description copied from interface: FileSystem

open a file of given filename for random writing

Specified by:

writeFileRandom in interface FileSystem

Throws:

java.io.IOException

delete

public boolean delete(java.lang.String filename)

Description copied from interface: FileSystem

delete the named file

Specified by:

delete in interface FileSystem

deleteOnExit

public boolean deleteOnExit(java.lang.String pathname)
                     throws java.io.IOException

Description copied from interface: FileSystem

delete the file after the JVM exits

Specified by:

deleteOnExit in interface FileSystem

Throws:

java.io.IOException

mkdir

public boolean mkdir(java.lang.String filename)

Description copied from interface: FileSystem

mkdir the specified path

Specified by:

mkdir in interface FileSystem

isDirectory

public boolean isDirectory(java.lang.String path)

Description copied from interface: FileSystem

returns true if path is a directory

Specified by:

isDirectory in interface FileSystem

length

public long length(java.lang.String filename)

Description copied from interface: FileSystem

returns the length of the specified file

Specified by:

length in interface FileSystem

rename

public boolean rename(java.lang.String source,
                      java.lang.String destination)
               throws java.io.IOException

rename a file/dir to another name, on the same file system

Specified by:

rename in interface FileSystem

Throws:

java.io.IOException

getParent

public java.lang.String getParent(java.lang.String path)
                           throws java.io.IOException

whats the parent path to this path - eg directory containing a file

Specified by:

getParent in interface FileSystem

Throws:

java.io.IOException

list

public java.lang.String[] list(java.lang.String path)
                        throws java.io.IOException

list contents of a directory etc

Specified by:

list in interface FileSystem

Throws:

java.io.IOException