org.corpus_tools.annis.api.model

Class VisualizerRule

java.lang.Object

org.corpus_tools.annis.api.model.VisualizerRule

All Implemented Interfaces:

Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-08-17T18:57:13.897+02:00[Europe/Berlin]")
public class VisualizerRule
extends Object
implements Serializable

A rule when to trigger a visualizer for a specific result.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VisualizerRule.ElementEnum On which element type to trigger the visualizer on
static class	VisualizerRule.VisibilityEnum The default display state of the visualizer before any user interaction.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_DISPLAY_NAME
static String	SERIALIZED_NAME_ELEMENT
static String	SERIALIZED_NAME_LAYER
static String	SERIALIZED_NAME_MAPPINGS
static String	SERIALIZED_NAME_VIS_TYPE
static String	SERIALIZED_NAME_VISIBILITY

Constructor Summary

Constructors

Constructor and Description
VisualizerRule()

Method Summary

Modifier and Type	Method and Description
VisualizerRule	displayName(String displayName)
VisualizerRule	element(VisualizerRule.ElementEnum element)
boolean	equals(Object o)
String	getDisplayName() A text displayed to the user describing this visualization
VisualizerRule.ElementEnum	getElement() On which element type to trigger the visualizer on
String	getLayer() In which layer the element needs to be part of to trigger this visualizer.
Map<String,String>	getMappings() Additional configuration given as generic map of key values to the visualizer.
VisualizerRule.VisibilityEnum	getVisibility() The default display state of the visualizer before any user interaction.
String	getVisType() The abstract type of visualization, e.g.
int	hashCode()
VisualizerRule	layer(String layer)
VisualizerRule	mappings(Map<String,String> mappings)
VisualizerRule	putMappingsItem(String key, String mappingsItem)
void	setDisplayName(String displayName)
void	setElement(VisualizerRule.ElementEnum element)
void	setLayer(String layer)
void	setMappings(Map<String,String> mappings)
void	setVisibility(VisualizerRule.VisibilityEnum visibility)
void	setVisType(String visType)
String	toString()
VisualizerRule	visibility(VisualizerRule.VisibilityEnum visibility)
VisualizerRule	visType(String visType)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ELEMENT

public static final String SERIALIZED_NAME_ELEMENT

See Also:

Constant Field Values

SERIALIZED_NAME_LAYER

public static final String SERIALIZED_NAME_LAYER

See Also:

Constant Field Values

SERIALIZED_NAME_VIS_TYPE

public static final String SERIALIZED_NAME_VIS_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_DISPLAY_NAME

public static final String SERIALIZED_NAME_DISPLAY_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_VISIBILITY

public static final String SERIALIZED_NAME_VISIBILITY

See Also:

Constant Field Values

SERIALIZED_NAME_MAPPINGS

public static final String SERIALIZED_NAME_MAPPINGS

See Also:

Constant Field Values

Constructor Detail

VisualizerRule

public VisualizerRule()

Method Detail

element

public VisualizerRule element(VisualizerRule.ElementEnum element)

getElement

@Nullable
public VisualizerRule.ElementEnum getElement()

On which element type to trigger the visualizer on

Returns:

element

setElement

public void setElement(VisualizerRule.ElementEnum element)

layer

public VisualizerRule layer(String layer)

getLayer

@Nullable
public String getLayer()

In which layer the element needs to be part of to trigger this visualizer. Only relevant for edges, since only they are part of layers. If not given, elements of all layers trigger this visualization.

Returns:

layer

setLayer

public void setLayer(String layer)

visType

public VisualizerRule visType(String visType)

getVisType

@Nullable
public String getVisType()

The abstract type of visualization, e.g. \"tree\", \"discourse\", \"grid\", ...

Returns:

visType

setVisType

public void setVisType(String visType)

displayName

public VisualizerRule displayName(String displayName)

getDisplayName

@Nullable
public String getDisplayName()

A text displayed to the user describing this visualization

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

visibility

public VisualizerRule visibility(VisualizerRule.VisibilityEnum visibility)

getVisibility

@Nullable
public VisualizerRule.VisibilityEnum getVisibility()

The default display state of the visualizer before any user interaction.

Returns:

visibility

setVisibility

public void setVisibility(VisualizerRule.VisibilityEnum visibility)

mappings

public VisualizerRule mappings(Map<String,String> mappings)

putMappingsItem

public VisualizerRule putMappingsItem(String key,
                                      String mappingsItem)

getMappings

@Nullable
public Map<String,String> getMappings()

Additional configuration given as generic map of key values to the visualizer.

Returns:

mappings

setMappings

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object