Laboratoire ICAR » Plateforme TXM

	 * @throws CqiClientException

	 *             the cqi client exception

	 */

	public void drop() throws CqiClientException {

		try {

		int n = this.getNMatch();

		if (n > 0) {

			return getEnds(0, n - 1);

			return new int[0];

		}

	}

	 * @throws CqiClientException

	 *             the cqi client exception

	 */

	public List<Match> getMatches() throws CqiClientException {

		int n = this.getNMatch();

		if (n > 0) {

			return getMatches(0, n - 1);

		}

	}

	 * @return

	 * @throws CqiClientException

	 */

	public List<Match> getMatches(int from, int to) throws CqiClientException {

		int[] starts, ends, targets;

		try {

			starts = getStarts(from, to);

			ends = getEnds(from, to);

			targets = getTargets(from, to);

			throw new CqiClientException(e);

		}

		for (int i = 0; i <= to - from; i++) {

	 * @throws CqiClientException

	 *             the cqi client exception

	 */

	public int getNMatch() throws CqiClientException {

		// if (nMatch == -1) //

		try {

			nMatch = CorpusManager.getCorpusManager().getCqiClient().subCorpusSize(getQualifiedCqpId());

			return 0;

		}

		return nMatch;

	 * 

	 * @return the query

	 */

	public CQLQuery getQuery() {

		return query;

			return CorpusManager.getCorpusManager().getCqiClient()

					.dumpSubCorpus(getQualifiedCqpId(),

							NetCqiClient.CQI_CONST_FIELD_MATCH, from, to);

			throw new CqiClientException(e);

		}

	}

		int n = this.getNMatch();

		if (n > 0) {

			return getStarts(0, n - 1);

			return new int[0];

		}

	}

		return CorpusManager.getCorpusManager().getCqiClient().dumpSubCorpus(getQualifiedCqpId(), NetCqiClient.CQI_CONST_FIELD_MATCH, from, to);

	}

	public String toString() {

		return this.getQualifiedCqpId();

 * @author sloiseau

 */

public class QueryPart extends CQLQuery {

	/** The structure. */

	protected StructuralUnit structure;

	/** The property. */

	protected StructuralUnitProperty property;

	/** The value. */

	protected String value;

	/**

	 * Instantiates a new query part.

	 * 

		this.property = property;

		this.value = value;

		if ("text".equals(structure.getName())) { // optimisation only for the text structure

		}

	}

	public StructuralUnit getStructure() {

		return structure;

	}

	public StructuralUnitProperty getProperty() {

		return property;

	}

	public String getValue() {

		return value;

	}

}

 * - isDirty(): return true if the result needs to be recomputed (if a parameter changed)

 * 

 * Groovy call sample :

 * <pre>

 * {@code

 * MyTXMResult result = new MyTXMResult(parent);

 * </pre>

 * 

 * @author mdecorde

 * @author sjacquot

 */

public abstract class TXMResult implements Cloneable, IProgressMonitor, Comparable<TXMResult> {

	public static final DateFormat ID_TIME_FORMAT = new SimpleDateFormat("yyyyMMdd_HHmmssSSS");

	public static final DateFormat PRETTY_TIME_FORMAT = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss");

	public static final DateFormat PRETTY_LOCALIZED_TIME_FORMAT = new SimpleDateFormat("dd MMMM yyyy, HH'h'mm", Locale.getDefault());

	public static final String UUID_PREFIX = "txm_res_"; //$NON-NLS-1$

	public static final Pattern FILE_NAME_PATTERN = Pattern.compile("[^a-zA-Z0-9\\.-_]+"); //$NON-NLS-1$

	public static final String UNDERSCORE = "_"; //$NON-NLS-1$

	/**

	 * Results counter to create unique ids.

	 */

	private static int next = 0;

	/**

	 * Editor can use this to test if the result has been computed once.

	 */

	protected boolean hasBeenComputedOnce = false;

	/**

	 * The weight, essentially used for sorting purpose.

	 */

	protected int weight;

	/**

	 * the command this command to true when the result needs to be recomputed.

	 * like after updating parameters

	 */

	protected boolean dirty = true;

	/**

	 * if a method changed the internal data without **recomputing** the result, the result must be marked "altered"

	 */

	protected boolean altered = false;

	/**

	 * The result parent. Should not be null except for roots TXMResult.

	 */

	protected TXMResult parent;

	/**

	 * Children results.

	 */

	protected List<TXMResult> children;

	/**

	 * Command preferences node path.

	 */

	protected String commandPreferencesNodePath;

	/**

	 * Parameters node path. Concatenation of the Project scope path + the result uuid

	 */

	protected String parametersNodePath;

	/**

	 * If set, allows the command to notify its progress.

	 */

	protected IProgressMonitor monitor;

	/**

	 * To manage the computing cancel with TreadDeath.

	 */

	private Semaphore progressSemaphore = new Semaphore(1);

	/**

	 * To keep track of the parameters used for the last computing and to determine if the result is dirty.

	 */

	/**

	 * Internal persistable state.

	 */

	protected boolean internalPersistable;

	/**

	 * User persistable state.

	 */

	protected boolean userPersistable;

	/**

	 * The visibility state.

	 */

	private Boolean visible;

	/**

	 * The user name (to rename a result).

	 */

	protected String userName;

	/**

	 * To store the simple name for unserialization and lazy loading.

	 * This string can be used, for example, to display some information in UI even if the result has not yet been recomputed.

	 */

	// TODO: we should do the same with getDetails() method

	private String lazyName;

	/**

	 * Last computing date.

	 */

	private Date lastComputingDate;

	/**

	 * Creation date.

	 */

	private Date creationDate;

	/**

	 * If locked, the result is not updated when computed.

	 */

	protected Boolean locked = false;

	/**

	 * Current computing state.

	 * True if the result is in the process of computing (is in compute(,) method)

	 * 

	 */

	protected boolean computing = false;

	/**

	 * Creates a new TXMResult, child of the specified parent.

	 * @param parent

	 */

	public TXMResult(TXMResult parent) {

		this(null, parent);

	}

	/**

	 * Creates a new TXMResult with no parent.

	 * @param uuid

	 */

	public TXMResult(String parametersNodePath) {

		this(parametersNodePath, null);

	}

	/**

	 * Creates a new TXMResult, child of the specified parent.

	 * If the parameters node path is null, a new path is generated from the project root path ending by a new generated UUID.

		if (parent != null) {

			parent.addChild(this);

		}

		// no parametersNodePath -> new result

			if (this.getProject() != null) {

				parametersNodePath = this.getProject().getParametersNodeRootPath();

			}

			else {

			}

		}

			this.parametersNodePath = parametersNodePath;

		}

		Log.finest("TXMResult.TXMResult(): parameters node path: " + this.parametersNodePath + "."); //$NON-NLS-1$ //$NON-NLS-2$

		this.weight = 0;

		Log.finest("TXMResult.TXMResult(): command preferences node path: " + this.commandPreferencesNodePath + "."); //$NON-NLS-1$ //$NON-NLS-2$

		this.visible = true;

		this.dirty = true;

		this.internalPersistable = false;

		this.userPersistable = TBXPreferences.getInstance().getBoolean(TBXPreferences.AUTO_PERSISTENCE_ENABLED);

		// retrieving parent from UUID

		String parentNodePath = this.getStringParameterValue(TXMPreferences.PARENT_PARAMETERS_NODE_PATH);

		if (!("ROOT".equals(this.parametersNodePath)) && // search for parent only if UUID != "ROOT"

				!parentNodePath.isEmpty()) {

			Log.finest("Searching parent with UUID " + parentNodePath + "..."); //$NON-NLS-1$ //$NON-NLS-2$

			TXMResult retrievedParent = TXMResult.getResult(parentNodePath);

			if (retrievedParent != null) {

				Log.finest("Parent retrieved from UUID: " + retrievedParent + "."); //$NON-NLS-1$ //$NON-NLS-2$

				try {

					TBXPreferences.delete(this);

				}

				}

				return;

			}

		}

		// loads parameters from local result node, current command preferences or default command preferences

		try {

			this.autoLoadParametersFromAnnotations(); // auto fill from Parameter annotations

			this.loadParameters(); // subclasses manual settings

			try {

				if (creationDate == null) {

					creationDate = Calendar.getInstance().getTime();

					this.saveParameter(TBXPreferences.CREATION_DATE, ID_TIME_FORMAT.format(creationDate));

				}

				// TODO Auto-generated catch block

				e.printStackTrace();

			}

			Log.severe("Fail to load " + parametersNodePath + "result: " + e); //$NON-NLS-1$ //$NON-NLS-2$

			Log.printStackTrace(e);

		}

		// Log

			Log.finest("Warning: the TXMResult of " + this.getClass() + " is attached to no parent. (uuid = " + this.parametersNodePath + ")"); //$NON-NLS-1$ //$NON-NLS-2$

		}

	}

	/**

	 * Sets the user name.

	 * @param name

	 */

	public void setUserName(String name) {

		this.userName = name;

	}

	/**

	 * @return true is the internal data has been modified

	 */

	public boolean isAltered() {

		return altered;

	}

	/**

	 * Mark the result as altered -> modifications are lost after a re-compute

	 */

	public void setAltered() {

		this.altered = true;

	}

	/**

	 * Do something when project is closed

	 */

	public void onProjectClose() {

	}

	/**

	 * Do something when project is opened

	 */

	public void onProjectOpen() {

	}

	/**

	 * Locks/unlocks the result.

	 */

	public void setLocked(boolean state) {

		this.locked = state;

		if (this.locked && this.parent != null) {

			this.parent.setLocked(true);

		}

			}

		}

	}

	/**

	 * @return true if the result is locked

	 */

	public boolean isLocked() {

		return this.locked;

	}

	/**

	 * Creates an UUID dedicated to persistence of this result.

	 * @return

	 */

	public static String createUUID() {

		// FIXME: see if it's useful to put the class name or not, should be better to save it in the .prefs

		return UUID_PREFIX + ID_TIME_FORMAT.format(new Date(System.currentTimeMillis())) + "_" + nextInt();

	}

	/**

	 * 

	 * @return the next integer in the current session of TXM

	private static synchronized String nextInt() {

		return String.format("%04d", next++); //$NON-NLS-1$

	}

	/**

	 * Checks if the result at least one child.

	 * @return

	 */

	public boolean hasChildren() {

		return this.children.size() > 0;

	}

	/**

	 * Gets the preferences node path of the result command.

	 * 

	public String getCommandPreferencesNodePath() {

		return this.commandPreferencesNodePath;

	}

	public String[] getCommandPreferencesKeys() throws BackingStoreException {

		return TXMPreferences.getCommandScopeKeys(this.commandPreferencesNodePath);

	}

	public String[] getDefaultPreferencesKeys() throws BackingStoreException {

		return TXMPreferences.getDefaultScopeKeys(this.commandPreferencesNodePath);

	}

	/**

	 * Gets a current parameter specified by its annotation "key".

	 * @param key

	 * @param parameterType

	 * @return

	public Object getParameter(String key) {

		return getParameter(key, false);

	}

	/**

	 * Gets a current parameter specified by its annotation "key".

	 * @param key

	 * @param propagateToParent if true ask the parents

	 * @param parameterType

	 */

	public Object getParameter(String key, boolean propagateToParent) {

		try {

				field.setAccessible(true);

				return this.parent.getParameter(key, propagateToParent);

			}

			e.printStackTrace();

		}

		return null;

	}

	/**

	 * Gets a member field according to its key.

	 * @param key

	 * @return the field if exists otherwise null

	 */

		List<Field> fields = this.getAllFields();

		for (Field f : fields) {

			Parameter parameter = f.getAnnotation(Parameter.class);

			if (parameter != null && parameter.key().equals(key)) {

				break;

			}

		}

		return field;

	}

	/**

	 * Returns all the member fields of the class instance (from all inherited classes).

	 * @return the list of declared fields

	 */

		Class<?> clazz = this.getClass();

		while (clazz != Object.class) {

			fields.addAll(Arrays.asList(clazz.getDeclaredFields()));

			clazz = clazz.getSuperclass();

		}

		return fields;

	}

	/**

	 * Stores the parameters of the specified type used for last computing.

	 * @param parameterType

	 * @param appendToLastParameters

	 * @throws Exception

	 */

	protected void updateLastParameters(int parameterType) throws Exception {

		HashMap<String, Object> lastParameters;

		lastParameters = new HashMap<>();

		List<Field> fields = this.getAllFields();

		for (Field f : fields) {

			Parameter parameter = f.getAnnotation(Parameter.class);

			if (parameter == null || parameter.type() != parameterType) {

				continue;

			}

			String name;

				name = parameter.key();

			}

				name = f.getName();

			}

			f.setAccessible(true);

			lastParameters.put(name, f.get(this));

		}

		this.parametersHistory.add(lastParameters);

		// truncate the stack to the max count

		// FIXME: SJ: later, store this in a TBX preference

			this.parametersHistory.remove(0);

			this.parametersHistory.remove(0);

			this.parametersHistory.remove(0);

		}

	}

	/**

	 * Stores the last parameters used for computing.

	 * @throws Exception

	 */

	protected void updateLastParameters() throws Exception {

		this.updateLastParameters(Parameter.COMPUTING);

	}

	/**

	 * Removes all the parameters of the specified type from the last parameters history.

	 * @param parameterType

	 * @throws Exception

	 */

	protected void clearLastParameters(int parameterType) {

		List<Field> fields = this.getAllFields();

		for (Field f : fields) {

			Parameter parameter = f.getAnnotation(Parameter.class);

			if (parameter == null || parameter.type() != parameterType) {

				continue;

			}

			String name;

				name = parameter.key();

			}

				name = f.getName();

			}

			f.setAccessible(true);

			try {

				this.getLastParametersFromHistory().remove(name);

				// nothing to do if the stack is empty

			}

		}

		try {

				this.parametersHistory.remove(this.parametersHistory.size() - 1);

			}

		}

			// nothing to do if the stack is empty

		}

	}

	/**

	 * Checks if a parameter value has changed since last computing.

	 * @param key

	 * @param parameterType

	 * @return

	public boolean hasParameterChanged(String key) {

		return this.hasParameterChanged(key, this.getLastParametersFromHistory());

	}

	/**

	 * Checks if a parameter value has changed since last computing according to the specified external map.

	 * @param key

	 * @param lastParameters

	 * @return

	 */

	public boolean hasParameterChanged(String key, HashMap<String, Object> lastParameters) {

			return true;

		}

		if (key.isEmpty()) {

			return false;

		}

		Object lastValue = lastParameters.get(key);

		Object newValue = this.getParameter(key);

		if (lastValue == null) {

				return true;

			}

				return false;

			}

		}

			return !lastValue.equals(newValue);

		}

	}

	/**

	 * Checks if at least one parameter value of the specified parameter type has changed since last computing according to the specified external map.

	 * @param lastParameters

	 * @param parameterType

	 * @return

	 */

	public boolean hasParameterChanged(HashMap<String, Object> lastParameters, int parameterType) throws Exception {

		// result has never been computed

			return true;

		}

		boolean hasParameterChanged = false;

		List<Field> fields = this.getAllFields();

		for (Field f : fields) {

			Parameter parameter = f.getAnnotation(Parameter.class);

			if (parameter == null || parameter.type() != parameterType) {

				continue;

			}

			String name;

				name = parameter.key();

			}

			else {

				name = f.getName();

			}

			f.setAccessible(true); // to be able to test the field values

			hasParameterChanged = this.hasParameterChanged(name, lastParameters);

			if (hasParameterChanged) {

				Log.finest("TXMResult.hasParameterChanged(): " + this.getClass().getSimpleName() + ": parameter " + name + " has changed.");

				break;

			}

		}

		return hasParameterChanged;

	}

	/**

	 * Checks if at least one computing parameter value has changed since last computing.

	 * @return

	 * @throws Exception

	 */

	public boolean hasParameterChanged() throws Exception {

		return this.hasParameterChanged(this.getLastParametersFromHistory(), Parameter.COMPUTING);

	}

	/**

	 * Dumps the command and default preferences of the result preferences node qualifier.

	 * @return

	 */

		StringBuilder str = new StringBuilder();

			str.append("\nResult local node preferences\n"); //$NON-NLS-1$

			str.append(TXMPreferences.getKeysAndValues(this.getParametersNodePath()));

		}

		str.append("\nCommand preferences\n"); //$NON-NLS-1$

		str.append(TXMPreferences.getKeysAndValues(this.commandPreferencesNodePath));

		str.append("\nDefault command preferences\n"); //$NON-NLS-1$

		str.append(TXMPreferences.getKeysAndValues(DefaultScope.INSTANCE + "/" + this.commandPreferencesNodePath));

		return str.toString();

	}

	/**

	 * Dumps the result computing parameters (Parameter annotation).

	 * @return

	 */

		return this.dumpParameters(Parameter.COMPUTING);

	}

	/**

	 * Dumps the result computing parameters (Parameter annotation).

	 * @param parametersType

	 * @return

	 */

		StringBuilder str = new StringBuilder();

		str.append("Parameters (type = " + parametersType + " / " + Parameter.types[parametersType] + ")\n"); //$NON-NLS-1$

		List<Field> fields = this.getAllFields();

		for (Field f : fields) {

			Parameter parameter = f.getAnnotation(Parameter.class);

			if (parameter == null || parameter.type() != parametersType) {

				continue;

			}

			f.setAccessible(true);

			String name;

				name = parameter.key();

			}

				name = f.getName();

			}

			try {

				Object v = f.get(this);

				if (v != null) {

				}

			}

			catch (IllegalArgumentException e) {

				// TODO Auto-generated catch block

		}

		return str.toString();

	}

	/**

	 * Sets the dirty state to true if a parameter has changed since last computing.

	 * 

	 * @throws Exception

	 */

	public void updateDirtyFromHistory() throws Exception {

		////

		////

		////

		////

		////

			this.dirty = true;

		}

	}

	/**

	 * Gets the list of parameters used during last computing or null if the result has not been computed yet.

	 * 

	 * @return

	 */

		try {

			return this.parametersHistory.get(this.parametersHistory.size() - 1);

		}

			return null;

		}

	}

	/**

	 * Gets the dirty state.

	 * 

	public boolean isDirty() {

		return this.dirty;

	}

	/**

	 * Marks the result as dirty so editors or others will know the TXMResult needs to be recomputed.

	 * This method is also recursively called on all the children branch to mark them as dirty.

	public void setDirty() {

		this.setDirty(true);

	}

	/**

	 * @param dirty

	 */

	public void setDirty(boolean dirty) {

		setDirty(dirty, true);

	}

	/**

	 * @param dirty

	 */

	public void setDirty(boolean dirty, boolean propagate) {

			}

		}

	}

	/**

	 * Gets the value of the specified key in parameters, local result node or

	 * default preferences nodes.

	public int getIntParameterValue(String key) {

		return TXMPreferences.getInt(key, this, this.commandPreferencesNodePath);

	}

	/**

	 * Gets the value of the specified key in parameters, local result node or

	 * default preferences nodes.

	public float getFloatParameterValue(String key) {

		return TXMPreferences.getFloat(key, this, this.commandPreferencesNodePath);

	}

	/**

	 * Gets the value of the specified key in parameters, local result node or

	 * default preferences nodes.

	public double getDoubleParameterValue(String key) {

		return TXMPreferences.getDouble(key, this, this.commandPreferencesNodePath);

	}

	/**

	 * Gets the value of the specified key in parameters, local result node or

	 * default preferences nodes.

	public boolean getBooleanParameterValue(String key) {

		return TXMPreferences.getBoolean(key, this, this.commandPreferencesNodePath);

	}

	/**

	 * Gets the value of the specified key in parameters, local result node or

	 * default preferences nodes.

	public long getLongParameterValue(String key) {

		return TXMPreferences.getLong(key, this, this.commandPreferencesNodePath);

	}

	/**

	 * Gets the value of the specified key in parameters, local result node or

	 * default preferences nodes.

	public String getStringParameterValue(String key) {

		return TXMPreferences.getString(key, this, this.commandPreferencesNodePath);

	}

	/**

	 * Gets the value of the specified key in parameters, local result node or

	 * default preferences nodes.

		String v = TXMPreferences.getString(key, this, this.commandPreferencesNodePath);

		if (v != null && v.length() > 0) {

			return new File(v);

			return null;

		}

	}

	/**

	 * Checks if the specified parameter exists.

	 * @param key

	 * @return

	 */

		return TXMPreferences.keyExists(this.parametersNodePath, key);

	}

	/**

	 * Checks if a preference is empty (equals to "") in the command preference node.

	 * An empty preference can be used to disable a functionality for a kind of result

	 * (eg. A partition dimension bar chart does not have a legend so it can be used to not offer the hide/show legend button in UI).

	 * @param key

	 * @return

	 */

		return TXMPreferences.isEmpty(this.commandPreferencesNodePath, key);

	}

	/**

	 * Stores the specified parameters pairs of key/value in a local node dedicated to the specified result. The node qualifier is generated by the <code>TXMResult.getUUID</code> method.

	 * 

	public void saveParameter(String key, List<?> values) {

		this.saveParameter(key, StringUtils.join(values, UNDERSCORE));

	}

	/**

	 * Stores the specified parameters pairs of key/value in a local node dedicated to the specified result. The node qualifier is generated by the <code>TXMResult.getUUID</code> method.

	 * @param result

	 * @param key

	 * @param value

	 */

		// FIXME: debug

		TXMPreferences.putLocal(this, key, value);

	}

	/**

	 * Stores the result parameter fields declared by their @Parameter annotation in the persisted result node preferences.

	 * One have to implement saveParameters() to save parameters that are not of primitive types (e.g. Property, List, HashMap...)

	 * @return

	 * @throws Exception

	 */

	public boolean autoSaveParametersFromAnnotations() throws Exception {

		Log.finest("TXMResult.autoSaveParametersFromAnnotations(): " + this.getClass().getSimpleName() + ": saving parameters to local node...");

		// internal data to save for unserialization

		this.saveParameter("class", this.getClass().getName()); //$NON-NLS-1$

		this.saveParameter(TXMPreferences.RESULT_PARAMETERS_NODE_PATH, this.parametersNodePath);

		// FIXME: old version that not work well if a bundle has no preference initializer

		// FIXME: new version

		this.saveParameter(TXMPreferences.BUNDLE_ID, FrameworkUtil.getBundle(getClass()).getSymbolicName());