org.gvsig.educa.portableview

Interface PortableViewFileServices

All Known Implementing Classes:

DefaultPortableViewFileServices

public interface PortableViewFileServices

Method Summary

Modifier and Type	Method and Description
java.io.File	getNewFileName(java.io.File baseFolder, java.lang.String name) Create File instance for a new file on a baseFolder starts with baseName.
java.io.File	getNewWritableFolder(java.io.File baseFolder, java.lang.String baseName) Create a new folder on a baseFolder starts with baseName which is new and writable.
java.io.File	getRelativeTo(java.io.File path, java.io.File basePath) Return path as relative from basePath only if basePath is an ancestor of path:
java.io.File	getWritableFolder(java.io.File baseFolder, java.lang.String baseName) Look for a folder on a baseFolder starts with baseName which is writable.
boolean	isReadableFile(java.io.File file) Informs if file is a readable file ( exists & isFile & canRead)
boolean	isReadableFolder(java.io.File folder) Informs if folder is a readable folder( exists & isDir & canRead)
boolean	isWritableFolder(java.io.File folder) Informs if folder is a writable folder( exists & isDir & canWrite)
MapContext	loadMapContext(java.io.File mapContext, java.io.File relativaPathFolder) Load a mapContext from a file adjusting file paths which are supposed relatives to a folder
void	unzipFile(java.io.File zipFile, java.io.File outputFloder) Unzip a file into a folder
void	zipFolder(java.io.File rootFolder, java.io.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(java.io.File zipFile,
               java.io.File outputFloder)
        throws java.util.zip.ZipException,
               java.io.IOException

Unzip a file into a folder

Parameters:

zipFile -

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

Throws:

java.io.IOException

java.util.zip.ZipException

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

zipFolder

void zipFolder(java.io.File rootFolder,
               java.io.File targetFile)
        throws java.io.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:

java.io.IOException

java.lang.IllegalArgumentException - if there are any problem in parameters

isWritableFolder

boolean isWritableFolder(java.io.File folder)

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

Parameters:

folder -

Returns:

isReadableFolder

boolean isReadableFolder(java.io.File folder)

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

Parameters:

folder -

Returns:

isReadableFile

boolean isReadableFile(java.io.File file)

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

Parameters:

file -

Returns:

getWritableFolder

java.io.File getWritableFolder(java.io.File baseFolder,
                               java.lang.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:

java.lang.IllegalArgumentException - if base folder is not a writable folder

java.lang.IllegalStateException - if can't found a suitable folder

getNewWritableFolder

java.io.File getNewWritableFolder(java.io.File baseFolder,
                                  java.lang.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:

java.lang.IllegalArgumentException - if base folder is not a writable folder

java.lang.IllegalStateException - if can't found a suitable folder

getNewFileName

java.io.File getNewFileName(java.io.File baseFolder,
                            java.lang.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:

java.lang.IllegalArgumentException - if base folder is not a writable folder

java.lang.IllegalStateException - if can't found a suitable folder

getRelativeTo

java.io.File getRelativeTo(java.io.File path,
                           java.io.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(java.io.File mapContext,
                          java.io.File relativaPathFolder)
                   throws java.io.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:

java.io.IOException

PersistenceException