org.gvsig.educa.portableview

Interface PortableViewManager

All Superinterfaces:

Disposable

All Known Implementing Classes:

DefaultPortableViewManager

public interface PortableViewManager
extends Disposable

Library Manager.

Expose main library's functionalities:

• Set default folders configuration
• Get installed Portable View
• Identify and get a Portable View from a file
• Create a new PortableViewCompilation instance
• Create a new PortableViewCompiler instance

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INSTALLER_PROVIDER_NAME

Method Summary

Modifier and Type	Method and Description
void	cleanAllTemporalData() Clear all data in temporal folder
PortableViewCompilation	createCompilationInstance() Creates a new instance of a PortableViewCompilation
PortableViewCompilation	createCompilationInstanceFromMap(PortableView map) Creates a new instance of a PortableViewCompilation based on values map
PortableViewCompiler	createCompilerInstance() Create a new instance of a PortableViewCompiler
java.io.File	generatePackageFile(java.io.File portableViewIntallFolder, java.io.File targetFolder) Create a gvSIG package file (gvspkg) from a portableView installed folder
java.io.File	generatePackageFile(java.lang.String mapId, java.io.File targetFolder) Create a gvSIG package file (gvspkg) from a portableView
java.lang.String	getBaseFileNameFromInfo(PortableViewInformation info) Generates the base name for a PortableView file using its info data
java.lang.String	getBaseFileNameFromInfo(java.lang.String id, java.lang.String name, int version, int buildNumber) Generates the base name for a PortableView file
java.lang.String	getInstallationMapFolder() Gets default folder to locate installed Portable View
java.util.List<PortableView>	getInstalledMaps() Returns all Portable View installed Uses installation folder to locate them
java.util.List<PortableView>	getInstalledMaps(java.lang.String folder) Returns all Portable View installed into the specified folder Uses installation folder to locate them
PortableView	getMapById(java.lang.String mapId) Gets a PortableView from intalledMaps by its id
PortableView	getMapFromFile(java.io.File file) Gets a PortableView from a file
java.lang.String	getTemporalFolder() Gets the folder to use to open any Portable View before access to the information contained in it.
java.lang.String	getTranslation(java.lang.String key) Returns the translation of a string.
boolean	isAPortableViewIntalledFolder(java.io.File folder) Informs if a folder is a valid Portable View installed folder
boolean	isMap(java.io.File file) Informs if a file is a valid Portable View file
void	setInstallationMapFolder(java.lang.String folder) Sets default folder to locate installed Portable View
void	setTemporalFolder(java.lang.String folder) Sets the folder to use to open any Portable View

Methods inherited from interface org.gvsig.tools.dispose.Disposable

dispose

Field Detail

INSTALLER_PROVIDER_NAME

static final java.lang.String INSTALLER_PROVIDER_NAME

See Also:

Constant Field Values

Method Detail

getInstallationMapFolder

java.lang.String getInstallationMapFolder()

Gets default folder to locate installed Portable View

Returns:

default installation folder

setInstallationMapFolder

void setInstallationMapFolder(java.lang.String folder)

Sets default folder to locate installed Portable View

Parameters:

folder -

Throws:

java.lang.IllegalArgumentException - if folder is a file or can't read or not exists

getTemporalFolder

java.lang.String getTemporalFolder()

Gets the folder to use to open any Portable View before access to the information contained in it.

Returns:

temporal folder

setTemporalFolder

void setTemporalFolder(java.lang.String folder)

Sets the folder to use to open any Portable View

Parameters:

folder -

Throws:

java.lang.IllegalArgumentException - if folder is a file or can't write

cleanAllTemporalData

void cleanAllTemporalData()

Clear all data in temporal folder

getInstalledMaps

java.util.List<PortableView> getInstalledMaps()

Returns all Portable View installed

Uses installation folder to locate them

Returns:

All Portable View> installed

getInstalledMaps

java.util.List<PortableView> getInstalledMaps(java.lang.String folder)

Returns all Portable View installed into the specified folder

Uses installation folder to locate them

Parameters:

folder - to analyze

Returns:

All Portable View> installed

Throws:

java.lang.IllegalArgumentException - if folder is not valid (a readable folder)

getMapFromFile

PortableView getMapFromFile(java.io.File file)
                     throws InvalidPortableViewFormatException

Gets a PortableView from a file

Parameters:

file -

Returns:

the Portable View

Throws:

InvalidPortableViewFormatException

getMapById

PortableView getMapById(java.lang.String mapId)

Gets a PortableView from intalledMaps by its id

Parameters:

mapid - PortableView id

Returns:

the Portable View

isMap

boolean isMap(java.io.File file)

Informs if a file is a valid Portable View file

Parameters:

file -

Returns:

isAPortableViewIntalledFolder

boolean isAPortableViewIntalledFolder(java.io.File folder)

Informs if a folder is a valid Portable View installed folder

Parameters:

file -

Returns:

createCompilationInstance

PortableViewCompilation createCompilationInstance()

Creates a new instance of a PortableViewCompilation

Returns:

createCompilationInstanceFromMap

PortableViewCompilation createCompilationInstanceFromMap(PortableView map)
                                                  throws InvalidPortableViewFormatException,
                                                         CantLoadContextException,
                                                         java.io.IOException

Creates a new instance of a PortableViewCompilation based on values map

Parameters:

map - to use as template

Returns:

Throws:

java.io.IOException

CantLoadContextException

InvalidPortableViewFormatException

createCompilerInstance

PortableViewCompiler createCompilerInstance()

Create a new instance of a PortableViewCompiler

Returns:

getBaseFileNameFromInfo

java.lang.String getBaseFileNameFromInfo(PortableViewInformation info)

Generates the base name for a PortableView file using its info data

Parameters:

info -

Returns:

getBaseFileNameFromInfo

java.lang.String getBaseFileNameFromInfo(java.lang.String id,
                                         java.lang.String name,
                                         int version,
                                         int buildNumber)

Generates the base name for a PortableView file

Parameters:

info -

Returns:

generatePackageFile

java.io.File generatePackageFile(java.lang.String mapId,
                                 java.io.File targetFolder)
                          throws PortableViewException,
                                 java.io.IOException

Create a gvSIG package file (gvspkg) from a portableView

Parameters:

mapId - id of map to export

targetFolder - where write package file

Returns:

Throws:

PortableViewException

java.io.IOException

generatePackageFile

java.io.File generatePackageFile(java.io.File portableViewIntallFolder,
                                 java.io.File targetFolder)
                          throws PortableViewException,
                                 java.io.IOException

Create a gvSIG package file (gvspkg) from a portableView installed folder

Parameters:

portableViewIntallFolder - folder of a installed PortableView

targetFolder - where write package file

Returns:

Throws:

PortableViewException

java.io.IOException

getTranslation

java.lang.String getTranslation(java.lang.String key)

Returns the translation of a string.

Parameters:

key - String to translate

Returns:

a String with the translation of the string passed by parameter