fr.cnes.genius.utils

Class GContextFileManagement

java.lang.Object

fr.cnes.genius.utils.GContextFileManagement

public class GContextFileManagement
extends Object

Class to load and save XML files using a file selection dialog.

Author:

JF Goester

Constructor Summary

Constructors

Constructor and Description
GContextFileManagement(String dataCurrentDirectory, String xmlName) Constructor with no filter on the file names.
GContextFileManagement(String dataCurrentDirectory, String xmlName, GFileFilter filter) Constructor with a filter on the file names.

Method Summary

Modifier and Type	Method and Description
String	selectLoadFile(GComponent data, boolean saveValue) Method to load a context file.
String	selectSaveFile(GComponent data, boolean saveValue) Method to save a context file.

Methods inherited from class java.lang.Object

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

Constructor Detail

GContextFileManagement

public GContextFileManagement(String dataCurrentDirectory,
                              String xmlName)

Constructor with no filter on the file names.

Parameters:

dataCurrentDirectory - initial directory to start the research.

xmlName - XML tag of the data.

GContextFileManagement

public GContextFileManagement(String dataCurrentDirectory,
                              String xmlName,
                              GFileFilter filter)

Constructor with a filter on the file names.

Parameters:

dataCurrentDirectory - initial directory to start the research.

xmlName - XML tag of the data.

filter - filter (prefix and/or suffix) on the names of the files.

Method Detail

selectLoadFile

public String selectLoadFile(GComponent data,
                             boolean saveValue)
                      throws GException

Method to load a context file. This method will allow to move in different directories, to select a file name and then to load data from that file. A filter is eventually added with a prefix and a suffix to the name.

Parameters:

data - Data to load.

saveValue - true if the saved values of the components being read from the file shall be updated, false otherwise.

Returns:

the absolute path of the selected file or null if the operation was cancelled.

Throws:

GException

selectSaveFile

public String selectSaveFile(GComponent data,
                             boolean saveValue)
                      throws GFileManipulatorException

Method to save a context file. This method will allow to move in different directories, to select a file name and then to save data in that file, adding eventually a prefix and a suffix to the name. A test is also done to ask, if the file already exists, if one can overwrite it.

Parameters:

data - Data to be saved in the file.

saveValue - true if the saved values of the components being written to the file shall be updated, false otherwise.

Returns:

the absolute path of the selected file or null if the operation was cancelled.

Throws:

GFileManipulatorException - If a problem loading the configuration file arises.