org.daisy.common.messaging

Class ProgressMessage

java.lang.Object

org.daisy.common.messaging.Message

org.daisy.common.messaging.ProgressMessage

All Implemented Interfaces:

Iterable<ProgressMessage>, MessageAccessor.MessageFilter

public abstract class ProgressMessage
extends Message
implements MessageAccessor.MessageFilter, Iterable<ProgressMessage>

A progress message is an extension of a simple message, with a certain "progress" and with possible nested (progress) messages. Every progress message represents a certain "portion" of the conversion process. The size of the portion is expressed as a fraction (number between 0 and 1) of the "parent" message, or of the whole process in case it is a "top-level" message (without a parent). The progress is a number between 0 (not started) and 1 (completed) that indicates how much of the process has been completed. The total progress of a portion is always greater than or equal to the sum of the child portions' progresses (multiplied by the corresponding portions). Sibling portions have no particular order. They may run sequentially or in parallel. ProgressMessage objects can only be created using MessageBuilder.

Nested Class Summary

Nested classes/interfaces inherited from class org.daisy.common.messaging.Message

Message.Level

Field Summary

Fields inherited from class org.daisy.common.messaging.Message

column, file, level, line, messageCounts, ownerId, sequence, text, throwable, timeStamp

Method Summary

Modifier and Type	Method and Description
MessageAccessor.MessageFilter	filterLevels(Set<Message.Level> levels) Returns a view with only messages with text and of a given severity level.
List<Message>	getMessages() If this message has text, returns a singleton list with an immutable copy of the message.
abstract BigDecimal	getPortion() Portion within parent (or within whole process if no parent)
abstract BigDecimal	getProgress() The total progress of this message
MessageAccessor.MessageFilter	greaterThan(int sequence) Returns a view with only messages with text and with a sequence number above a given threshold, or with a descendant message above that threshold.
MessageAccessor.MessageFilter	inRange(int start, int end) Returns a view with only messages with text and with a sequence number within a given range, or with a descendant message within that range.
Iterator<ProgressMessage>	iterator() Returns a momentary view of the child messages.
String	toString()

Methods inherited from class org.daisy.common.messaging.Message

getColumn, getFile, getLevel, getLine, getOwnerId, getSequence, getText, getThrowable, getTimeStamp

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getProgress

public abstract BigDecimal getProgress()

The total progress of this message

getPortion

public abstract BigDecimal getPortion()

Portion within parent (or within whole process if no parent)

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<ProgressMessage> iterator()

Returns a momentary view of the child messages. The messages in this iterator are immutable copies, i.e. they represent the state of the messages at the moment of this call. Their progress will not change. Messages without text (messages that carry only progress information) are replaced by their children.

Specified by:

iterator in interface Iterable<ProgressMessage>

filterLevels

public MessageAccessor.MessageFilter filterLevels(Set<Message.Level> levels)

Returns a view with only messages with text and of a given severity level. Child messages of excluded messages are promoted (become direct children of the excluded message's parent).

Specified by:

filterLevels in interface MessageAccessor.MessageFilter

greaterThan

public MessageAccessor.MessageFilter greaterThan(int sequence)

Returns a view with only messages with text and with a sequence number above a given threshold, or with a descendant message above that threshold.

Specified by:

greaterThan in interface MessageAccessor.MessageFilter

inRange

public MessageAccessor.MessageFilter inRange(int start,
                                             int end)

Returns a view with only messages with text and with a sequence number within a given range, or with a descendant message within that range.

Specified by:

inRange in interface MessageAccessor.MessageFilter

getMessages

public List<Message> getMessages()

If this message has text, returns a singleton list with an immutable copy of the message. If this message has no text, returns a list of immutable copies of its descendants with text.

Specified by:

getMessages in interface MessageAccessor.MessageFilter