/ - Diff - Plateforme TXM - Forge du Centre Blaise Pascal

Revision 2383

      * of command scope or alternative scope so the preference will not be saved in the local scope .prefs file if its a default value.
      * TODO: when we'll use IProject for managing Corporas, the local node should be stored in the ProjectScope instead of in the InstanceScope.
      * TODO: need to determine if we'll use this class to persistence of TXM results. At this moment, we persist result by calling flush() that creates a file named by the result node qualifier,
      *  eg. org.txm.partition.core.functions.PartitionDimensions@732982cb.prefs
      * eg. org.txm.partition.core.functions.PartitionDimensions@732982cb.prefs
      * (We can also define a custom Scope to do that, for example to change the saved object location or the filename)
+     *
+     *
-...
      * @author sjacquot
+     *
      */
     //FIXME: AFTER some tests, the local nodes are flushed when editing a Charts engine preference from the UI, actually the prefs are flushed if we change a charts engine preference and then it becomes
     // FIXME: AFTER some tests, the local nodes are flushed when editing a Charts engine preference from the UI, actually the prefs are flushed if we change a charts engine preference and then it becomes
     // different from the local result, eg. "Show Legend" or "Rendering colors mode". See if it's what we want.
     // Otherwise, to avoid that we need to define our own Scope, but the problem will disappear when
     // we'll use the ProjectScope.
     public abstract class TXMPreferences extends AbstractPreferenceInitializer {
     	/**
     	 * Scope used for storing the command preferences.
     	 */
     	//public static IScopeContext scope = InstanceScope.INSTANCE;
     	// public static IScopeContext scope = InstanceScope.INSTANCE;
     	public static IEclipsePreferences preferencesRootNode = Platform.getPreferencesService().getRootNode();
     	/**
     	 * Alternative nodes to look up when getting a preference.
     	 */
     	public static ArrayList<String> alternativeNodesQualifiers = new ArrayList<String>();
     	// TXMResult internal parameters, essentially for Links and Persistence
     	public final static String RESULT_PARAMETERS_NODE_PATH = "result_parameters_node_path"; //$NON-NLS-1$
     	public final static String PARENT_PARAMETERS_NODE_PATH = "parent_parameters_node_path"; //$NON-NLS-1$
     	public final static String BUNDLE_ID = "bundle_id"; //$NON-NLS-1$
     	public final static String USER_NAME = "user_name"; //$NON-NLS-1$
     	public final static String LAZY_NAME = "lazy_name"; //$NON-NLS-1$
     	public final static String VISIBLE = "visible"; //$NON-NLS-1$
     	public static final String LOCK = "locked_result"; //$NON-NLS-1$
     	/**
-...
     	// Command preferences shared strings
     	// Command preferences shared strings
     	/**
     	 * Queries.
     	 */
     	public static final String QUERIES = "queries"; //$NON-NLS-1$
     	/**
     	 * Query.
     	 */
     	public static final String QUERY = "query"; //$NON-NLS-1$
     	/**
     	 * Structural unit.
     	 */
     	public static final String STRUCTURAL_UNIT = "structural_unit"; //$NON-NLS-1$
     	/***
     	 * Structural unit property.
     	 */
     	public static final String STRUCTURAL_UNIT_PROPERTY = "structural_unit_property"; //$NON-NLS-1$
     	public static final String STRUCTURAL_UNIT_PROPERTY = "structural_unit_property"; //$NON-NLS-1$
     	/**
     	 * Structural unit properties.
     	 */
     	public static final String STRUCTURAL_UNIT_PROPERTIES = "structural_unit_properties"; //$NON-NLS-1$
     	/**
     	 * Unit property.
     	 */
     	public static final String UNIT_PROPERTY =  "unit_property"; //$NON-NLS-1$
     	public static final String UNIT_PROPERTY = "unit_property"; //$NON-NLS-1$
     	/**
     	 * Unit properties.
     	 */
     	public static final String UNIT_PROPERTIES =  "unit_properties"; //$NON-NLS-1$
     	public static final String UNIT_PROPERTIES = "unit_properties"; //$NON-NLS-1$
     	/**
     	 * List of values
     	 */
     	public static final String VALUES = "values"; //$NON-NLS-1$
     	/**
     	 * Matches.
     	 */
     	public static final String MATCHES = "matches"; //$NON-NLS-1$
     	/**
     	 * Minimum frequency filter value.
     	 */
     	public static final String F_MIN = "f_min"; //$NON-NLS-1$
     	/**
     	 * Maximum frequency filter value.
     	 */
     	public static final String F_MAX = "f_max"; //$NON-NLS-1$
     	/**
     	 * V max filter (max number of lines).
     	 * V max filter (max number of lines).
     	 */
     	public static final String V_MAX = "v_max"; //$NON-NLS-1$
     	/**
     	 * Separator used when converting list from and to string.
     	 */
     	public static final String LIST_SEPARATOR =  "\t"; //$NON-NLS-1$
     	public static final String LIST_SEPARATOR = "\t"; //$NON-NLS-1$
     	/**
     	 * Number of lines to display per page.
     	 */
     	public static final String N_LINES_PER_PAGE = "n_lines_per_page"; //$NON-NLS-1$
     	/**
     	 * Encoding.
     	 */
-...
     	 * Default unit/token property String.
     	 */
     	public final static String DEFAULT_UNIT_PROPERTY = "word"; //$NON-NLS-1$
     	/**
     	 * Default structural unit String.
     	 */
     	public final static String DEFAULT_STRUCTURAL_UNIT = "text"; //$NON-NLS-1$
     	/**
     	 * Default structural unit property String.
     	 */
-...
     	// End of command preferences shared strings
     	/**
     	 * Preferences node qualifier of the instance.
     	 * Preferences node qualifier of the instance.
     	 */
     	protected String commandPreferencesNodeQualifier;
     	/**
     	 * TXMPreferences instances map
     	 * TXMPreferences instances map
     	 */
     	protected static Map<Class<? extends TXMPreferences>, TXMPreferences> instances = new HashMap<>();
     	@Override
     	/**
     	 * Sub classes should not forget to call this to set TXMResults main behavior (visible, etc...)
     	 */
     	public void initializeDefaultPreferences() {
     		Preferences preferences = this.getDefaultPreferencesNode();
     		preferences.putBoolean(TBXPreferences.VISIBLE, true);
     		preferences.putBoolean(TBXPreferences.LOCK, false);
     		preferences.put(TBXPreferences.CORPUS_VERSION, "0.8.0");
+    	}
     	/**
+    	 *
     	 */
-...
     		super();
     		TXMPreferences.instances.put(this.getClass(), this);
     		this.commandPreferencesNodeQualifier = FrameworkUtil.getBundle(this.getClass()).getSymbolicName();
     		Log.finest("TXMPreferences.TXMPreferences(): initializing preferences for node = " + this.commandPreferencesNodeQualifier + " (" + this.getClass() +")");
     		Log.finest("TXMPreferences.TXMPreferences(): initializing preferences for node = " + this.commandPreferencesNodeQualifier + " (" + this.getClass() + ")");
+    	}
     	/**
+    	 *
     	 * @param key
     	 * @return
     	 */
     	public double getDouble(String key)	{
     	public double getDouble(String key) {
     		return getDouble(key, this.commandPreferencesNodeQualifier);
+    	}
     	/**
+    	 *
     	 * @param key
     	 * @return
     	 */
     	public boolean getBoolean(String key)	{
     	public boolean getBoolean(String key) {
     		return getBoolean(key, this.commandPreferencesNodeQualifier);
+    	}
     	/**
+    	 *
     	 * @param key
     	 * @return
     	 */
     	public int getInt(String key)	{
     	public int getInt(String key) {
     		return getInt(key, this.commandPreferencesNodeQualifier);
+    	}
     	/**
+    	 *
     	 * @param key
     	 * @return
     	 */
     	public long getLong(String key)	{
     	public long getLong(String key) {
     		return getLong(key, this.commandPreferencesNodeQualifier);
+    	}
-...
     	 * @param key
     	 * @return
     	 */
     	public String getString(String key)	{
     	public String getString(String key) {
     		return getString(key, this.commandPreferencesNodeQualifier);
+    	}
     	/**
+    	 *
     	 * @param key
     	 * @return
     	 */
     	public float getFloat(String key)	{
     	public float getFloat(String key) {
     		return getFloat(key, this.commandPreferencesNodeQualifier);
+    	}
     	/**
     	 * Gets the preferences node qualifier of the instance.
+    	 *
     	 * @return the preferencesNode
     	 */
     	public String getPreferencesNodeQualifier() {
     		return commandPreferencesNodeQualifier;
+    	}
     //	/**
     //	 * Stores a pairs of key / value in a local node dedicated to the specified result. The node qualifier is generated by the <code>Object.toString()</code> method.
     //	 *
     //	 * @param key
     //	 * @param pValue
     //	 */
     //	public static void remove(String key, String node)	{
     //		scope.getNode(node).remove(key);
     //	}
     	// /**
     	// * Stores a pairs of key / value in a local node dedicated to the specified result. The node qualifier is generated by the <code>Object.toString()</code> method.
     	// *
     	// * @param key
     	// * @param pValue
     	// */
     	// public static void remove(String key, String node) {
     	// scope.getNode(node).remove(key);
     	// }
     	/**
     	 * Saves all preferences and session results in the default app directory.
     	 */
     	public static void saveAll() {
     		Log.fine("Saving preferences and session results...");
     		try {
     			preferencesRootNode.flush();
     		} catch(Exception e) {
+    		}
     		catch (Exception e) {
     			Log.severe("Error while saving preferences and session results.");
     			e.printStackTrace();
+    		}
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in the specified parameters and preference nodes.
     	 * Returns the value of a key in the specified parameters if exists.
-...
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns <code>false</code> if no value has been found for the specified key.
+    	 *
     	 * @param commandParameters
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static Serializable getSerializable(String key, TXMParameters commandParameters, TXMResult result, String nodePath)	{
     		if(commandParameters != null && commandParameters.get(key) != null)	{
     	public static Serializable getSerializable(String key, TXMParameters commandParameters, TXMResult result, String nodePath) {
     		if (commandParameters != null && commandParameters.get(key) != null) {
     			return (Serializable) commandParameters.get(key);
+    		}
     		return getSerializable(key, result, nodePath);
+    	}
     	public static Serializable getSerializable(String key, TXMParameters commandParameters, TXMResult result)	{
     	public static Serializable getSerializable(String key, TXMParameters commandParameters, TXMResult result) {
     		return getSerializable(key, commandParameters, result, result.getCommandPreferencesNodePath());
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns defaultValue if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static Serializable getSerializable(String key, TXMResult result, String nodePath, Serializable defaultValue)	{
     	public static Serializable getSerializable(String key, TXMResult result, String nodePath, Serializable defaultValue) {
     		nodePath = findNodePath(nodePath, result, key);
     		String data_default = DefaultScope.INSTANCE.getNode(nodePath).get(key, "");
     		if (data_default.length() == 0) {
     			return null;
+    		}
     		try {
     			defaultValue = fromString(data_default);
     		} catch (Exception e) {
+    		}
     		catch (Exception e) {
     			Log.printStackTrace(e);
+    		}
     		String data_return = preferencesRootNode.node(nodePath).get(key, "");
     		if (data_return.length() == 0) {
     			return defaultValue;
+    		}
     		try {
     			return fromString(data_return);
     		} catch (Exception e) {
+    		}
     		catch (Exception e) {
     			Log.printStackTrace(e);
+    		}
     		return null;
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns <code>false</code> if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static Serializable getSerializable(String key, TXMResult result, String nodePath)	{
     	public static Serializable getSerializable(String key, TXMResult result, String nodePath) {
     		return getSerializable(key, result, nodePath, false);
+    	}
     	/**
+    	 *
     	 * @param nodePath
     	 * @param key
     	 * @return
     	 */
     	public static Serializable getSerializable(String key, String nodePath)	{
     	public static Serializable getSerializable(String key, String nodePath) {
     		return getSerializable(key, null, nodePath);
+    	}
     	/**
+    	 *
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static Serializable getSerializable(String key, TXMResult result)	{
     	public static Serializable getSerializable(String key, TXMResult result) {
     		return getSerializable(key, result, null);
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in the specified parameters and preference nodes.
     	 * Returns the value of a key in the specified parameters if exists.
-...
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns <code>false</code> if no value has been found for the specified key.
+    	 *
     	 * @param commandParameters
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static boolean getBoolean(String key, TXMParameters commandParameters, TXMResult result, String nodePath)	{
     		if(commandParameters != null && commandParameters.get(key) != null)	{
     	public static boolean getBoolean(String key, TXMParameters commandParameters, TXMResult result, String nodePath) {
     		if (commandParameters != null && commandParameters.get(key) != null) {
     			return (Boolean) commandParameters.get(key);
+    		}
     		return getBoolean(key, result, nodePath);
+    	}
     	public static boolean getBoolean(String key, TXMParameters commandParameters, TXMResult result)	{
     	public static boolean getBoolean(String key, TXMParameters commandParameters, TXMResult result) {
     		return getBoolean(key, commandParameters, result, result.getCommandPreferencesNodePath());
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns defaultValue if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static boolean getBoolean(String key, TXMResult result, String nodePath, boolean defaultValue)	{
     	public static boolean getBoolean(String key, TXMResult result, String nodePath, boolean defaultValue) {
     		nodePath = findNodePath(nodePath, result, key);
     		defaultValue = DefaultScope.INSTANCE.getNode(nodePath).getBoolean(key, defaultValue);
     		return preferencesRootNode.node(nodePath).getBoolean(key, defaultValue);
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns <code>false</code> if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static boolean getBoolean(String key, TXMResult result, String nodePath)	{
     	public static boolean getBoolean(String key, TXMResult result, String nodePath) {
     		return getBoolean(key, result, nodePath, false);
+    	}
     	/**
+    	 *
     	 * @param nodePath
     	 * @param key
     	 * @return
     	 */
     	public static boolean getBoolean(String key, String nodePath)	{
     	public static boolean getBoolean(String key, String nodePath) {
     		return getBoolean(key, null, nodePath);
+    	}
     	/**
+    	 *
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static boolean getBoolean(String key, TXMResult result)	{
     	public static boolean getBoolean(String key, TXMResult result) {
     		return getBoolean(key, result, null);
+    	}
     	/**
     	 * Try to cast and create a typed object from the String value of the key.
+    	 *
     	 * @param commandParameters
     	 * @param result
     	 * @param nodePath
     	 * @param key
     	 * @return
     	 */
     	//FIXME: does not work, need to test furthermore
     	//	public static Object get(TXMResultParameters commandParameters, TXMResult result, String nodePath, String key)	{
     	// FIXME: does not work, need to test furthermore
     	// public static Object get(TXMResultParameters commandParameters, TXMResult result, String nodePath, String key) {
     	//
     	//
     	//		if(commandParameters != null && commandParameters.get(key) != null)	{
     	//			return commandParameters.get(key);
     	//		}
     	// if(commandParameters != null && commandParameters.get(key) != null) {
     	// return commandParameters.get(key);
     	// }
     	//
     	//		nodePath = findNodeQualifier(nodePath, result, key);
     	// nodePath = findNodeQualifier(nodePath, result, key);
     	//
     	//		String stringValue = getString(nodePath, key);
     	// String stringValue = getString(nodePath, key);
     	//
     	//		try {
     	//			// double
     	//			try {
     	//				return Double.parseDouble(stringValue);
     	//			}
     	//			catch(NumberFormatException e) {
     	//			}
     	//			// float
     	//			try {
     	//				return Float.parseFloat(stringValue);
     	//			}
     	//			catch(NumberFormatException e) {
     	//			}
     	//			// long
     	//			try {
     	//				return Long.parseLong(stringValue);
     	//			}
     	//			catch(NumberFormatException e) {
     	//			}
     	//			// integer
     	//			try {
     	//				return Integer.parseInt(stringValue);
     	//			}
     	//			catch(NumberFormatException e) {
     	//			}
     	//			// short
     	//			try {
     	//				return Short.parseShort(stringValue);
     	//			}
     	//			catch(NumberFormatException e) {
     	//			}
     	//			// boolean
     	//			try {
     	//				return Boolean.parseBoolean(stringValue);
     	//			}
     	//			catch(NumberFormatException e) {
     	//			}
     	//		}
     	//		catch(Exception e) {
     	//			// TODO Auto-generated catch block
     	//			e.printStackTrace();
     	//			System.err.println("TXMPreferences.get(): can't parse and primitive cast the specified string value: " + stringValue + "."); //$NON-NLS-1$
     	//		}
     	//		return stringValue;
     	//	}
     //	/**
     //	 * Looks for the value of the specified <code>key</code> in the specified parameters and preference nodes.
     //	 * Returns the value of a key in the specified parameters if exists.
     //	 * Otherwise try to get it from the local result node if exists.
     //	 * Otherwise try to get it from the specified node qualifier if exists.
     //	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     //	 * Returns an empty <code>String</code> if no value has been found for the specified key.
     //	 * @param commandParameters
     //	 * @param nodePath
     //	 * @param result
     //	 * @param key
     //	 * @return
     //	 */
     //	public static String getString(String key, TXMParameters commandParameters, TXMResult result, String nodePath)	{
     //		if(commandParameters != null && commandParameters.get(key) != null)	{
     //			return (String) commandParameters.get(key);
     //		}
     //		return getString(key, result, nodePath);
     //	}
     //
     //	public static String getString(String key, TXMParameters commandParameters, TXMResult result)	{
     //		return getString(key, commandParameters, result, result.getCommandPreferencesNodePath());
     //	}
     	// try {
     	// // double
     	// try {
     	// return Double.parseDouble(stringValue);
     	// }
     	// catch(NumberFormatException e) {
     	// }
     	// // float
     	// try {
     	// return Float.parseFloat(stringValue);
     	// }
     	// catch(NumberFormatException e) {
     	// }
     	// // long
     	// try {
     	// return Long.parseLong(stringValue);
     	// }
     	// catch(NumberFormatException e) {
     	// }
     	// // integer
     	// try {
     	// return Integer.parseInt(stringValue);
     	// }
     	// catch(NumberFormatException e) {
     	// }
     	// // short
     	// try {
     	// return Short.parseShort(stringValue);
     	// }
     	// catch(NumberFormatException e) {
     	// }
     	// // boolean
     	// try {
     	// return Boolean.parseBoolean(stringValue);
     	// }
     	// catch(NumberFormatException e) {
     	// }
     	// }
     	// catch(Exception e) {
     	// // TODO Auto-generated catch block
     	// e.printStackTrace();
     	// System.err.println("TXMPreferences.get(): can't parse and primitive cast the specified string value: " + stringValue + "."); //$NON-NLS-1$
     	// }
     	// return stringValue;
     	// }
     	// /**
     	// * Looks for the value of the specified <code>key</code> in the specified parameters and preference nodes.
     	// * Returns the value of a key in the specified parameters if exists.
     	// * Otherwise try to get it from the local result node if exists.
     	// * Otherwise try to get it from the specified node qualifier if exists.
     	// * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	// * Returns an empty <code>String</code> if no value has been found for the specified key.
     	// * @param commandParameters
     	// * @param nodePath
     	// * @param result
     	// * @param key
     	// * @return
     	// */
     	// public static String getString(String key, TXMParameters commandParameters, TXMResult result, String nodePath) {
     	// if(commandParameters != null && commandParameters.get(key) != null) {
     	// return (String) commandParameters.get(key);
     	// }
     	// return getString(key, result, nodePath);
     	// }
     	//
     	// public static String getString(String key, TXMParameters commandParameters, TXMResult result) {
     	// return getString(key, commandParameters, result, result.getCommandPreferencesNodePath());
     	// }
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns defaultValue if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static String getString(String key, TXMResult result, String nodePath, String defaultValue) {
     		nodePath = findNodePath(nodePath, result, key);
     		//System.out.println("--- TXMPreferences.getString() node path = " + nodePath);
     		//FIXME defaultValue is always replaced even if set
     		// System.out.println("--- TXMPreferences.getString() node path = " + nodePath);
     		// FIXME defaultValue is always replaced even if set
     		defaultValue = DefaultScope.INSTANCE.getNode(nodePath).get(key, defaultValue);
     		return preferencesRootNode.node(nodePath).get(key, defaultValue);
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns defaultValue if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static Date getDate(String key, TXMResult result, String nodePath, Date defaultValue) {
     		nodePath = findNodePath(nodePath, result, key);
     		//System.out.println("--- TXMPreferences.getString() node path = " + nodePath);
     		// System.out.println("--- TXMPreferences.getString() node path = " + nodePath);
     		Date v = null;
     		try {
     			v = TXMResult.ID_TIME_FORMAT.parse(DefaultScope.INSTANCE.getNode(nodePath).get(key, null));
     		} catch (Exception e) { }
+    		}
     		catch (Exception e) {
+    		}
     		if (v != null) {
     			defaultValue = v;
+    		}
     		v = null;
     		try {
     			v = TXMResult.ID_TIME_FORMAT.parse(preferencesRootNode.node(nodePath).get(key, null));
     		} catch (Exception e) { }
+    		}
     		catch (Exception e) {
+    		}
     		if (v != null) {
     			return defaultValue;
     		} else {
+    		}
     		else {
     			return v;
+    		}
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns an empty <code>String</code> if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static String getString(String key, TXMResult result, String nodePath)	{
     	public static String getString(String key, TXMResult result, String nodePath) {
     		return getString(key, result, nodePath, ""); //$NON-NLS-1$
+    	}
-...
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns a 0 time <code>Date</code> if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static Date getDate(String key, TXMResult result, String nodePath)	{
     		return getDate(key, result, nodePath, new Date(0)); //$NON-NLS-1$
     	public static Date getDate(String key, TXMResult result, String nodePath) {
     		return getDate(key, result, nodePath, new Date(0)); // $NON-NLS-1$
+    	}
     	/**
+    	 *
     	 * @param nodePath
     	 * @param key
     	 * @return
     	 */
     	public static String getString(String key, String nodePath)	{
     	public static String getString(String key, String nodePath) {
     		return getString(key, null, nodePath);
+    	}
     	/**
+    	 *
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static String getString(String key, TXMResult result)	{
     	public static String getString(String key, TXMResult result) {
     		return getString(key, result, null);
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in the specified parameters and preference nodes.
     	 * Returns the value of a key in the specified parameters if exists.
-...
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns 0 if no value has been found for the specified key.
+    	 *
     	 * @param commandParameters
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static int getInt(String key, TXMParameters commandParameters, TXMResult result, String nodePath)	{
     		if(commandParameters != null && commandParameters.get(key) != null)	{
     	public static int getInt(String key, TXMParameters commandParameters, TXMResult result, String nodePath) {
     		if (commandParameters != null && commandParameters.get(key) != null) {
     			return (Integer) commandParameters.get(key);
+    		}
     		return getInt(key, result, nodePath);
+    	}
     	public static int getInt(String key, TXMParameters commandParameters, TXMResult result)	{
     	public static int getInt(String key, TXMParameters commandParameters, TXMResult result) {
     		return getInt(key, commandParameters, result, result.getCommandPreferencesNodePath());
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns defaultValue if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static int getInt(String key, TXMResult result, String nodePath)	{
     	public static int getInt(String key, TXMResult result, String nodePath) {
     		nodePath = findNodePath(nodePath, result, key);
     		int defaultValue = DefaultScope.INSTANCE.getNode(nodePath).getInt(key, 0);
     		return preferencesRootNode.node(nodePath).getInt(key, defaultValue);
+    	}
     	/**
+    	 *
     	 * @param nodePath
     	 * @param key
     	 * @return
     	 */
     	public static int getInt(String key, String nodePath)	{
     	public static int getInt(String key, String nodePath) {
     		return getInt(key, null, nodePath);
+    	}
     	/**
+    	 *
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static int getInt(String key, TXMResult result)	{
     	public static int getInt(String key, TXMResult result) {
     		return getInt(key, result, null);
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in the specified parameters and preference nodes.
     	 * Returns the value of a key in the specified parameters if exists.
-...
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns 0L if no value has been found for the specified key.
+    	 *
     	 * @param commandParameters
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static long getLong(String key, TXMParameters commandParameters, TXMResult result, String nodePath)	{
     		if(commandParameters != null && commandParameters.get(key) != null)	{
     	public static long getLong(String key, TXMParameters commandParameters, TXMResult result, String nodePath) {
     		if (commandParameters != null && commandParameters.get(key) != null) {
     			return (Long) commandParameters.get(key);
+    		}
     		return getLong(key, result, nodePath);
+    	}
     	public static long getLong(String key, TXMParameters commandParameters, TXMResult result)	{
     	public static long getLong(String key, TXMParameters commandParameters, TXMResult result) {
     		return getLong(key, commandParameters, result, result.getCommandPreferencesNodePath());
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns defaultValue if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @param defaultValue
     	 * @return
     	 */
     	public static long getLong(String key, TXMResult result, String nodePath, long defaultValue)	{
     	public static long getLong(String key, TXMResult result, String nodePath, long defaultValue) {
     		nodePath = findNodePath(nodePath, result, key);
     		defaultValue = DefaultScope.INSTANCE.getNode(nodePath).getLong(key, defaultValue);
     		return preferencesRootNode.node(nodePath).getLong(key, defaultValue);
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns 0L if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @param defaultValue
     	 * @return
     	 */
     	public static long getLong(String key, TXMResult result, String nodePath)	{
     	public static long getLong(String key, TXMResult result, String nodePath) {
     		return getLong(key, result, nodePath, 0L);
+    	}
     	/**
+    	 *
     	 * @param nodePath
     	 * @param key
     	 * @return
     	 */
     	public static long getLong(String key, String nodePath)	{
     	public static long getLong(String key, String nodePath) {
     		return getLong(key, null, nodePath);
+    	}
     	/**
+    	 *
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static long getLong(String key, TXMResult result)	{
     	public static long getLong(String key, TXMResult result) {
     		return getLong(key, result, null);
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in the specified parameters and preference nodes.
     	 * Returns the value of a key in the specified parameters if exists.
-...
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns 0.0d if no value has been found for the specified key.
+    	 *
     	 * @param commandParameters
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static double getDouble(String key, TXMParameters commandParameters, TXMResult result, String nodePath)	{
     		if(commandParameters != null && commandParameters.get(key) != null)	{
     	public static double getDouble(String key, TXMParameters commandParameters, TXMResult result, String nodePath) {
     		if (commandParameters != null && commandParameters.get(key) != null) {
     			return (Double) commandParameters.get(key);
+    		}
     		return getDouble(key, result, nodePath);
+    	}
     	public static double getDouble(String key, TXMParameters commandParameters, TXMResult result)	{
     	public static double getDouble(String key, TXMParameters commandParameters, TXMResult result) {
     		return getDouble(key, commandParameters, result, result.getCommandPreferencesNodePath());
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns defaultValue if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static double getDouble(String key, String nodePath, TXMResult result, double defaultValue)	{
     	public static double getDouble(String key, String nodePath, TXMResult result, double defaultValue) {
     		nodePath = findNodePath(nodePath, result, key);
     		defaultValue = DefaultScope.INSTANCE.getNode(nodePath).getDouble(key, defaultValue);
     		return preferencesRootNode.node(nodePath).getDouble(key, defaultValue);
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns 0.0d if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static double getDouble(String key, TXMResult result, String nodePath)	{
     	public static double getDouble(String key, TXMResult result, String nodePath) {
     		return getDouble(key, nodePath, result, 0.0d);
+    	}
     	/**
+    	 *
     	 * @param nodePath
     	 * @param key
     	 * @return
     	 */
     	public static double getDouble(String key, String nodePath)	{
     	public static double getDouble(String key, String nodePath) {
     		return getDouble(key, null, nodePath);
+    	}
     	/**
+    	 *
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static double getDouble(String key, TXMResult result)	{
     	public static double getDouble(String key, TXMResult result) {
     		return getDouble(key, result, null);
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in the specified parameters and preference nodes.
     	 * Returns the value of a key in the specified parameters if exists.
-...
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns 0f if no value has been found for the specified key.
+    	 *
     	 * @param commandParameters
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static float getFloat(String key, TXMParameters commandParameters, TXMResult result, String nodePath)	{
     		if(commandParameters != null && commandParameters.get(key) != null)	{
     	public static float getFloat(String key, TXMParameters commandParameters, TXMResult result, String nodePath) {
     		if (commandParameters != null && commandParameters.get(key) != null) {
     			return (Float) commandParameters.get(key);
+    		}
     		return getFloat(key, result, nodePath);
+    	}
     	public static float getFloat(String key, TXMParameters commandParameters, TXMResult result)	{
     	public static float getFloat(String key, TXMParameters commandParameters, TXMResult result) {
     		return getFloat(key, commandParameters, result, result.getCommandPreferencesNodePath());
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns defaultValue if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static float getFloat(String key, String nodePath, TXMResult result, float defaultValue)	{
     	public static float getFloat(String key, String nodePath, TXMResult result, float defaultValue) {
     		nodePath = findNodePath(nodePath, result, key);
     		defaultValue = DefaultScope.INSTANCE.getNode(nodePath).getFloat(key, defaultValue);
     		return preferencesRootNode.node(nodePath).getFloat(key, defaultValue);
+    	}
     	public static Serializable toSerializable(byte[] bytes) {
     		try {
     			ByteArrayInputStream breader = new ByteArrayInputStream(bytes);
     			ObjectInputStream reader = new ObjectInputStream(breader);
     			Object o = reader.readObject();
     			reader.close();
     			breader.close();
     			return (Serializable)o;
     		} catch (Exception e) {
     			return (Serializable) o;
+    		}
     		catch (Exception e) {
     			Log.severe("Error while loading bytes: " + e.getLocalizedMessage());
     			Log.printStackTrace(e);
+    		}
     		return null;
+    	}
     	public static Serializable getSerializable(String key, String nodePath, TXMResult result, Serializable defaultValue) {
     		try {
     			byte[] defaultBytes = toByteArray(defaultValue);
     			nodePath = findNodePath(nodePath, result, key);
     			defaultBytes = DefaultScope.INSTANCE.getNode(nodePath).getByteArray(key, defaultBytes);
     			byte[] bytes = preferencesRootNode.node(nodePath).getByteArray(key, defaultBytes);
     			return toSerializable(bytes);
     		} catch (Exception e) {
     			System.out.println("Error while reading "+key+" byte preference: "+e.getLocalizedMessage());
+    		}
     		catch (Exception e) {
     			System.out.println("Error while reading " + key + " byte preference: " + e.getLocalizedMessage());
     			Log.printStackTrace(e);
+    		}
     		return null;
+    	}
     	/**
     	 * Looks for the value of the specified <code>key</code> in preference nodes.
     	 * Returns the value of the local result node if exists.
     	 * Otherwise try to get it from the specified node qualifier if exists.
     	 * Otherwise try to get it from the specified alternative node qualifiers defined in the list <code>TXMPreferences.alternativeNodesQualifiers</code>.
     	 * Returns 0f if no value has been found for the specified key.
+    	 *
     	 * @param nodePath
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static float getFloat(String key, TXMResult result, String nodePath)	{
     	public static float getFloat(String key, TXMResult result, String nodePath) {
     		return getFloat(key, nodePath, result, 0f);
+    	}
     	/**
+    	 *
     	 * @param nodePath
     	 * @param key
     	 * @return
     	 */
     	public static float getFloat(String key, String nodePath)	{
     	public static float getFloat(String key, String nodePath) {
     		return getFloat(key, null, nodePath);
+    	}
     	/**
+    	 *
     	 * @param result
     	 * @param key
     	 * @return
     	 */
     	public static float getFloat(String key, TXMResult result)	{
     	public static float getFloat(String key, TXMResult result) {
     		return getFloat(key, result, null);
+    	}
     	/**
     	 * Checks if a local node exists for the specified TXM result.
+    	 *
     	 * @param result
     	 * @return <code>true</code> if the node exists, otherwise <code>false</code>
     	 */
     	public static boolean resultScopeNodeExists(TXMResult result)	{
     	public static boolean resultScopeNodeExists(TXMResult result) {
     		// FIXME: SJ: this code seems to create the node but it shouldn't
     		return preferencesRootNode.node(result.getParametersNodePath()) != null;
     		// Try this one instead
     //		try {
     //			return preferencesRootNode.nodeExists(result.getParametersNodePath());
     //		}
     //		catch (BackingStoreException e) {
     //			// TODO Auto-generated catch block
     //			e.printStackTrace();
     //		}
     //		return false;
     		// try {
     		// return preferencesRootNode.nodeExists(result.getParametersNodePath());
     		// }
     		// catch (BackingStoreException e) {
     		// // TODO Auto-generated catch block
     		// e.printStackTrace();
     		// }
     		// return false;
+    	}
     	/**
+    	 *
     	 * @param scope
-...
     	 * @param key
     	 * @return
     	 */
     	public static boolean keyExists(String nodePath, String key)	{
     	public static boolean keyExists(String nodePath, String key) {
     //		if (!nodePath.startsWith("/instance")) {
     //			nodePath = "/instance/" + nodePath;
     //		}
     		// if (!nodePath.startsWith("/instance")) {
     		// nodePath = "/instance/" + nodePath;
     		// }
     		if(preferencesRootNode.node(nodePath) != null)	{
     		if (preferencesRootNode.node(nodePath) != null) {
     			try {
     				return Arrays.asList(preferencesRootNode.node(nodePath).keys()).contains(key);
+    			}
     			catch(BackingStoreException e) {
     			catch (BackingStoreException e) {
     				e.printStackTrace();
+    			}
+    		}
     		return false;
+    	}
     	/**
     	 * Checks if a preference is defined as empty.
     	 * Can be used to determine whatever a functionality is available or not by overriding the preference as empty.
     	 * Essentially used for UI purpose, eg. to hide or disable a button that modify a preference.
+    	 *
     	 * @param nodePath
     	 * @param key
     	 * @return
     	 */
     	public static boolean isEmpty(String nodePath, String key)	{
     	public static boolean isEmpty(String nodePath, String key) {
     		return getString(key, nodePath).equals("");
+    	}
     	/**
     	 * Sets a preference as empty.
     	 * Can be used to determine whatever a functionality is available or not by overriding the preference as empty.
     	 * Essentially used for UI purpose, eg. to hide or disable a button that modify a preference.
+    	 *
     	 * @param nodePath
     	 * @param key
     	 */
     	public static void setEmpty(String nodePath, String key)	{
     	public static void setEmpty(String nodePath, String key) {
     		if (!nodePath.startsWith("/instance")) {
     			nodePath = "/instance/" + nodePath;
+    		}
     		preferencesRootNode.node(nodePath).put(key, "");
+    	}
     	/**
     	 * Gets the default preference node of the initializer instance.
+    	 *
     	 * @return
     	 */
     	public IEclipsePreferences getDefaultPreferencesNode()	{
     	public IEclipsePreferences getDefaultPreferencesNode() {
     		return DefaultScope.INSTANCE.getNode(this.commandPreferencesNodeQualifier);
+    	}
-...
     	public static String dumpToString(String nodePath) {
     		StringBuilder sb = new StringBuilder();
     		Preferences preferences = preferencesRootNode.node(nodePath);
     		try {
     			String[] keys = preferences.keys();
     			for(int i = 0; i < keys.length; i++) {
     				sb.append(keys[i] + " = " + preferences.get(keys[i], "")+"\t");
     			for (int i = 0; i < keys.length; i++) {
     				sb.append(keys[i] + " = " + preferences.get(keys[i], "") + "\t");
+    			}
+    		}
     		catch(BackingStoreException e) {
     		catch (BackingStoreException e) {
     			// TODO Auto-generated catch block
     			e.printStackTrace();
+    		}
-...
     				String[] subchildren = preferencesRootNode.node(children).childrenNames();
     				Arrays.sort(subchildren);
     				for (String children2 : subchildren) {
     					System.out.println(" scope: " + children + "  node: "+ children2); //$NON-NLS-1$
     					System.out.println(" scope: " + children + "  node: " + children2); //$NON-NLS-1$
     					String[] keys = preferencesRootNode.node(children).node(children2).keys();
     					Arrays.sort(keys);
     					for (String key2 : keys) {
-...
+    					}
+    				}
+    			}
     		} catch (Exception e) {
     			e.printStackTrace();;
+    		}
     		catch (Exception e) {
     			e.printStackTrace();
+    			;
+    		}
+    	}
     	/**
     	 * Dumps the keys and values of the specified node of the specified scope.
+    	 *
     	 * @param nodePath
     	 */
     	public static void dump(IScopeContext scope, String nodePath)	{
     	public static void dump(IScopeContext scope, String nodePath) {
     		IEclipsePreferences preferences = scope.getNode(nodePath);
     		System.out.println("TXMPreferences.dump(): ***************************************************************");
     		System.out.println("TXMPreferences.dump(): node qualifier = " + nodePath);
     		System.out.println("TXMPreferences.dump():" + preferences.absolutePath());
     		try {
     			String[] keys = preferences.keys();
     			for(int i = 0; i < keys.length; i++) {
     			for (int i = 0; i < keys.length; i++) {
     				System.out.println("TXMPreferences.dump(): " + keys[i] + " = " + preferences.get(keys[i], ""));
+    			}
+    		}
     		catch(BackingStoreException e) {
     		catch (BackingStoreException e) {
     			// TODO Auto-generated catch block
     			e.printStackTrace();
+    		}
+    	}

... This diff was truncated because it exceeds the maximum size that can be displayed.

Also available in: Unified diff

Laboratoire ICAR » Plateforme TXM

Revision 2383