triana.types.util

Class Journal

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<E>

java.util.LinkedList

triana.types.util.Journal

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.Deque, java.util.List, java.util.Queue

public class Journal
extends java.util.LinkedList

Journal is a class that accumulates the history of processing on a TrianaType data object. It has a tree-like structure containing the information about the present data set, and how it was created, plus references to Journals of data sets that were used as input in the creation of the present set. Units add information to the Journal when they create the data set and add references to other Journals when they output the set.

Journal is implemented as a LinkedList. Its first element is a StringVector, and when used with a TrianaType data object this is the StringVector description of the object. The elements after the first are themselves Journals that represent the histories of input data sets.

Methods are provided for extending the lists, for writing the whole tree to a String for output, and for re-constructing a Journal from a StringVector input.

See Also:

TrianaType, Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
Journal() Constructs an empty Journal with fixed storage capacity and capacityIncrement.
Journal(StringVector information) Constructs a Journal whose first element is the given StringVector.

Method Summary

Methods

Modifier and Type	Method and Description
void	addJournal(Journal inputData) Adds a Journal to the present Journal.
Journal	copyMe() Copies this Journal to a new Journal object, by value not by reference.
static Journal	readReport(StringVector report, java.lang.String tabbing) Reads an input StringVector and creates a Journal.
java.lang.String	report(java.lang.String tabbing, int level) Returns a String consisting of the contents of the first element of the present Journal and of the first elements of all the Journals in the list, converted to Strings.

Methods inherited from class java.util.LinkedList

add, add, addAll, addAll, addFirst, addLast, clear, clone, contains, descendingIterator, element, get, getFirst, getLast, indexOf, lastIndexOf, listIterator, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, set, size, toArray, toArray

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

equals, hashCode, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode, isEmpty, iterator, listIterator, removeAll, retainAll, subList

Methods inherited from interface java.util.Deque

iterator

Constructor Detail

Journal

public Journal()

Constructs an empty Journal with fixed storage capacity and capacityIncrement.

Journal

public Journal(StringVector information)

Constructs a Journal whose first element is the given StringVector.

Parameters:

information - the information about the present object

See Also:

StringVector

Method Detail

addJournal

public void addJournal(Journal inputData)

Adds a Journal to the present Journal.

Parameters:

inputData - the Journal associated with an input data set

copyMe

public Journal copyMe()

Copies this Journal to a new Journal object, by value not by reference.

report

public java.lang.String report(java.lang.String tabbing,
                      int level)

Returns a String consisting of the contents of the first element of the present Journal and of the first elements of all the Journals in the list, converted to Strings. The String is structured so that the Journals of previous data sets are preceded with a tabbing String (which can be any String, not just \t) to set them apart from the first, or highest-level, Journal. Each level of the tree further from the present Journal gets an extra tabbing String prepended.

Parameters:

tabbing - the String that is to be prepended

level - the number of times that tabbing is prepended

Returns:

String the report

readReport

public static Journal readReport(StringVector report,
                 java.lang.String tabbing)

Reads an input StringVector and creates a Journal. This is the inverse of the previous method: a string written by method report and converted to a StringVector by breaking it on lines will be converted by this method back to the original Journal.

Parameters:

report - A report created by method report and converted to a StringVector

tabbing - the indentation character(s) in the input report

Returns:

Journal the reconstructed Journal.

See Also:

StringVector