org.gvsig.educa.portableview

Interface PortableViewFileServices

All Known Implementing Classes:

DefaultPortableViewFileServices

public interface PortableViewFileServices

Method Summary

Modifier and Type	Method and Description
File	getNewFileName(File baseFolder, String name) Create File instance for a new file on a baseFolder starts with baseName.
File	getNewWritableFolder(File baseFolder, String baseName) Create a new folder on a baseFolder starts with baseName which is new and writable.
File	getRelativeTo(File path, File basePath) Return path as relative from basePath only if basePath is an ancestor of path:
File	getWritableFolder(File baseFolder, String baseName) Look for a folder on a baseFolder starts with baseName which is writable.
boolean	isReadableFile(File file) Informs if file is a readable file ( exists & isFile & canRead)
boolean	isReadableFolder(File folder) Informs if folder is a readable folder( exists & isDir & canRead)
boolean	isWritableFolder(File folder) Informs if folder is a writable folder( exists & isDir & canWrite)
MapContext	loadMapContext(File mapContext, File relativaPathFolder) Load a mapContext from a file adjusting file paths which are supposed relatives to a folder
void	unzipFile(File zipFile, File outputFloder) Unzip a file into a folder
void	zipFolder(File rootFolder, File targetFile) Create a zip file which will contains all contents of a folder Files will be use relative path to rootFolder

Method Detail

unzipFile

void unzipFile(File zipFile,
               File outputFloder)
        throws ZipException,
               IOException

Unzip a file into a folder

Parameters:

zipFile -

outputFloder - must exists. WARNING: Contents will be removed before unzip

Throws:

IOException

ZipException

IllegalArgumentException - if zipFile is not a file or outputFloder doesn't exists or is read-only

zipFolder

void zipFolder(File rootFolder,
               File targetFile)
        throws IOException

Create a zip file which will contains all contents of a folder

Files will be use relative path to rootFolder

Parameters:

rootFolder - rootFolder (must be an existing folder)

targetFile - final file (must not exists)

Throws:

IOException

IllegalArgumentException - if there are any problem in parameters

isWritableFolder

boolean isWritableFolder(File folder)

Informs if folder is a writable folder( exists & isDir & canWrite)

Parameters:

folder -

Returns:

isReadableFolder

boolean isReadableFolder(File folder)

Informs if folder is a readable folder( exists & isDir & canRead)

Parameters:

folder -

Returns:

isReadableFile

boolean isReadableFile(File file)

Informs if file is a readable file ( exists & isFile & canRead)

Parameters:

file -

Returns:

getWritableFolder

File getWritableFolder(File baseFolder,
                       String baseName)

Look for a folder on a baseFolder starts with baseName which is writable.

The pattern is: baseFolder/baseName.0000 where 000 it's a counter.

Parameters:

baseFolder - existing and writable folder

baseName - start of new folder

Returns:

new folder

Throws:

IllegalArgumentException - if base folder is not a writable folder

IllegalStateException - if can't found a suitable folder

getNewWritableFolder

File getNewWritableFolder(File baseFolder,
                          String baseName)

Create a new folder on a baseFolder starts with baseName which is new and writable.

The pattern is: baseFolder/baseName.0000 where 000 it's a counter.

Parameters:

baseFolder - existing and writable folder

baseName - start of new folder

Returns:

new folder

Throws:

IllegalArgumentException - if base folder is not a writable folder

IllegalStateException - if can't found a suitable folder

getNewFileName

File getNewFileName(File baseFolder,
                    String name)

Create File instance for a new file on a baseFolder starts with baseName.

The pattern is: baseFolder/baseName.0000.ext where 000 it's a counter.

This no create the file into the file system.

Parameters:

baseFolder - existing and writable folder

name - start of new file

Returns:

new folder

Throws:

IllegalArgumentException - if base folder is not a writable folder

IllegalStateException - if can't found a suitable folder

getRelativeTo

File getRelativeTo(File path,
                   File basePath)

Return path as relative from basePath only if basePath is an ancestor of path:

Parameters:

path -

basePath -

Returns:

See Also:

FilenameUtils#getRelativeTo(String, String)

loadMapContext

MapContext loadMapContext(File mapContext,
                          File relativaPathFolder)
                   throws IOException,
                          PersistenceException

Load a mapContext from a file adjusting file paths which are supposed relatives to a folder

Parameters:

mapContext - persistence file

relativaPathFolder - for files refered in mapContext

Returns:

Throws:

IOException

PersistenceException