fr.cnes.genius.main

Class GFileManipulation

java.lang.Object

fr.cnes.genius.main.GFileManipulation

public final class GFileManipulation
extends Object

Class defining the methods needed to handle the configuration files in XML. It provides methods to read/write values from the configuration files.

Author:

jjct

Method Summary

Modifier and Type	Method and Description
static void	copyComponent(GComponent component) Copies the values of the component and all the child components to the configuration file.
static org.jdom.Document	createDomDocument(String filename) create a dom document from the configuration file
static void	exportComponent(GComponent component) Export the values of the component and all the child components to the configuration file.
static List<org.jdom.Element>	findAllElements(org.jdom.Element sourceElement, String itemType, String componentName) Finds the elements in the DOM structure corresponding to a certain name and with an attribute
static org.jdom.Element	findElement(org.jdom.Element sourceElement, GItemTypeInterface itemType, String attribute, String attributeValue) Finds the element in the DOM structure corresponding to a certain name and with an attribute equal to attributeValue.
static org.jdom.Element	findElement(org.jdom.Element sourceElement, GItemTypeInterface itemType, String attribute, String attributeValue, String defaultValue) Finds the element in the DOM structure corresponding to a certain name and with an attribute equal to attributeValue.
static org.jdom.Element	findElement(org.jdom.Element sourceElement, String itemType, String attribute, String attributeValue, String defaultValue) Deprecated. The argument type should be an enum implementing the interface GItemTypeInterface instead of a String. See GItemTypeInterface for more details.
static org.jdom.Element	findFirstElement(org.jdom.Element sourceElement, String itemType, String elementName, String defaultValue) Finds the First element in the DOM structure corresponding to a certain element name.
static String	getClipboardString() Get the contents of the clipboar as a string.
static String	getXmlItemType(GComponent component) get the xml type in the configuration file
static void	importComponent(GComponent component) Imports the values of the component and all the child components from the configuration file.
static void	loadComponent(String filename, String componentName, GComponent component) Reads from the configuration file the configuration values for to the component identified in the method.
static void	loadFromDomDocument(org.jdom.Document domDocument, String componentName, GComponent component, boolean saveValue, boolean... rootVerification) Load the component values from a Dom document.
static void	pasteComponent(GComponent component) Paste from the configuration file the configuration values for to the component identified in the method.
static void	readConfig(String filename, String componentName, GComponent component, boolean saveValue, boolean... verifications) Reads from the configuration file the configuration values for to the component identified in the method.
static void	readConfigComponent(GComponent component) read the configuration file for only one GComponent
static void	resetComponent(GComponent component) Reset the component given in input.
static void	saveComponent(String filename, String componentName, GComponent component) Writes the values of the component and all the child components to the configuration file.
static org.jdom.Document	saveToDomDocument(String componentName, GComponent component, boolean saveValue) Create a DOM document containing the informations of the component.
static List<GComponent>	searchCompatibleComponents(GComponent component, GComponent componentToSearch, boolean useComponentName) search compatible objects from a GComponent
static List<GComponent>	searchCompatibleComponents(String filename, GComponent componentToSearch, boolean useComponentName) search compatible objects from a configuration file
static void	writeConfig(String filename, String componentName, GComponent component, boolean saveValue) Writes the values of the component and all the child components to the configuration file.
static void	writeConfigFromElement(GComponent component, String filename, org.jdom.Element element) Writes the values of the Element to the configuration file.

Methods inherited from class java.lang.Object

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

Method Detail

resetComponent

public static void resetComponent(GComponent component)
                           throws GFileManipulatorException

Reset the component given in input. The element of the component is cleared and retrieve the default values

Parameters:

component - instance of the component that will be cleared.

Throws:

GFileManipulatorException - in case there is a problem loading the values from the Dom document.

loadFromDomDocument

public static void loadFromDomDocument(org.jdom.Document domDocument,
                                       String componentName,
                                       GComponent component,
                                       boolean saveValue,
                                       boolean... rootVerification)
                                throws GFileManipulatorException

Load the component values from a Dom document.

Parameters:

domDocument - Dom document to load the component values.

componentName - name of the component that shall be loaded from the configuration file.

component - instance of the component that will be loaded with the values loaded from the configuration file.

saveValue - true if the saved values of the components being loaded from the dom document shall be updated, false otherwise.

rootVerification - if true prevents the type verification of the configuration file

Throws:

GFileManipulatorException - in case there is a problem loading the values from the Dom document.

readConfigComponent

public static void readConfigComponent(GComponent component)
                                throws GFileManipulatorException

read the configuration file for only one GComponent

Parameters:

component - instance of the component that will be loaded with the values loaded from the configuration file.

Throws:

GFileManipulatorException - in case there is a problem reading the configuration file.

readConfig

public static void readConfig(String filename,
                              String componentName,
                              GComponent component,
                              boolean saveValue,
                              boolean... verifications)
                       throws GFileManipulatorException

Reads from the configuration file the configuration values for to the component identified in the method. parameters.

Parameters:

filename - of the configuration file.

componentName - name of the component that shall be loaded from the configuration file.

component - instance of the component that will be loaded with the values loaded from the configuration file.

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

verifications - if true prevents the type verification of the configuration file

Throws:

GFileManipulatorException - in case there is a problem reading the configuration file.

loadComponent

public static void loadComponent(String filename,
                                 String componentName,
                                 GComponent component)
                          throws GFileManipulatorException

Reads from the configuration file the configuration values for to the component identified in the method. parameters.

Parameters:

filename - of the configuration file.

componentName - name of the component that shall be loaded from the configuration file.

component - instance of the component that will be loaded with the values loaded from the configuration file.

Throws:

GFileManipulatorException - in case there is a problem reading the configuration file.

pasteComponent

public static void pasteComponent(GComponent component)

Paste from the configuration file the configuration values for to the component identified in the method. parameters.

Parameters:

component - instance of the component that will be pasted from clipboard.

saveToDomDocument

public static org.jdom.Document saveToDomDocument(String componentName,
                                                  GComponent component,
                                                  boolean saveValue)
                                           throws GFileManipulatorException

Create a DOM document containing the informations of the component.

Parameters:

componentName - name of the component that shall be stored in the configuration file.

component - instance of the component that will be stored with the values loaded from the configuration file.

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

Returns:

the Dom document containing the informations of the component.

Throws:

GFileManipulatorException - in case there is a problem writing the configuration file.

writeConfigFromElement

public static void writeConfigFromElement(GComponent component,
                                          String filename,
                                          org.jdom.Element element)
                                   throws GFileManipulatorException

Writes the values of the Element to the configuration file.

Parameters:

component - used to change element

filename - of the configuration file.

element - Element from parent dom document

Throws:

GFileManipulatorException - is raised if there is a problem with the cration of the xml file

writeConfig

public static void writeConfig(String filename,
                               String componentName,
                               GComponent component,
                               boolean saveValue)
                        throws GFileManipulatorException

Writes the values of the component and all the child components to the configuration file.

Parameters:

filename - of the configuration file.

componentName - name of the component that shall be stored in the configuration file.

component - instance of the component that will be stored with the values loaded from the configuration file.

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

Throws:

GFileManipulatorException - in case there is a problem writing the configuration file.

createDomDocument

public static org.jdom.Document createDomDocument(String filename)
                                           throws GFileManipulatorException

create a dom document from the configuration file

Parameters:

filename - of the configuration file.

Returns:

DOM document where the configuration file will be loaded.

Throws:

GFileManipulatorException - in case there is a problem writing the configuration file.

searchCompatibleComponents

public static List<GComponent> searchCompatibleComponents(GComponent component,
                                                          GComponent componentToSearch,
                                                          boolean useComponentName)
                                                   throws GException

search compatible objects from a GComponent

Parameters:

component - to search objects in the configuration file

componentToSearch - in the main component

useComponentName - true if the name of the component is used to filter the research.

Returns:

a list of GComponents compatible with the item type given in input

Throws:

GException - in case there is a problem with element research

searchCompatibleComponents

public static List<GComponent> searchCompatibleComponents(String filename,
                                                          GComponent componentToSearch,
                                                          boolean useComponentName)
                                                   throws GException

search compatible objects from a configuration file

Parameters:

filename - of the configuration file.

componentToSearch - to compare with objects in the configuration file

useComponentName - true if the name of the component is used to filter the research.

Returns:

a list of GComponents compatible with the GComponent given in input

Throws:

GException - in case there is a problem with the configuration file or a missing constructor

saveComponent

public static void saveComponent(String filename,
                                 String componentName,
                                 GComponent component)
                          throws GFileManipulatorException

Writes the values of the component and all the child components to the configuration file.

Parameters:

filename - of the configuration file.

componentName - name of the component that shall be stored in the configuration file.

component - instance of the component that will be stored with the values loaded from the configuration file.

Throws:

GFileManipulatorException - in case there is a problem writing the configuration file.

copyComponent

public static void copyComponent(GComponent component)
                          throws GFileManipulatorException

Copies the values of the component and all the child components to the configuration file.

Parameters:

component - instance of the component whose values will be copied to clipboard.

Throws:

GFileManipulatorException - in case there is a problem writing the configuration file to clipboard.

exportComponent

public static void exportComponent(GComponent component)
                            throws GFileManipulatorException

Export the values of the component and all the child components to the configuration file.

Parameters:

component - instance of the component whose values will be exported in the configuration file.

Throws:

GFileManipulatorException - in case there is a problem writing the configuration file.

importComponent

public static void importComponent(GComponent component)

Imports the values of the component and all the child components from the configuration file.

Parameters:

component - instance of the component that will be stored with the values imported from the configuration file.

findElement

@Deprecated
public static org.jdom.Element findElement(org.jdom.Element sourceElement,
                                                       String itemType,
                                                       String attribute,
                                                       String attributeValue,
                                                       String defaultValue)
                                                throws GException

Deprecated. The argument type should be an enum implementing the interface GItemTypeInterface instead of a String. See GItemTypeInterface for more details.

Finds the element in the DOM structure corresponding to a certain name and with an attribute equal to attributeValue.

Parameters:

sourceElement - from which the search starts.

itemType - of the searched element.

attribute - that shall be matched.

attributeValue - value to match the attribute.

defaultValue - default value in case that the element is not found.

Returns:

if found the element, otherwise the defaultValue if not null, otherwise null.

Throws:

GException - in case the element or the searched attribute do not exist.

findAllElements

public static List<org.jdom.Element> findAllElements(org.jdom.Element sourceElement,
                                                     String itemType,
                                                     String componentName)
                                              throws GException

Finds the elements in the DOM structure corresponding to a certain name and with an attribute

Parameters:

sourceElement - from which the search starts.

itemType - of the searched element.

componentName - the name of the component used to filter the research.

Returns:

if found the list of compatibles elements with itemType.

Throws:

GException - in case there is a problem with element research

findElement

public static org.jdom.Element findElement(org.jdom.Element sourceElement,
                                           GItemTypeInterface itemType,
                                           String attribute,
                                           String attributeValue,
                                           String defaultValue)
                                    throws GException

Finds the element in the DOM structure corresponding to a certain name and with an attribute equal to attributeValue.

Parameters:

sourceElement - from which the search starts.

itemType - of the searched element.

attribute - that shall be matched.

attributeValue - value to match the attribute.

defaultValue - default value in case that the element is not found.

Returns:

if found the element, otherwise the defaultValue if not null, otherwise null.

Throws:

GException - in case the element or the searched attribute do not exist.

findElement

public static org.jdom.Element findElement(org.jdom.Element sourceElement,
                                           GItemTypeInterface itemType,
                                           String attribute,
                                           String attributeValue)
                                    throws GException

Finds the element in the DOM structure corresponding to a certain name and with an attribute equal to attributeValue. This interface does not use a default value.

Parameters:

sourceElement - from which the search starts.

itemType - of the searched element.

attribute - that shall be matched.

attributeValue - value to match the attribute.

Returns:

if found the element, otherwise the defaultValue if not null, otherwise null.

Throws:

GException - in case the element or the searched attribute do not exist.

findFirstElement

public static org.jdom.Element findFirstElement(org.jdom.Element sourceElement,
                                                String itemType,
                                                String elementName,
                                                String defaultValue)
                                         throws GException

Finds the First element in the DOM structure corresponding to a certain element name.

Parameters:

sourceElement - from which the search starts.

itemType - of the searched element.

elementName - value to match the element.

defaultValue - default value in case that the element is not found.

Returns:

if found the element, otherwise the defaultValue if not null, otherwise null.

Throws:

GException - in case the element or the searched attribute do not exist.

getClipboardString

public static String getClipboardString()

Get the contents of the clipboar as a string.

Returns:

the contents of the clipboard as a string or an empty string if the clipboard is empty or does not contain a string.

getXmlItemType

public static String getXmlItemType(GComponent component)
                             throws GFileManipulatorException

get the xml type in the configuration file

Parameters:

component - used to get back the xml type

Returns:

String the xml type

Throws:

GFileManipulatorException - in case there is problem with the elements resarch