ch.uzh.ifi.attempto.acewiki.core
Class LexiconDetail

java.lang.Object
  ch.uzh.ifi.attempto.acewiki.core.LexiconDetail

public class LexiconDetail
extends java.lang.Object

This class represents a detail of a lexical entry as shown to the user. For example, the plural form of a noun would be such a detail.

Author:

Tobias Kuhn

Constructor Summary

LexiconDetail(java.lang.String name, java.lang.Object value)
Creates a required lexical detail object without description.

LexiconDetail(java.lang.String name, java.lang.String description, java.lang.Object value)
Creates a required lexical detail object.

LexiconDetail(java.lang.String name, java.lang.String description, java.lang.Object value, boolean required)
Creates a lexical detail object.

Method Summary

java.lang.String	getDescription() Returns the description of this lexical detail.
java.lang.String	getName() Returns the name of this lexical detail.
java.lang.Object	getValue() Returns the value of this lexical detail, either a String or a Boolean.
boolean	isRequired() Returns whether this lexical detail is required or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

LexiconDetail

public LexiconDetail(java.lang.String name,
                     java.lang.String description,
                     java.lang.Object value,
                     boolean required)

Creates a lexical detail object.

Parameters:

name - The name of the detail as shown to the user.

description - The description shown to the user.

value - The value, either a String or a Boolean.

required - Whether the detail is required or not.

LexiconDetail

public LexiconDetail(java.lang.String name,
                     java.lang.String description,
                     java.lang.Object value)

Creates a required lexical detail object.

Parameters:

name - The name of the detail as shown to the user.

description - The description shown to the user.

value - The value, either a String or a Boolean.

LexiconDetail

public LexiconDetail(java.lang.String name,
                     java.lang.Object value)

Creates a required lexical detail object without description.

Parameters:

name - The name of the detail as shown to the user.

value - The value, either a String or a Boolean.

Method Detail

getName

public java.lang.String getName()

Returns the name of this lexical detail.

Returns:

The name.

getDescription

public java.lang.String getDescription()

Returns the description of this lexical detail.

Returns:

The description.

getValue

public java.lang.Object getValue()

Returns the value of this lexical detail, either a String or a Boolean.

Returns:

The value.

isRequired

public boolean isRequired()

Returns whether this lexical detail is required or not.

Returns:

true if this lexical detail is required.