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

Révision 446

     package org.txm.core.results;
     import java.util.ArrayList;
     import org.txm.core.results.ITXMResult;
     /**
+     *
      * @author sjacquot
+     *
      */
     //FIXME: this interface has been created to manage the result based on interface AND implementation, for example: interface LexicalTable.
     // need to see if it's useful or not.
     public interface ITXMResult {
     	/**
     	 * Deletes the object from its parent, also deletes the children.
     	 * The <code>TXMResult.clean()</code> methods of this result and children results are applied before the deletion.
     	 * @return
     	 */
     	public boolean delete();
     	/**
     	 * Adds a child result to this result.
     	 * @param child
     	 * @return
     	 */
     	public boolean addResult(ITXMResult child);
     	/**
     	 * Adds a child result to this result.
     	 * @param index
     	 * @param child
     	 * @return
     	 */
     	public boolean addResult(int index, ITXMResult child);
     	/**
     	 * Removes the specified child result.
     	 * @param child
     	 * @return <code>true if the child has been removed, otherwise <code>false</code>
     	 */
     	public boolean removeResult(ITXMResult child);
     	/**
     	 * Removes the child result specified by its index.
     	 * @param index
     	 * @return <code>true if the child has been removed, otherwise <code>false</code>
     	 */
     	public boolean removeResult(int index);
     	/**
     	 * Removes the result from its parent.
     	 * @return
     	 */
     	public boolean removeFromParent();
     	/**
     	 * Gets all the children results.
     	 * @return
     	 */
     	public ArrayList<ITXMResult> getResults();
     	/**
     	 * Gets the children results.
     	 * @return
     	 */
     	public ArrayList<ITXMResult> getResults(boolean onlyVisible);
     	/**
     	 * Checks if the result must be displayed.
     	 * @return
     	 */
     	public boolean isVisible();
     	/**
     	 * Sets the result visibility state.
     	 * @param visible
     	 * @return
     	 */
     	public void setVisible(boolean visible);
     	/**
     	 * Gets the children results specified by their class.
     	 * @param type
     	 * @return
     	 */
     	public ArrayList<ITXMResult> getResults(Class type);
     	/**
     	 * Gets the children results specified by their class.
     	 * @param type
     	 * @return
     	 */
     	public ArrayList<ITXMResult> getResults(Class type, boolean onlyVisible);
     	/**
     	 * Gets the children of all the branch in a flat list.
     	 * @return
     	 */
     	public ArrayList<ITXMResult> getDeepResults();
     	/**
     	 * Gets the sibling nodes of this node result.
     	 */
     	public ArrayList<ITXMResult> getSiblings();
     	/**
     	 * Gets the sibling nodes of this node result, specified by their class.
     	 */
     	public ArrayList<ITXMResult> getSiblings(Class type);
     	/**
     	 * Sets the parent.
     	 * @param parent
     	 */
     	public void setParent(ITXMResult parent);
     	/**
     	 * Gets the parent.
     	 * @return the parent
     	 */
     	public ITXMResult getParent();
     	/**
     	 * Gets the name of the result.
     	 * @return
     	 */
     	public abstract String getName();
     	/**
     	 * Gets the simple name of the result.
     	 * @return
     	 */
     	public abstract String getSimpleName();
     	/**
     	 * Gets some details about how the result has been computed (eg. additional parameters, etc.).
     	 * @return
     	 */
     	public abstract String getDetails();
     	/**
     	 * Gets a string representing the result and that can be used as a file name.
     	 * @return
     	 */
     	//FIXME: to discuss and/or to move in export layer
     	public String getValidFileName();
     	/**
     	 * Gets a string representing the concatenation of the simple names of the branch of this result.
     	 * @return
     	 */
     	public String getFullPathSimpleName();
     	/**
     	 * Gets the weight of the node. Essentially used for sorting purpose.
     	 * @return the weight
     	 */
     	public int getWeight();
     	/**
     	 * Cleans and free some resources if needed.
     	 * This methods is applied when calling <code>TXMResult.delete()</code>.
     	 */
     	public abstract void clean();
+    }

     package org.txm.core.results;
     import java.util.ArrayList;
     import java.util.UUID;
     import org.osgi.framework.FrameworkUtil;
     import org.txm.core.preferences.TXMPreferences;
     /**
      * Root class of all TXM results.
      * This class contains methods to get some different version of the name of the result and some additional computing information.
-...
+     *
      */
     //FIXME: At this moment, an empty list is created for children, to not return null when calling getChildren(), see if that's what we want
     public abstract class TXMResult implements ITXMResult, Cloneable {
     public abstract class TXMResult implements Cloneable {
     	/**
     	 * Unique ID of the object.
     	 */
     	protected String uniqueID;
     	/**
     	 * The weight, essentially used for sorting purpose.
     	 */
     	protected int weight;
-...
     	/**
     	 * Parent.
     	 */
     	protected ITXMResult parent;
     	protected TXMResult parent;
     	/**
     	 * Children results.
     	 */
     	protected ArrayList<ITXMResult> children;
     	protected ArrayList<TXMResult> children;
     	/**
     	 * The visibility state.
     	 */
     	protected boolean visible;
     	protected TXMParameters parameters;
     	/**
     	 * The command preferences node qualifier.
     	 */
     	protected String preferencesNodeQualifier;
     	/**
     	 * Creates a new TXMResult with no parent.
     	 */
     	public TXMResult() {
-...
     	 * Creates a new TXMResult, child of the specified parent.
     	 * @param parent
     	 */
     	public TXMResult(ITXMResult parent) {
     	public TXMResult(TXMResult parent) {
     		this(parent, null);
+    	}
     	/**
+    	 *
     	 * @param parent
     	 * @param parameters
     	 */
     	public TXMResult(TXMResult parent, TXMParameters parameters) {
     		// FIXME: discuss about this method and validate it. Also discuss about a getInternalName() method that should also return an unique ID.
     		this.uniqueID = this.getClass().getName() + '@' + Integer.toHexString(System.identityHashCode(this)) + "_" + UUID.randomUUID();
     		this.weight = 0;
     		this.visible = true;
     		if(parent != null)	{
     			parent.addResult(this);
+    		}
     		this.children = new ArrayList<ITXMResult>(1);
     		this.children = new ArrayList<TXMResult>(1);
     		this.preferencesNodeQualifier = FrameworkUtil.getBundle(getClass()).getSymbolicName();
     		this.parameters = parameters;
     		//FIXME: Debug
     		System.out.println("TXMResult.TXMResult(): default preferences node qualifier = " + this.preferencesNodeQualifier + ", class = " + getClass());
+    	}
     	/**
     	 * Gets the preferences node qualifier of the result command.
     	 * @return
     	 */
     	public String getPreferencesNodeQualifier() {
     		return preferencesNodeQualifier;
+    	}
     	/**
     	 * Gets the value of the specified key in parameters, local result node or default preferences nodes.
     	 * @param key
     	 * @return
     	 */
     	public int getIntParameterValue(String key)	{
     		return TXMPreferences.getInt(key, this.parameters, this, this.preferencesNodeQualifier);
+    	}
     	/**
     	 * Gets the value of the specified key in parameters, local result node or default preferences nodes.
     	 * @param key
     	 * @return
     	 */
     	public float getFloatParameterValue(String key)	{
     		return TXMPreferences.getFloat(key, this.parameters, this, this.preferencesNodeQualifier);
+    	}
     	@Override
     	/**
     	 * Gets the value of the specified key in parameters, local result node or default preferences nodes.
     	 * @param key
     	 * @return
     	 */
     	public double getDoubleParameterValue(String key)	{
     		return TXMPreferences.getDouble(key, this.parameters, this, this.preferencesNodeQualifier);
+    	}
     	/**
     	 * Gets the value of the specified key in parameters, local result node or default preferences nodes.
     	 * @param key
     	 * @return
     	 */
     	public boolean getBooleanParameterValue(String key)	{
     		return TXMPreferences.getBoolean(key, this.parameters, this, this.preferencesNodeQualifier);
+    	}
     	/**
     	 * Gets the value of the specified key in parameters, local result node or default preferences nodes.
     	 * @param key
     	 * @return
     	 */
     	public long getLongParameterValue(String key)	{
     		return TXMPreferences.getLong(key, this.parameters, this, this.preferencesNodeQualifier);
+    	}
     	/**
     	 * Gets the value of the specified key in parameters, local result node or default preferences nodes.
     	 * @param key
     	 * @return
     	 */
     	public String getStringParameterValue(String key)	{
     		return TXMPreferences.getString(key, this.parameters, this, this.preferencesNodeQualifier);
+    	}
     	/**
     	 * Deletes the object from its parent, also deletes the children.
     	 * The <code>TXMResult.clean()</code> methods of this result and children results are applied before the deletion.
     	 * @return
     	 */
     	synchronized public boolean delete()	{
     		try {
     			//FIXME: debug
     			//System.err.println("TXMResult.delete()");
     			// delete the local node
     			TXMPreferences.delete(this);
     			// remove children and clean resources
     			for(int i = 0; i < this.children.size(); i++) {
     				this.children.get(i).clean();
     				TXMPreferences.delete(this.children.get(i));
     				this.removeResult(i);
+    			}
-...
     			this.parent.removeResult(this);
     			this.parent = null;
     			return true;
+    		}
     		catch(NullPointerException e) {
     			// do nothing
+    		}
     		catch(Exception e) {
     			e.printStackTrace();
+    		}
     		return false;
+    	}
     	@Override
     	synchronized public boolean addResult(ITXMResult child)	{
     	/**
     	 * Adds a child result to this result.
     	 * @param child
     	 * @return
     	 */
     	synchronized public boolean addResult(TXMResult child)	{
     		try {
     			//remove from current parent if exists
     			child.removeFromParent();
-...
+    	}
     	@Override
     	synchronized public boolean addResult(int index, ITXMResult child)	{
     	/**
     	 * Adds a child result to this result.
     	 * @param index
     	 * @param child
     	 * @return
     	 */
     	synchronized public boolean addResult(int index, TXMResult child)	{
     		try {
     			if(!this.children.contains(child))	{
     				child.setParent(this);
-...
     		return false;
+    	}
     	@Override
     	synchronized public boolean removeResult(ITXMResult child)	{
     	/**
     	 * Removes the specified child result.
     	 * @param child
     	 * @return <code>true if the child has been removed, otherwise <code>false</code>
     	 */
     	synchronized public boolean removeResult(TXMResult child)	{
     		try {
     			child.setParent(null);
     			return this.children.remove(child);
-...
     		return false;
+    	}
     	@Override
     	/**
     	 * Removes the child result specified by its index.
     	 * @param index
     	 * @return <code>true if the child has been removed, otherwise <code>false</code>
     	 */
     	synchronized public boolean removeResult(int index)	{
     		try {
     			return this.removeResult(this.children.get(index));
-...
     		return false;
+    	}
     	@Override
     	/**
     	 * Removes the result from its parent.
     	 * @return
     	 */
     	synchronized public boolean removeFromParent()	{
     		try {
     			return this.parent.removeResult(this);
-...
     		return false;
+    	}
     	@Override
     	synchronized public ArrayList<ITXMResult> getResults()	{
     	/**
     	 * Gets all the children results.
     	 * @return
     	 */
     	synchronized public ArrayList<TXMResult> getResults()	{
     		return this.children;
+    	}
     	@Override
     	synchronized public ArrayList<ITXMResult> getResults(boolean onlyVisible)	{
     	/**
     	 * Gets the children results.
     	 * @return
     	 */
     	synchronized public ArrayList<TXMResult> getResults(boolean onlyVisible)	{
     		return this.getResults(null, onlyVisible);
+    	}
     	@Override
     	synchronized public ArrayList<ITXMResult> getResults(Class type)	{
     	/**
     	 * Gets the children results specified by their class.
     	 * @param type
     	 * @return
     	 */
     	synchronized public ArrayList<TXMResult> getResults(Class type)	{
     		return TXMResult.getNodes(this.children, type, false);
+    	}
     	@Override
     	synchronized public ArrayList<ITXMResult> getResults(Class type, boolean onlyVisible)	{
     	/**
     	 * Gets the children results specified by their class.
     	 * @param type
     	 * @return
     	 */
     	synchronized public ArrayList<TXMResult> getResults(Class type, boolean onlyVisible)	{
     		return TXMResult.getNodes(this.children, type, onlyVisible);
+    	}
-...
     	 * Gets the children of all the branch in a flat list.
     	 * @return
     	 */
     	synchronized protected ArrayList<ITXMResult> getDeepResults(ITXMResult parent, ArrayList<ITXMResult> results)	{
     	synchronized protected ArrayList<TXMResult> getDeepResults(TXMResult parent, ArrayList<TXMResult> results)	{
     		//FIXME: need to prove this method
     		System.err.println("TXMResult2.getDeepResults(ITXMResult parent, ArrayList<ITXMResult> results): NEED TO VALIDATE THIS METHOD");
     		System.err.println("TXMResult2.getDeepResults(TXMResult parent, ArrayList<TXMResult> results): NEED TO VALIDATE THIS METHOD");
     		for(int i = 0; i < parent.getResults().size(); i++) {
     			results.addAll(parent.getResults().get(i).getDeepResults());
+    		}
     		return results;
+    	}
     	@Override
     	synchronized public ArrayList<ITXMResult> getDeepResults()	{
     	/**
     	 * Gets the children of all the branch in a flat list.
     	 * @return
     	 */
     	synchronized public ArrayList<TXMResult> getDeepResults()	{
     		//FIXME: need to prove this method
     		System.err.println("TXMResult2.getDeepResults(): NEED TO VALIDATE THIS METHOD");
     		return this.getDeepResults(this, new ArrayList<ITXMResult>());
     		return this.getDeepResults(this, new ArrayList<TXMResult>());
+    	}
-...
     	 * @param type
     	 * @return
     	 */
     	public static ArrayList<ITXMResult> getNodes(ArrayList<ITXMResult> srcNodes, Class type, boolean onlyVisible)	{
     		ArrayList<ITXMResult> nodes = new ArrayList<ITXMResult>();
     	public static ArrayList<TXMResult> getNodes(ArrayList<TXMResult> srcNodes, Class type, boolean onlyVisible)	{
     		ArrayList<TXMResult> nodes = new ArrayList<TXMResult>();
     		for(int i = 0; i < srcNodes.size(); i++) {
     			if((type == null || srcNodes.get(i).getClass().equals(type)) && (onlyVisible == false || srcNodes.get(i).isVisible()))	{
     				nodes.add(srcNodes.get(i));
-...
     	@Override
     	synchronized public ArrayList<ITXMResult> getSiblings()	{
     		ArrayList<ITXMResult> sibling = new ArrayList<ITXMResult>();
     	/**
     	 * Gets the sibling nodes of this node result.
     	 */
     	synchronized public ArrayList<TXMResult> getSiblings()	{
     		ArrayList<TXMResult> sibling = new ArrayList<TXMResult>();
     		if(this.parent != null)	{
     			sibling.addAll(this.parent.getResults());
     			sibling.remove(this);
-...
     	/**
     	 * Gets the sibling nodes of this node result, specified by their class.
     	 */
     	synchronized public ArrayList<ITXMResult> getSiblings(Class type)	{
     		ArrayList<ITXMResult> sibling = new ArrayList<ITXMResult>();
     	synchronized public ArrayList<TXMResult> getSiblings(Class type)	{
     		ArrayList<TXMResult> sibling = new ArrayList<TXMResult>();
     		if(this.parent != null)	{
     			sibling.addAll(TXMResult.getNodes(this.parent.getResults(), type, true));
     			sibling.remove(this);
-...
+    	}
     	@Override
     	/**
     	 * Checks if the result must be displayed.
     	 * @return
     	 */
     	public boolean isVisible()	{
     		return this.visible;
+    	}
     	@Override
     	/**
     	 * Sets the result visibility state.
     	 * @param visible
     	 * @return
     	 */
     	public void setVisible(boolean visible)	{
     		this.visible = visible;
+    	}
     	@Override
     	public void setParent(ITXMResult parent)	{
     	/**
     	 * Sets the parent.
     	 * @param parent
     	 */
     	public void setParent(TXMResult parent)	{
     		this.parent = parent;
+    	}
     	@Override
     	public ITXMResult getParent() {
     	/**
     	 * Gets the parent.
     	 * @return the parent
     	 */
     	public TXMResult getParent() {
     		return parent;
+    	}
     	@Override
     	/**
     	 * Gets the name of the result.
     	 * @return
     	 */
     	public abstract String getName();
     	@Override
     	/**
     	 * Gets the simple name of the result.
     	 * @return
     	 */
     	public abstract String getSimpleName();
     	@Override
     	/**
     	 * Gets some details about how the result has been computed (eg. additional parameters, etc.).
     	 * @return
     	 */
     	public abstract String getDetails();
     	/**
     	 * Returns a string representation of a unique ID of the result.
     	 * @return
     	 */
     	public String getUUID()	{
     		return this.uniqueID;
+    	}
     	/**
     	 * Gets a string representing the result and that can be used as a file name.
     	 * @return
     	 */
     	//FIXME: to discuss and/or to move in export layer
     	@Override
     	public String getValidFileName()	{
     		try {
     			return this.getName().replaceAll("[^a-zA-Z0-9\\._-]+", "_");
-...
     		return "";
+    	}
     	@Override
     	/**
     	 * Gets a string representing the concatenation of the simple names of the branch of this result.
     	 * @return
     	 */
     	synchronized public String getFullPathSimpleName()	{
     		// fill the branch
     		ArrayList<ITXMResult> branch = new ArrayList<ITXMResult>();
     		ITXMResult node = this;
     		ArrayList<TXMResult> branch = new ArrayList<TXMResult>();
     		TXMResult node = this;
     		do	{
     			branch.add(node);
     			node = node.getParent();
-...
     //	}
     	@Override
     	/**
     	 * Gets the weight of the node. Essentially used for sorting purpose.
     	 * @return the weight
     	 */
     	public int getWeight() {
     		return weight;
+    	}
     	@Override
     	public abstract void clean();
     	/**
+    	 *
     	 * @param step
     	 * Cleans and free some resources if needed.
     	 * This methods is applied when calling <code>TXMResult.delete()</code>.
     	 */
     	//FIXME: proposals to computing
     	//public abstract void compute(int step);
     	//FIXME: proposals to computing
     //	public boolean compute(int start, int end)	{
     //		for(int i = start; i <= end; i++) {
     //			if(Thread.interrupted())	{
     //				this.clean();
     //				return false;
     //			}
     //			this.compute(i);
     //		}
     //		return true;
     //	}
     	public abstract void clean();
     	@Override
     	public Object clone() {
     	    TXMResult clone = null;
-...
+    		}
     	    return clone;
+    	}
     	/**
     	 * @param parameters the parameters to set
     	 */
     	public void setParameters(TXMParameters parameters) {
     		this.parameters = parameters;
+    	}
+    }

     /**
+     *
      */
     package org.txm.core.results;
     import java.util.HashMap;
     import java.util.Iterator;
     import java.util.Map;
     import java.util.Set;
     /**
      * Wrapper for semantic purpose.
      * @author sjacquot
+     *
      */
     //FIXME: inherit from Properties may be better.
     public class TXMParameters extends HashMap<String, Object> {
     	/**
+    	 *
     	 */
     	public TXMParameters() {
     		// TODO Auto-generated constructor stub
+    	}
     	/**
     	 * @param arg0
     	 */
     	public TXMParameters(int arg0) {
     		super(arg0);
     		// TODO Auto-generated constructor stub
+    	}
     	/**
     	 * @param arg0
     	 */
     	public TXMParameters(Map<? extends String, ? extends Object> arg0) {
     		super(arg0);
     		// TODO Auto-generated constructor stub
+    	}
     	/**
     	 * @param arg0
     	 * @param arg1
     	 */
     	public TXMParameters(int arg0, float arg1) {
     		super(arg0, arg1);
+    	}
     	//FIXME: use super.toString()?
     	public void dump()	{
     		Set keys = this.keySet();
     		Iterator it = keys.iterator();
     		while (it.hasNext()){
     		   Object key = it.next();
     		   Object value = this.get(key);
     		   System.out.println("TXMCommandParameters.dump(): key = " + key + " / value = " + value);
+    		}
+    	}
+    }

Formats disponibles : Unified diff

Laboratoire ICAR » Plateforme TXM

Révision 446