org.carrot2.util.attribute

Class AttributeMetadata

java.lang.Object

org.carrot2.util.attribute.CommonMetadata

org.carrot2.util.attribute.AttributeMetadata

public class AttributeMetadata
extends CommonMetadata

Human-readable metadata about an attribute. Metadata contains such elements as title, label and description.

Field Summary

Fields inherited from class org.carrot2.util.attribute.CommonMetadata

description, label, title

Constructor Summary

Constructors

Constructor and Description
AttributeMetadata()
AttributeMetadata(String title, String label, String description)
AttributeMetadata(String title, String label, String description, String group, AttributeLevel level)

Method Summary

Methods

Modifier and Type	Method and Description
String	getGroup() Returns the label of the group this attribute belongs to or null if the attribute is not assigned to any group.
AttributeLevel	getLevel() Returns the attribute level (basic, medium, advanced) or null if the attribute has no level assigned.
void	setGroup(String group)
void	setLevel(AttributeLevel level)
String	toString()

Methods inherited from class org.carrot2.util.attribute.CommonMetadata

getDescription, getLabel, getLabelOrTitle, getTitle, setDescription, setLabel, setTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeMetadata

public AttributeMetadata()

AttributeMetadata

public AttributeMetadata(String title,
                 String label,
                 String description)

AttributeMetadata

public AttributeMetadata(String title,
                 String label,
                 String description,
                 String group,
                 AttributeLevel level)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getGroup

public String getGroup()

Returns the label of the group this attribute belongs to or null if the attribute is not assigned to any group.

setGroup

public void setGroup(String group)

getLevel

public AttributeLevel getLevel()

Returns the attribute level (basic, medium, advanced) or null if the attribute has no level assigned.

setLevel

public void setLevel(AttributeLevel level)