server/client/Alert.java

//---PACKAGE DECLARATION---
package uk.ac.ukc.iscream.client;

//---IMPORTS---
import uk.ac.ukc.iscream.util.*;

/**
 * Alert Object
 *
 * @author  $Author: ajm4 $
 * @version $Id: Alert.java,v 1.11 2001/03/06 02:33:55 ajm4 Exp $
 */
public class Alert {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public static final String REVISION = "$Revision: 1.11 $";

    public static final int thresholdNORMAL = 0;
    public static final int thresholdLOWER = 1;
    public static final int thresholdUPPER = 2;
    
    public static final String[] thresholdLevels = {"NORMAL", "LOWER", "UPPER"};
    
    // not OK and FINAL MUST be present...at the beginning and the end
    
    public static final int alertOK = 0;
    public static final int alertNOTICE = 1;
    public static final int alertWARNING = 2;
    public static final int alertCAUTION = 3;
    public static final int alertCRITICAL = 4;
    // note FINAL should be the highest alert
    public static final int alertFINAL = 5;
    
    // note FINAL should be last in this list
    public static final String[] alertLevels = {"OK", "NOTICE", "WARNING", "CAUTION", "CRITICAL", "FINAL"};
    
//---STATIC METHODS---

//---CONSTRUCTORS---
    
    /**
     * Construct an Alert packet at a set level.
     *
     * @param level the level of the alert
     */
    public Alert(int alertLevel, int lastAlert, int thresholdLevel, String source, String thresholdValue, String value, String attributeName, String timeTillNextAlert, long initialAlertTime) {
        _alertLevel = alertLevel;
        _lastAlert = lastAlert;
        _thresholdLevel = thresholdLevel;
        _source = source;
        _thresholdValue = thresholdValue;
        _value = value;
        _attributeName = attributeName;
        _timeTillNextAlert = timeTillNextAlert;
        _initialAlertTime = initialAlertTime;
    }

//---PUBLIC METHODS---
    
    /**
     * Prints a String representation of the Alert object. It
     * is designed to resemble a HashMap.toString(), such that
     * it is similar to the XMLPacket.printAll() method.
     *
     * @return a String representation of this Alert object.
     */
    public String printAll() {
        String result = "{";
        result += "alertLevel="+_alertLevel+", ";
        result += "lastAlert="+_lastAlert+", ";
        result += "thresholdLevel="+_thresholdLevel+", ";
        result += "source="+_source+", ";
        result += "thresholdValue="+_thresholdValue+", ";
        result += "value="+_value+", ";
        result += "attributeName="+_attributeName+", ";
        result += "timeTillNextAlert="+_timeTillNextAlert+", ";
        result += "initialAlertTime="+_initialAlertTime;
        result += "}";
        return result;
    }

    /**
     * Overrides the {@link java.lang.Object#toString() Object.toString()}
     * method to provide clean logging (every class should have this).
     *
     * This uses the uk.ac.ukc.iscream.util.FormatName class
     * to format the toString()
     *
     * @return the name of this class and its CVS revision
     */
    public String toString() {
        return FormatName.getName(
            _name,
            getClass().getName(),
            REVISION);
    }

//---PRIVATE METHODS---

//---ACCESSOR/MUTATOR METHODS---
    
    /**
     * Returns the level of this packet
     */
    public int getLevel() {
        return _alertLevel;
    }
    
    public int getLastLevel() {
        return _lastAlert;
    }
    
    public int getThreshold() {
        return _thresholdLevel;
    }
    
    public String getSource() {
        return _source;
    }
    
    public String getValue() {
        return _value;
    }
    
    public String getThresholdValue() {
        return _thresholdValue;
    }
    
    public String getAttributeName() {
        return _attributeName;
    }
    
    public String getTimeTillNextAlert() {
        return _timeTillNextAlert;
    }
    
    public long getInitialAlertTime () {
        return _initialAlertTime;
    }

//---ATTRIBUTES---

    /**
     * This is the friendly identifier of the
     * component this class is running in.
     * eg, a Filter may be called "filter1",
     * If this class does not have an owning
     * component,  a name from the configuration
     * can be placed here.  This name could also
     * be changed to null for utility classes.
     */
    private String _name = ClientMain.NAME;
    
    /**
     * The alert level of this packet
     */
    private int _alertLevel;
    
    private int _lastAlert;
    
    private int _thresholdLevel;
    
    private String _source;
    private String _value;
    private String _thresholdValue;
    private String _attributeName;
    private String _timeTillNextAlert;
    
    private long _initialAlertTime;

//---STATIC ATTRIBUTES---

}
Revision:	1.12
Committed:	Thu Mar 8 23:05:25 2001 UTC (23 years, 2 months ago) by tdb
Branch:	MAIN
Changes since 1.11:	+24 -2 lines
Log Message:	Added a printAll() method, in line with that of XMLPacket.
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.ac.ukc.iscream.client;
3
4	//---IMPORTS---
5	import uk.ac.ukc.iscream.util.*;
6
7	/**
8	* Alert Object
9	*
10	* @author $Author: ajm4 $
11	* @version $Id: Alert.java,v 1.11 2001/03/06 02:33:55 ajm4 Exp $
12	*/
13	public class Alert {
14
15	//---FINAL ATTRIBUTES---
16
17	/**
18	* The current CVS revision of this class
19	*/
20	public static final String REVISION = "$Revision: 1.11 $";
21
22	public static final int thresholdNORMAL = 0;
23	public static final int thresholdLOWER = 1;
24	public static final int thresholdUPPER = 2;
25
26	public static final String[] thresholdLevels = {"NORMAL", "LOWER", "UPPER"};
27
28	// not OK and FINAL MUST be present...at the beginning and the end
29
30	public static final int alertOK = 0;
31	public static final int alertNOTICE = 1;
32	public static final int alertWARNING = 2;
33	public static final int alertCAUTION = 3;
34	public static final int alertCRITICAL = 4;
35	// note FINAL should be the highest alert
36	public static final int alertFINAL = 5;
37
38	// note FINAL should be last in this list
39	public static final String[] alertLevels = {"OK", "NOTICE", "WARNING", "CAUTION", "CRITICAL", "FINAL"};
40
41	//---STATIC METHODS---
42
43	//---CONSTRUCTORS---
44
45	/**
46	* Construct an Alert packet at a set level.
47	*
48	* @param level the level of the alert
49	*/
50	public Alert(int alertLevel, int lastAlert, int thresholdLevel, String source, String thresholdValue, String value, String attributeName, String timeTillNextAlert, long initialAlertTime) {
51	_alertLevel = alertLevel;
52	_lastAlert = lastAlert;
53	_thresholdLevel = thresholdLevel;
54	_source = source;
55	_thresholdValue = thresholdValue;
56	_value = value;
57	_attributeName = attributeName;
58	_timeTillNextAlert = timeTillNextAlert;
59	_initialAlertTime = initialAlertTime;
60	}
61
62	//---PUBLIC METHODS---
63
64	/**
65	* Prints a String representation of the Alert object. It
66	* is designed to resemble a HashMap.toString(), such that
67	* it is similar to the XMLPacket.printAll() method.
68	*
69	* @return a String representation of this Alert object.
70	*/
71	public String printAll() {
72	String result = "{";
73	result += "alertLevel="+_alertLevel+", ";
74	result += "lastAlert="+_lastAlert+", ";
75	result += "thresholdLevel="+_thresholdLevel+", ";
76	result += "source="+_source+", ";
77	result += "thresholdValue="+_thresholdValue+", ";
78	result += "value="+_value+", ";
79	result += "attributeName="+_attributeName+", ";
80	result += "timeTillNextAlert="+_timeTillNextAlert+", ";
81	result += "initialAlertTime="+_initialAlertTime;
82	result += "}";
83	return result;
84	}
85
86	/**
87	* Overrides the {@link java.lang.Object#toString() Object.toString()}
88	* method to provide clean logging (every class should have this).
89	*
90	* This uses the uk.ac.ukc.iscream.util.FormatName class
91	* to format the toString()
92	*
93	* @return the name of this class and its CVS revision
94	*/
95	public String toString() {
96	return FormatName.getName(
97	_name,
98	getClass().getName(),
99	REVISION);
100	}
101
102	//---PRIVATE METHODS---
103
104	//---ACCESSOR/MUTATOR METHODS---
105
106	/**
107	* Returns the level of this packet
108	*/
109	public int getLevel() {
110	return _alertLevel;
111	}
112
113	public int getLastLevel() {
114	return _lastAlert;
115	}
116
117	public int getThreshold() {
118	return _thresholdLevel;
119	}
120
121	public String getSource() {
122	return _source;
123	}
124
125	public String getValue() {
126	return _value;
127	}
128
129	public String getThresholdValue() {
130	return _thresholdValue;
131	}
132
133	public String getAttributeName() {
134	return _attributeName;
135	}
136
137	public String getTimeTillNextAlert() {
138	return _timeTillNextAlert;
139	}
140
141	public long getInitialAlertTime () {
142	return _initialAlertTime;
143	}
144
145	//---ATTRIBUTES---
146
147	/**
148	* This is the friendly identifier of the
149	* component this class is running in.
150	* eg, a Filter may be called "filter1",
151	* If this class does not have an owning
152	* component, a name from the configuration
153	* can be placed here. This name could also
154	* be changed to null for utility classes.
155	*/
156	private String _name = ClientMain.NAME;
157
158	/**
159	* The alert level of this packet
160	*/
161	private int _alertLevel;
162
163	private int _lastAlert;
164
165	private int _thresholdLevel;
166
167	private String _source;
168	private String _value;
169	private String _thresholdValue;
170	private String _attributeName;
171	private String _timeTillNextAlert;
172
173	private long _initialAlertTime;
174
175	//---STATIC ATTRIBUTES---
176
177	}