org.carrot2.util.attribute

Class CommonMetadata

java.lang.Object

org.carrot2.util.attribute.CommonMetadata

Direct Known Subclasses:

AttributeMetadata, BindableMetadata

public class CommonMetadata
extends Object

Common metadata items for BindableMetadata and AttributeMetadata.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected String	label
protected String	title

Constructor Summary

Constructors

Constructor and Description
CommonMetadata()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() A longer, possibly multi sentence, description of the element.
String	getLabel() A short label for the element which can be presented as the label of the corresponding UI component.
String	getLabelOrTitle() Returns the label if it is not-null, otherwise returns title.
String	getTitle() A one sentence summary of the element.
void	setDescription(String plainTextDescription)
void	setLabel(String label)
void	setTitle(String title)

Methods inherited from class java.lang.Object

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

Field Detail

title

protected String title

label

protected String label

description

protected String description

Constructor Detail

CommonMetadata

public CommonMetadata()

Method Detail

getTitle

public String getTitle()

A one sentence summary of the element. Could be presented as a header of the tool tip of the corresponding UI component.

setTitle

public void setTitle(String title)

getLabel

public String getLabel()

A short label for the element which can be presented as the label of the corresponding UI component.

setLabel

public void setLabel(String label)

getLabelOrTitle

public String getLabelOrTitle()

Returns the label if it is not-null, otherwise returns title.

getDescription

public String getDescription()

A longer, possibly multi sentence, description of the element. Could be presented as a body of the tool tip of the corresponding UI component.

setDescription

public void setDescription(String plainTextDescription)