Laboratoire ICAR » Plateforme TXM

/**

 * Progression similar to the progression of Weblex software.

 * @author mdecorde

 * @author sjacquot

 */

	/** The norep. */

	public static int norep = 1;

	/** The prefix r. */

	public static String prefixR = "Progression"; //$NON-NLS-1$

	public static final String DENSITY_CHART_TYPE = "density"; //$NON-NLS-1$

	/** The Xmin corpus. */

	protected int XminCorpus;

	/** The Xmax corpus. */

	protected int XmaxCorpus;

	/** The writer. */

	private BufferedWriter writer;

	/** List of token position in the text. */

	protected List<int[]> allPositions;

	/** The structurepositions. */

	protected int[] structurePositions;

	/** The structurenames. */

	protected String[] structureNames;

	/** graph boundaries. */

	protected int maxY;

	/** The max x. */

	protected int maxX;

	/** The bande. */

	protected float bande = 0.0f;

	/**

	 * set this to skip the QueryResult build step

	 */

	protected List<QueryResult> queryResults;

	/**

	 * Queries.

	 */

	protected List<CQLQuery> queries;

	/**

	 * Structural unit.

	 */

	protected StructuralUnit structuralUnit;

	/**

	 * Structural unit property.

	 */

	protected StructuralUnitProperty structuralUnitProperty;

	/**

	 * Repeats or not the same value when displaying the section markers.

	 */

	protected boolean repeatValues;

	/**

	 * Only used in Density mode.

	 */

	protected float bandeMultiplier;

	/**

	 * Regex to display only the property that match it.

	 */

	protected String propertyRegex;

	/**

	 * Creates a not computed progression

	 * @param parent

	 */

		this(null, parent);

	}

	/**

	 * Creates a not computed progression

	 * @param parametersNodePath

	 */

		super(parametersNodePath, null);

	}

	/**

	 * Creates a not computed progression.

	 * @param parametersNodePath

	 * @param parent

	 */

		this.domainGridLinesVisible = false;

	}

	@Override

	public boolean loadParameters() {

			this.queries = CQLQuery.stringToQueries(this.getStringParameterValue(TXMPreferences.QUERIES));

		}

			try {

				this.structuralUnit = this.getCorpus().getStructuralUnit(this.getStringParameterValue(TXMPreferences.STRUCTURAL_UNIT));

					this.structuralUnitProperty = this.structuralUnit.getProperty(this.getStringParameterValue(TXMPreferences.STRUCTURAL_UNIT_PROPERTY));

				}

			}

				e.printStackTrace();

			}

		}

		// generate the chart type according to cumulative boolean preference

			this.chartType = Progression.DENSITY_CHART_TYPE;

		}

		return true;

	}

	@Override

	public boolean saveParameters() {

			this.saveParameter(TXMPreferences.QUERIES, CQLQuery.queriesToString(this.queries));

		}

			this.saveParameter(TXMPreferences.STRUCTURAL_UNIT, this.structuralUnit.getName());

		}

			this.saveParameter(TXMPreferences.STRUCTURAL_UNIT_PROPERTY, this.structuralUnitProperty.getName());

		}

		return true;

	}

	@Override

	public boolean canCompute() {

		// null or empty queries

			Log.fine("Progression.canCompute(): can not compute with no query."); //$NON-NLS-1$

			return false;

		}

		// wrong REGEX

			try {

				Pattern.compile(this.propertyRegex);

			}

				return false;

			}

		}

		return true;

	}

	@Override

	public boolean setParameters(TXMParameters parameters) {

		// TODO Auto-generated method stub

		System.err.println("Progression.setParameters(): not yet implemented."); //$NON-NLS-1$

		return true;

	}

	/**

	 * Sets the structural unit.

	 * @param structuralUnit

	 */

		this.structuralUnit = structuralUnit;

		this.setStructuralUnitProperty(null);

	}

	/**

	 * Sets the structural unit property.

	 * @param structuralUnitProperty

	 */

		this.structuralUnitProperty = structuralUnitProperty;

	}

	public void setQueryResults(List<QueryResult> queryResults) {

		this.queryResults = queryResults;

	}

	/**

	 * 

	 * @param queries

	 * @param bandeMultiplier

	 */

	// FIXME : SJ: all parameters related to rendering should be removed from this class and centralized in the charts engine system, eg. line width

		this.queries = queries; // the query of the selection

		this.structuralUnit = structuralUnit;

		this.structuralUnitProperty = property;

		this.propertyRegex = propertyregex;

		this.repeatValues = repeatValues;

		this.bandeMultiplier = bandeMultiplier;

			DefaultTheme.monoWidths[i] = lineWidth;

		}

	}

	/**

	 * Computes.

	 *

	 * @return true, if successful

	 * @throws CqiClientException the cqi client exception

	 */

	protected boolean __compute() throws Exception {

		// Queries

			this.structurePositions = new int[0];

			this.structureNames = new String[0];

			this.subTask("Processing queries...");

			if (!this.stepQueries()) {

				return true;

			}

				return false;

			}

			this.worked(10);

		}

		// Structural units

		this.subTask("Processing structural units...");

			return false;

		}

		this.worked(20);

		// Finalization steps

			this.subTask("Finalizing...");

				return false;

			}

			this.worked(20);

		}

		return true;

	}

	/**

	 * Test discontinuity of a corpus. If the corpus is a subcorpus then test if the start-end of matches make no hole

	 * @param corpus

	 * @return

	 */

					previousMatch = m;

					continue;

				}

					previousMatch = m;

					continue;

				}

		}

		return true;

	}

	/**

	 * compute using already resolved QueryResults

	 * @param queryResults

	 * @return

	 * @throws CqiClientException

	 */

	public boolean stepQueries(List<QueryResult> queryResults) throws CqiClientException {

		if (queryResults.size() != queries.size()) return false;

		maxX = getCorpus().getSize();

		int npositions = 0;

			QueryResult result = queryResults.get(iQuery);

			int nLines = result.getNMatch();

			if (maxY < nLines) {

				maxY = nLines;

			}

			List<Match> matches = null;

			if (nLines > 0) {

				matches = result.getMatches(0, nLines - 1); // get the indexes sequences of result's tokens

			}

			else {

			}

			int[] positions = new int[matches.size()];

			// System.out.println("nb positions "+matches.size());

			// if (matches.size() > 0)

		}

		return npositions > 0;

	}

	/**

	 * Step queries.

	 *

	 * @throws CqiClientException the cqi client exception

	 */

		maxX = getCorpus().getSize();

		int npositions = 0;

			QueryResult result = null;

			if (queryResults != null) {

				result = queryResults.get(iQuery);

				CQLQuery query = queries.get(iQuery);

				result = getCorpus().query(query, query.getQueryString()

						.replace(" ", "_") + "_progression", true); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$

			}

			int nLines = result.getNMatch();

			if (maxY < nLines)

				maxY = nLines;

			List<Match> matches = null;

			if (nLines > 0) {

				matches = result.getMatches(0, nLines - 1); // get the indexes

				// sequences of result's tokens

			}

			int[] positions = new int[matches.size()];

			// System.out.println("nb positions "+matches.size());

			// if (matches.size() > 0)

		}

		return npositions > 0;

	}

	/**

	 * Step structural units.

	 *

	 * @throws CqiClientException the cqi client exception

	 */

		// structure query

		if (structuralUnit != null) {

			CQLQuery query = new CQLQuery("<" + structuralUnit.getName() + ">[]"); //$NON-NLS-1$ //$NON-NLS-2$

				if (!propertyRegex.isEmpty()) {

					query = new CQLQuery("<" + structuralUnitProperty.getFullName() + "=\"" + propertyRegex + "\">[]"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$

				}

					query = new CQLQuery("<" + structuralUnitProperty.getFullName() + ">[]"); //$NON-NLS-1$ //$NON-NLS-2$

				}

			}

			// System.out.println("Struct: "+ structure+" property: "+property);

			// System.out.println(query.getQueryString());

			QueryResult result = getCorpus().query(query, query.getQueryString().replace(" ", "_") + "_progression", true); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$

			int[] starts = result.getStarts();

			result.drop();

			int nLines = starts.length;

			// sequences of result's tokens

			structurePositions = new int[nLines];

			structureNames = new String[nLines];

			if (structuralUnitProperty != null) {

				List<String> values = CorpusManager.getCorpusManager().getCqiClient().getSingleData(structuralUnitProperty, starts);

				refValues.put(structuralUnitProperty, values);

			}

			int i = 0;

			String previousname = ""; //$NON-NLS-1$

			String currentname = ""; //$NON-NLS-1$

				else {

					currentname = structuralUnit.getName() + i;

				}

				structureNames[i] = currentname;

				structurePositions[i] = m;

				if (i == 0) {

					structurePositions[i] += 1;

				}

				if (m - previousposition < distmin) {

					distmin = m - previousposition;

				}

				previousname = currentname;

				previousposition = m;

				i++;

				this.worked(1);

			}

			this.bande = distmin * this.bandeMultiplier;

		}

		return true;

	}

	/**

	 * Step finalize.

	 *

	 * @throws CqiClientException the cqi client exception

	 */

		if (getCorpus() instanceof Subcorpus) {

			List<Match> matches = ((Subcorpus) getCorpus()).getMatches();

			if (matches.size() == 0) {

				System.out.println(ProgressionCoreMessages.errorColonSubcorpusWithSize0);

				return false;

			}

			XminCorpus = matches.get(0).getStart();

		}

		else {

			XminCorpus = 0;

			XmaxCorpus = getCorpus().getSize();

		}

		if (bande <= 0) {

			bande = ((XmaxCorpus - XminCorpus) / 100) * bandeMultiplier;

			if (bande == 0) {

		}

		return true;

	}

	/**

	 * Gets the max x.

	 *

	public int getMaxX() {

		return maxX;

	}

	/**

	 * Gets the max y.

	 *

	public int getMaxY() {

		return maxY;

	}

	/**

	 * Gets the corpus.

	 *

	public CQPCorpus getCorpus() {

		return (CQPCorpus) this.parent;

	}

	/**

	 * Gets the queries.

	 *

	public List<CQLQuery> getQueries() {

		return this.queries;

	}

	/**

	 * @return the allPositions

	 */

	public List<int[]> getAllPositions() {

		return allPositions;

	}

	/**

	 * Gets the positions counts.

	 *

	 * @return the positions counts

	 */

	public List<Integer> getPositionsCounts() {

		for (int[] list : allPositions) {

			counts.add(list.length);

		}

		return counts;

	}

	/**

	 * Checks if is repeatvalues.

	 *

	public boolean isRepeatingValues() {

		return repeatValues;

	}

	@Override

	public void clean() {

		try {

			org.txm.utils.logger.Log.printStackTrace(e);

		}

	}

	@Override

	public boolean toTxt(File outfile, String encoding, String colseparator,

			String txtseparator) throws Exception {

		return toTxt(outfile, encoding);

	}

	/**

	 * 

	 * @param outfile

		// NK: writer declared as class attribute to perform a clean if the operation is interrupted

		tryAcquireSemaphore();

		this.writer = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(outfile),

			for (int p : allPositions.get(i)) {

			}

		}

		writer.close();

		releaseSemaphore();

		return true;

	}

	/**

	 * @return the structurePositions

	 */

	public int[] getStructurePositions() {

		return structurePositions;

	}

	/**

	 * @return the structureNames

	 */

	public String[] getStructureNames() {

		return structureNames;

	}

	/**

	 * @return the propertyRegex

	 */

	public String getPropertyRegex() {

		return propertyRegex;

	}

	/**

	 * @return the bande

	 */

	public float getBande() {

		return bande;

	}

	/**

	 * @return the xminCorpus

	 */

	public int getXminCorpus() {

		return XminCorpus;

	}

	/**

	 * @return the xmaxCorpus

	 */

	public int getXmaxCorpus() {

		return XmaxCorpus;

	}

	@Override

	public String[] getExportTXTExtensions() {

	}

	/**

	 * Computes and gets a query constructed from all the queries in alternative mode (with pipe |).

	 * @return

	 */

	// FIXME: not used? even in synchronous editors (concordance and edition?)?

			allQueriesIndexes.add(i);

		}

	}

	/**

	 * Computes and gets a query constructed from all the queries specified by their index in alternative mode (with pipe |).

	 * @param queriesIndexes

	 * @return

	 */

		String query = "";

				String tmpQuery = this.queries.get(i).getQueryString();

					int length = tmpQuery.length();

						length--;

					}

					tmpQuery = tmpQuery.substring(1, length);

				}

					query += " | ";

				}

				query += tmpQuery;

			}

		}

		return query;

	}

	@Override

	public String getDetails() {

		return this.getName();

	}

	@Override

	public String getName() {

		try {

			return this.parent.getSimpleName() + ": " + this.getSimpleName(); //$NON-NLS-1$

		}

		}

		return ""; //$NON-NLS-1$

	}

	@Override

	public String getSimpleName() {

		try {

			if (this.queries == null || this.queries.isEmpty()) {

				return getEmptyName();

			}

			if (this.propertyRegex != null) {

				output += " " + this.propertyRegex; //$NON-NLS-1$

			}

		}

		return this.getEmptyName();

	}

	@Override

	public String getComputingStartMessage() {

	}

	@Override

	public String getComputingDoneMessage() {

			return TXMCoreMessages.common_noResults;

		}

		else {

			return TXMCoreMessages.bind(TXMCoreMessages.common_P0Positions, positions);

		}

	}

	/**

	 * @return the bandeMultiplier

	 */

	public float getBandeMultiplier() {

		return bandeMultiplier;

	}

	/**

	 * @param bandeMultiplier the bandeMultiplier to set

	 */

	public void setBandeMultiplier(float bandeMultiplier) {

		this.bandeMultiplier = bandeMultiplier;

	}

	/**

	 * @param repeatValues the repeatValues to set

	 */

	public void setRepeatValues(boolean repeatValues) {

		this.repeatValues = repeatValues;

	}

	/**

	 * @return the structuralUnit

	 */

	public StructuralUnit getStructuralUnit() {

		return structuralUnit;

	}

	/**

	 * @return the structuralUnitProperty

	 */

	public StructuralUnitProperty getStructuralUnitProperty() {

		return structuralUnitProperty;

	}

	/**

	 * @param queries the queries to set

	 */

	public void setQueries(List<CQLQuery> queries) {

		this.queries = queries;

	}

	@Override

	public String getResultType() {

		return ProgressionCoreMessages.RESULT_TYPE;

	}