org_estar_rtml/RTMLHistory.java at master · LivTel/org_estar_rtml · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
    Copyright 2006, Astrophysics Research Institute, Liverpool John Moores University.

    This file is part of org.estar.rtml.

    org.estar.rtml is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    org.estar.rtml is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with org.estar.rtml; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
// RTMLHistory.java
// $Header: /space/home/eng/cjm/cvs/org_estar_rtml/RTMLHistory.java,v 1.2 2008-05-27 14:14:43 cjm Exp $
package org.estar.rtml;

import java.io.*;
import java.text.*;
import java.util.*;

/**
 * This class is a data container for information contained in the History nodes/tags of an RTML document.
 * @author Chris Mottram
 * @version $Revision$
 */
public class RTMLHistory implements Serializable
{
	/**
	 * Revision control system version id.
	 */
	public final static String RCSID = "$Id$";
	/**
	 * Serial version ID. Fixed as these documents can be used as parameters in RMI calls across JVMs.
	 */
	static final long serialVersionUID = -1729123909863642410L;
	/**
	 * List containing History entries.
	 */
	public List entryList = null;

	/**
	 * Default constructor. Initialise entryList.
	 * @see #entryList
	 */
	public RTMLHistory()
	{
		super();
		entryList = new Vector();
	}

	/**
	 * Add an entry to the document.
	 * @param e The entry to add.
	 * @see #entryList
	 */
	public void addEntry(RTMLHistoryEntry e)
	{
		entryList.add(e);
	}

	/**
	 * Clear the entries from the document.
	 * @see #entryList
	 */
	public void clearEntryList()
	{
		entryList = null;
	}

	/**
	 * Get an entry from the History Node.
	 * @param index The index in the entry list.
	 * @return The entry to the specicifed index is returned.
	 * @see #entryList
	 */
	public RTMLHistoryEntry getEntry(int index)
	{
		return (RTMLHistoryEntry)(entryList.get(index));
	}

	/**
	 * Get the number of entries in the list.
	 * @return The number of entries in the list.
	 * @see #entryList
	 */
	public int getEntryListCount()
	{
		return entryList.size();
	}

	/**
	 * Method to print out a string representation of this node.
	 * @see #toString(java.lang.String)
	 */
	public String toString()
	{
		return toString("");
	}

	/**
	 * Method to print out a string representation of this node, with a prefix.
	 * @param prefix A string to prefix to each line of data we print out.
	 * @see #getEntryListCount
	 * @see #getEntry
	 */
	public String toString(String prefix)
	{
		RTMLHistoryEntry entry = null;
		StringBuffer sb = null;

		sb = new StringBuffer();
		sb.append(prefix+"History:\n");
		for(int i = 0; i < getEntryListCount();i++)
		{
			entry = getEntry(i);
			if(entry != null)
				sb.append(prefix+entry.toString("\t")+"\n");
		}
		return sb.toString();
	}
}
/*
** $Log: not supported by cvs2svn $
** Revision 1.1  2008/05/23 14:25:08  cjm
** Initial revision
**
*/