org.corpus_tools.annis.gui.visualizers

Class VisualizerInput

java.lang.Object

org.corpus_tools.annis.gui.visualizers.VisualizerInput

All Implemented Interfaces:

Serializable

public class VisualizerInput
extends Object
implements Serializable

Contains all needed data for a visualizer to perform the visualization.

Author:

Thomas Krause <krauseto@hu-berlin.de>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VisualizerInput()

Method Summary

Modifier and Type	Method and Description
String	getContextPath() Gets the context path of this Annis installation.
org.corpus_tools.salt.common.SDocument	getDocument()
FontConfig	getFont() Get the properties of the (web-) font in which this visualizer should render the output.
String	getId() Gets an optional result id to be used by #writeOutput(Writer)
Map<String,String>	getMappings() Get the mappings for a visualizers.
Map<org.corpus_tools.salt.core.SNode,Long>	getMarkedAndCovered() This map is used for calculating the colors of a matching node.
String	getNamespace() Gets the namespace to be processed by #writeOutput(Writer).
RawTextWrapper	getRawText() Gets the original text from the relAnnis text.tab file represented as a String.
String	getResourcePath(String resource) Returns a valid URL/path for which a relative (from the class package) resource can be accessed.
String	getResourcePathTemplate()
String	getSegmentationName()
org.corpus_tools.salt.common.SDocument	getSResult() Alias for getDocument()
CommonUI	getUI()
Set<String>	getVisibleTokenAnnos() This cachedToken annotation should displayed by the visualizer and is selected by the user in the annis gui.
void	setContextPath(String contextPath) Sets the context path of this Annis installation.
void	setDocument(org.corpus_tools.salt.common.SDocument document)
void	setFont(FontConfig font)
void	setId(String id) Sets an optional result id to be used by #writeOutput(Writer)
void	setMappings(Map<String,String> mappings) Set the mappings for a visualizers.
void	setMarkedAndCovered(Map<org.corpus_tools.salt.core.SNode,Long> markedAndCovered) This map is used for calculating the colors of a matching node.
void	setNamespace(String namespace) Sets the namespace to be processed by #writeOutput(Writer).
void	setRawText(RawTextWrapper rawText) Sets the raw text.
void	setResourcePathTemplate(String resourcePathTemplate)
void	setResult(org.corpus_tools.salt.common.SDocument document) Alias for {@link VisualizerInput#setDocument(de.hu_berlin.german.korpling.saltnpepper.salt.saltCommon.sCorpusStructure.SDocument)
void	setSegmentationName(String segmentationName)
void	setUI(CommonUI ui)
void	setVisibleTokenAnnos(Set<String> tokenAnnos) Set all cachedToken annotations which should be displayed by the visualizer and correspondands to the annos choosen by the user in the annis gui.

Methods inherited from class java.lang.Object

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

Constructor Detail

VisualizerInput

public VisualizerInput()

Method Detail

getContextPath

public String getContextPath()

Gets the context path of this Annis installation.

Returns:

The context path, beginning with an "/" but *not* ending with it.

getDocument

public org.corpus_tools.salt.common.SDocument getDocument()

getFont

public FontConfig getFont()

Get the properties of the (web-) font in which this visualizer should render the output. The visualizer is self-responsible for declaring a backup font that is used when this font is not available.

Returns:

getId

public String getId()

Gets an optional result id to be used by #writeOutput(Writer)

Returns:

getMappings

public Map<String,String> getMappings()

Get the mappings for a visualizers. Mappings are visualizer specific properties, that can be configured in the resolver table of the database

Returns:

The mappings as properties.

getMarkedAndCovered

public Map<org.corpus_tools.salt.core.SNode,Long> getMarkedAndCovered()

This map is used for calculating the colors of a matching node. All Nodes, which are not included, should not be colorized. For getting HEX-values according to html or css standards, it is possible to use MatchedNodeColors.

Returns:

getNamespace

public String getNamespace()

Gets the namespace to be processed by #writeOutput(Writer).

Returns:

getRawText

public RawTextWrapper getRawText()

Gets the original text from the relAnnis text.tab file represented as a String.

This is a convenient and very fast method for extracting the whole text of a document, since this method simply reads database tupel and does not map anything to salt.

Returns:

• null - if the VisualizerPlugin.isUsingRawText() method false for this visualizer.
• empty list - if there are only segmentations and the cachedToken layer is empty

getResourcePath

public String getResourcePath(String resource)

Returns a valid URL/path for which a relative (from the class package) resource can be accessed.

Parameters:

resource -

Returns:

getResourcePathTemplate

public String getResourcePathTemplate()

getSegmentationName

public String getSegmentationName()

Returns:

the segmentationName

getSResult

public org.corpus_tools.salt.common.SDocument getSResult()

Alias for getDocument()

getUI

public CommonUI getUI()

getVisibleTokenAnnos

public Set<String> getVisibleTokenAnnos()

This cachedToken annotation should displayed by the visualizer and is selected by the user in the annis gui.

setContextPath

public void setContextPath(String contextPath)

Sets the context path of this Annis installation.

Parameters:

contextPath - The context path, beginning with an "/" but *not* ending with it.

setDocument

public void setDocument(org.corpus_tools.salt.common.SDocument document)

setFont

public void setFont(FontConfig font)

setId

public void setId(String id)

Sets an optional result id to be used by #writeOutput(Writer)

Parameters:

id - result id to be used in output

setMappings

public void setMappings(Map<String,String> mappings)

Set the mappings for a visualizers. Mappings are visualizer specific properties, that can be configured in the resolver table of the database

Parameters:

mappings - The new mappings.

setMarkedAndCovered

public void setMarkedAndCovered(Map<org.corpus_tools.salt.core.SNode,Long> markedAndCovered)

This map is used for calculating the colors of a matching node. All Nodes, which are not included, should not be colorized. For getting HEX-values according to html or css standards, it is possible to use MatchedNodeColors.

setNamespace

public void setNamespace(String namespace)

Sets the namespace to be processed by #writeOutput(Writer).

Parameters:

namespace - Namespace to be processed

setRawText

public void setRawText(RawTextWrapper rawText)

Sets the raw text. This should only be done, if VisualizerPlugin.isUsingText() return true.

Parameters:

rawText - the original text from the text.tab file in relAnnis. Therefore could be an empty string.

setResourcePathTemplate

public void setResourcePathTemplate(String resourcePathTemplate)

setResult

public void setResult(org.corpus_tools.salt.common.SDocument document)

Alias for {@link VisualizerInput#setDocument(de.hu_berlin.german.korpling.saltnpepper.salt.saltCommon.sCorpusStructure.SDocument)

setSegmentationName

public void setSegmentationName(String segmentationName)

setUI

public void setUI(CommonUI ui)

setVisibleTokenAnnos

public void setVisibleTokenAnnos(Set<String> tokenAnnos)

Set all cachedToken annotations which should be displayed by the visualizer and correspondands to the annos choosen by the user in the annis gui.