org.corpus_tools.annis.gui.exporter

Class TextColumnExporter

java.lang.Object

org.corpus_tools.annis.gui.exporter.BaseMatrixExporter

org.corpus_tools.annis.gui.exporter.TextColumnExporter

All Implemented Interfaces:

Serializable, ExporterPlugin

@Component
public class TextColumnExporter
extends BaseMatrixExporter

An exporter that will take all token nodes and exports them in a kind of grid. This is useful for getting references of texts where the normal token based text exporter doesn't work since there are multiple speakers or normalizations.

Author:

Thomas Krause <krauseto@hu-berlin.de>, irina

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILTER_PARAMETER_KEYWORD
static String	METAKEYS_KEYWORD
static String	PARAMETER_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
TextColumnExporter()

Method Summary

Modifier and Type	Method and Description
void	createAdjacencyMatrix(org.corpus_tools.salt.common.SDocumentGraph graph, Map<String,String> args, int recordNumber, int nodeCount) Implements the abstract method of the [SaltBasedExporter](\ref org.corpus_tools.annis.gui.exporter.SaltBasedExporter).
String	getFileEnding() Specifies the ending of export file.
String	getHelpMessage()
void	getOrderedMatchNumbers() Invokes the private static method calculateOrderedMatchNumbersGlobally(int[][], boolean, java.util.Set<java.lang.Long>).
boolean	isAlignable() Indicates, that this exporter is alignable, so the check box will appear in the [ExportPanel](\ref org.corpus_tools.annis.gui.ExportPanel), if this exporter is chosen.
void	outputText(org.corpus_tools.salt.common.SDocumentGraph graph, boolean alignmc, int recordNumber, Writer out, com.vaadin.ui.UI ui) Writes the specified record (if applicable, as multiple result lines) from query result set to the output file.

Methods inherited from class org.corpus_tools.annis.gui.exporter.BaseMatrixExporter

convertText, isCancelable, needsContext

Methods inherited from class java.lang.Object

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

Field Detail

FILTER_PARAMETER_KEYWORD

public static final String FILTER_PARAMETER_KEYWORD

See Also:

Constant Field Values

PARAMETER_SEPARATOR

public static final String PARAMETER_SEPARATOR

See Also:

Constant Field Values

METAKEYS_KEYWORD

public static final String METAKEYS_KEYWORD

See Also:

Constant Field Values

Constructor Detail

TextColumnExporter

public TextColumnExporter()

Method Detail

createAdjacencyMatrix

public void createAdjacencyMatrix(org.corpus_tools.salt.common.SDocumentGraph graph,
                                  Map<String,String> args,
                                  int recordNumber,
                                  int nodeCount)
                           throws IOException

Implements the abstract method of the [SaltBasedExporter](\ref org.corpus_tools.annis.gui.exporter.SaltBasedExporter). This method creates and fills an adjacency matrix of dimension (nodeCount x nodeCount), which keeps the relative order of match numbers to each other of each query result line. A result line is a part of a record, which belongs to a speaker. The adjacency matrix is a global two-dimensional array of integers, which allows to recognize the valid order of match numbers globally, after all query results are processed.

Specified by:

createAdjacencyMatrix in class BaseMatrixExporter

Parameters:

graph - an org.corpus_tools.salt.common.SDocumentGraph representation of a record

args - a map containing parameters like 'filter' or 'metakeys', set by user

recordNumber - the number of record within the record set returned for the user query

nodeCount - the count of distinct match numbers in the whole record set returned for the user query

Throws:

IOException

getFileEnding

public String getFileEnding()

Description copied from class: BaseMatrixExporter

Specifies the ending of export file.

Specified by:

getFileEnding in interface ExporterPlugin

Overrides:

getFileEnding in class BaseMatrixExporter

Returns:

a constant String ("csv") for file ending

See Also:

BaseMatrixExporter.getFileEnding()

getHelpMessage

public String getHelpMessage()

Returns:

a String, that represents a short description of this exporter

getOrderedMatchNumbers

public void getOrderedMatchNumbers()

Invokes the private static method calculateOrderedMatchNumbersGlobally(int[][], boolean, java.util.Set<java.lang.Long>).

Specified by:

getOrderedMatchNumbers in class BaseMatrixExporter

isAlignable

public boolean isAlignable()

Indicates, that this exporter is alignable, so the check box will appear in the [ExportPanel](\ref org.corpus_tools.annis.gui.ExportPanel), if this exporter is chosen.

Returns:

always true, since this exporter is alignable

outputText

public void outputText(org.corpus_tools.salt.common.SDocumentGraph graph,
                       boolean alignmc,
                       int recordNumber,
                       Writer out,
                       com.vaadin.ui.UI ui)
                throws IOException

Writes the specified record (if applicable, as multiple result lines) from query result set to the output file.

Specified by:

outputText in class BaseMatrixExporter

Parameters:

graph - the org.corpus_tools.salt.common.SDocumentGraph representation of a specified record

alignmc - a boolean, which indicates, whether the data should be aligned by match numbers or not

recordNumber - the number of record within the record set

out - the specified Writer

Throws:

IOException, - if an I/O error occurs

IOException