uk.ac.sheffield.vtts.model

Class Notice

java.lang.Object

uk.ac.sheffield.vtts.model.Element

uk.ac.sheffield.vtts.model.Notice

Direct Known Subclasses:

Analysis, Warning

public class Notice
extends Element

Notice is the ancestor of different notice, analysis and warning messages. A Notice represents meta-data to be communicated to the user along with data generated by a process. Notice has two subclasses, Analysis and Warning, which have identical behaviour, but which are named differently to indicate different levels of severity. A plain Notice just represents information, an unmarked notification of something. A Notice may contain further subsidary Notice, Analysis and Warning nodes. A Notice may contain arbitrary model Elements, described by the Notice.

Version:

Broker@Cloud 1.0

Author:

Anthony J H Simons

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Element>	elements A list of arbitrary Elements described by this Notice.
protected java.util.List<Notice>	notices The Annotations attached to this Notice.
protected java.lang.String	text A short text string indicating the text.

Constructor Summary

Constructors

Constructor and Description
Notice() Creates an empty Notice.
Notice(java.lang.String text) Creates a Notice with the given text.

Method Summary

Methods

Modifier and Type	Method and Description
Notice	addElement(Element element) Adds a model Element to the list described by this Notice.
Notice	addNotice(Notice note) Adds a subsidiary Notice to this Notice node.
java.util.List<Element>	getElements() Returns the list of Elements described by this Notice, if any.
java.util.List<Notice>	getNotices() Returns the list of subsidiary Notices under this Notice, if any.
java.lang.String	getText() Returns the text of this Notice.
Notice	setText(java.lang.String text) Sets the text of this Notice.

Methods inherited from class uk.ac.sheffield.vtts.model.Element

safeEquals, safeHashCode, semanticError

Methods inherited from class java.lang.Object

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

Field Detail

text

protected java.lang.String text

A short text string indicating the text.

notices

protected java.util.List<Notice> notices

The Annotations attached to this Notice.

elements

protected java.util.List<Element> elements

A list of arbitrary Elements described by this Notice.

Constructor Detail

Notice

public Notice()

Creates an empty Notice.

Notice

public Notice(java.lang.String text)

Creates a Notice with the given text.

Parameters:

text - the text.

Method Detail

setText

public Notice setText(java.lang.String text)

Sets the text of this Notice.

Parameters:

text - the text.

Returns:

this Notice.

getText

public java.lang.String getText()

Returns the text of this Notice.

Returns:

the text.

addNotice

public Notice addNotice(Notice note)

Adds a subsidiary Notice to this Notice node. Creates a list to store the Notices, when the first Notice is added.

Parameters:

note - the subsidiary Notice to add.

Returns:

this Notice.

getNotices

public java.util.List<Notice> getNotices()

Returns the list of subsidiary Notices under this Notice, if any. Returns null, if no subsidiary Notices were added.

Returns:

a list of Notices, or null.

addElement

public Notice addElement(Element element)

Adds a model Element to the list described by this Notice. Creates a list to store the Elements, when the first Element is added.

Parameters:

element - the Element to add.

Returns:

this Notice.

getElements

public java.util.List<Element> getElements()

Returns the list of Elements described by this Notice, if any. Returns null, if no Elements were added.

Returns:

the list of related Elements, or null.