org.corpus_tools.annis.gui.visualizers

Interface VisualizerPlugin

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractIFrameVisualizer, AbstractImageVisualizer, AbstractVisualizer, AudioVisualizer, CorefVisualizer, GridTreeVisualizer, GridVisualizer, HTMLVis, HTMLVisFull, KWICVisualizer, MatchCorefVisualizer, PDFFullVisualizer, PDFVisualizer, RawTextVisualizer, RST, RSTFull, SentStructureJs, TigerTreeVisualizer, VakyarthaDependencyTree, VideoVisualizer, VisJs, VisJsDoc, WriterVisualizer

public interface VisualizerPlugin
extends Serializable

Every visualizer must implement this interface. It' s also necessary to to load this plugin by hand in org.corpus_tools.annis.gui.AnnisBaseUI#initPlugins() If you wish to implement an iframe visualizer you should extend the

 AbstractIFrameVisualizer
 

class, because this class already has implemented the VisualizerPlugin#createComponent(org.corpus_tools.annis.visualizers.visualizers.VisualizerInput) method. For the case of using Vaadin Component directly its recommended to extend the AbstractVisualizer class. There you will have to implement the VisualizerPlugin#createComponent(org.corpus_tools.annis.visualizers.visualizers.VisualizerInput) method. Normally you need a inner or additional class which extends a vaadin implementation of the Component interface. The org.corpus_tools.annis.gui.visualizers.component.KWICPanel is an example for that.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VISUALIZER

Method Summary

Modifier and Type	Method and Description
com.vaadin.ui.Component	createComponent(VisualizerInput visInput, VisualizationToggle visToggle) It is used by the ANNIS plugin system to generate something viewable for vaadin.
String	getShortName() Get the shorted name of the linguistic type of this visualizer ("partitur", "tree", etc.)
boolean	isUsingRawText() Determines if this visaulizer wants to use the original text.
boolean	isUsingText() Checks if the Plugin needs the primary text source.
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.

Field Detail

DEFAULT_VISUALIZER

static final String DEFAULT_VISUALIZER

See Also:

Constant Field Values

Method Detail

createComponent

com.vaadin.ui.Component createComponent(VisualizerInput visInput,
                                        VisualizationToggle visToggle)

It is used by the ANNIS plugin system to generate something viewable for vaadin.

getShortName

String getShortName()

Get the shorted name of the linguistic type of this visualizer ("partitur", "tree", etc.)

Returns:

isUsingRawText

boolean isUsingRawText()

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 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 isUsingText(), but makes in most cases no sense.

isUsingText

boolean isUsingText()

Checks if the Plugin needs the primary text source.

setSegmentationLayer

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

If applicable change the displayed segmentation.

Parameters:

segmentationName -

setVisibleTokenAnnosVisible

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

If applicable change the visible token annotations.

Parameters:

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