Package se.conciliate.extensions.documents

Class MetaData<T>

java.lang.Object

se.conciliate.extensions.documents.MetaData<T>

Direct Known Subclasses:

MetaData.BooleanValue, MetaData.DateTimeValue, MetaData.HiddenValue, MetaData.HtmlValue, MetaData.ImageValue, MetaData.MTSymbolValue, MetaData.NumberValue, MetaData.OptionsValue, MetaData.TextValue, MetaData.UrlValue

public abstract class MetaData<T>
extends Object

Meta-data value connected to a single document. All meta-data are immutable. There are only a fixed number of meta data implementations. These are:

• MetaData.BooleanValue
• MetaData.NumberValue
• MetaData.TextValue
• MetaData.HtmlValue
• MetaData.ImageValue
• MetaData.UrlValue
• MetaData.OptionsValue
• MetaData.DateTimeValue
• MetaData.HiddenValue
• MetaData.MTSymbolValue

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MetaData.BooleanValue	Represents a boolean value.
static final class	MetaData.DateTimeValue	Represents a date/time value.
static final class	MetaData.HiddenValue	Represents a transient value that is never shown in the user-interface.
static final class	MetaData.HtmlValue	Represents a html value.
static final class	MetaData.ImageValue	Represents an image value.
static final class	MetaData.MTSymbolValue	Represents an MTSymbol.
static final class	MetaData.NumberValue	Represents a number value.
static final class	MetaData.OptionsValue	Represents a value chosen from a set list of values.
static final class	MetaData.TextValue	Represents simple, non-formatted text.
static final class	MetaData.UrlValue	Represents a URL value.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Checks this meta data's equality relation to some other object.
T	getData()
abstract MetaDataType<? extends MetaData<T>>	getType()
int	hashCode()	Returns the hash for this meta data.
boolean	isNull()	Returns true if this is a null value.
abstract MetaData<T>	setData(T data)
String	stringPresentation()	Returns a string representation of the data.

Methods inherited from class java.lang.Object

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

Method Details

getType

public abstract MetaDataType<? extends MetaData<T>> getType()

Returns:

the type of the data.

getData

public T getData()

Returns:

The non-null data.

isNull

public boolean isNull()

Returns true if this is a null value.

Returns:

true if this is a null value.

setData

public abstract MetaData<T> setData(T data)

Parameters:

data - A new value.

Returns:

A copy of this meta-data with the given value as the meta-data's data.

stringPresentation

public String stringPresentation()

Returns a string representation of the data. This will be shown for example in document lists.

Returns:

a string representation of the data.

hashCode

public int hashCode()

Returns the hash for this meta data. The hash is based on the hash of the data's meta data type and the hash of the data itself.

Overrides:

hashCode in class Object

Returns:

the hash for this meta data.

equals

public boolean equals(Object obj)

Checks this meta data's equality relation to some other object. Will return false for any object that is not a meta data instance. Meta data is considered equal if their meta data type and data are equal.

Overrides:

equals in class Object

Parameters:

obj - The object to check equality for.

Returns:

true if obj is a meta data instance and has a meta data type and data that are equal to this meta data, false otherwise.