org.corpus_tools.annis.gui.visualizers

Class AbstractVisualizer

java.lang.Object

org.corpus_tools.annis.gui.visualizers.AbstractVisualizer

All Implemented Interfaces:

Serializable, FilteringVisualizerPlugin, VisualizerPlugin

Direct Known Subclasses:

AbstractIFrameVisualizer, AbstractImageVisualizer, AudioVisualizer, GridTreeVisualizer, GridVisualizer, HTMLVis, KWICVisualizer, PDFFullVisualizer, PDFVisualizer, RawTextVisualizer, RST, RSTFull, SentStructureJs, VideoVisualizer, VisJs, VisJsDoc

public abstract class AbstractVisualizer
extends Object
implements VisualizerPlugin, FilteringVisualizerPlugin

Base class for all Visualizer. This class sets some defaults, so you may implement the VisualizerPlugin#createComponent(org.corpus_tools.annis.gui.visualizers.VisualizerInput) method for pure Vaadin component plugins.

Author:

Benjamin Weißenfels <b.pixeldrama@gmail.com>

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.corpus_tools.annis.gui.visualizers.VisualizerPlugin

DEFAULT_VISUALIZER

Constructor Summary

Constructors

Constructor and Description
AbstractVisualizer()

Method Summary

Modifier and Type	Method and Description
List<String>	getFilteredNodeAnnotationNames(String toplevelCorpusName, String documentName, Map<String,String> mappings, com.vaadin.ui.UI ui) Return the node annotation names or null if no filtering should be applied.
boolean	isUsingRawText() Determines if this visaulizer wants to use the original text.
boolean	isUsingText() Return if this visualizer is using the complete text.
void	setSegmentationLayer(com.vaadin.ui.Component visualizerImplementation, String segmentationName, Map<org.corpus_tools.salt.core.SNode,Long> markedAndCovered) If applicable change the displayed segmentation.
void	setVisibleTokenAnnosVisible(com.vaadin.ui.Component visualizerImplementation, Set<String> annos) If applicable change the visible token annotations.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.corpus_tools.annis.gui.visualizers.VisualizerPlugin

createComponent, getShortName

Constructor Detail

AbstractVisualizer

public AbstractVisualizer()

Method Detail

getFilteredNodeAnnotationNames

public List<String> getFilteredNodeAnnotationNames(String toplevelCorpusName,
                                                   String documentName,
                                                   Map<String,String> mappings,
                                                   com.vaadin.ui.UI ui)

Description copied from interface: FilteringVisualizerPlugin

Return the node annotation names or null if no filtering should be applied.

Specified by:

getFilteredNodeAnnotationNames in interface FilteringVisualizerPlugin

Returns:

isUsingRawText

public boolean isUsingRawText()

Description copied from interface: VisualizerPlugin

Determines if this visaulizer wants to use the original text.

This is a convenient and very fast method for extracting the whole text of a document, since this method simply reads database tupels and does not map anything to salt. It is recommended to use the raw text over the VisualizerPlugin.isUsingText() method, which indicates, that the visualizer needs the whole document graph, which can slow down the user experience.

It can be use in parralel with VisualizerPlugin.isUsingText(), but makes in most cases no sense.

Specified by:

isUsingRawText in interface VisualizerPlugin

isUsingText

public boolean isUsingText()

Return if this visualizer is using the complete text.

Specified by:

isUsingText in interface VisualizerPlugin

setSegmentationLayer

public void setSegmentationLayer(com.vaadin.ui.Component visualizerImplementation,
                                 String segmentationName,
                                 Map<org.corpus_tools.salt.core.SNode,Long> markedAndCovered)

Description copied from interface: VisualizerPlugin

If applicable change the displayed segmentation.

Specified by:

setSegmentationLayer in interface VisualizerPlugin

setVisibleTokenAnnosVisible

public void setVisibleTokenAnnosVisible(com.vaadin.ui.Component visualizerImplementation,
                                        Set<String> annos)

Description copied from interface: VisualizerPlugin

If applicable change the visible token annotations.

Specified by:

setVisibleTokenAnnosVisible in interface VisualizerPlugin

annos - Which token annotations (qualified name) to show.