conient/datacomponents/DataComponent.java

//---PACKAGE DECLARATION---
package uk.org.iscream.cms.conient.datacomponents;

//---IMPORTS---
import uk.org.iscream.cms.server.util.XMLPacket;

/**
 * This interface is used by all
 * components that will be used to display
 * inbound data.  The HostDisplayPanel class
 * uses it as a generic way to tell a specific
 * class that holds data to update its data with
 * a given packet.
 *
 * A related class is the VisibleDataComponent
 * abstract class, this is specifically for components
 * that will display data and thus implements this
 * interface.
 *
 * @author  $Author: ajm4 $
 * @version $Id: DataComponent.java,v 1.8 2001/03/18 14:43:39 ajm4 Exp $
 */
public interface DataComponent {
    
//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.8 $";
    
//---STATIC METHODS---
    
//---CONSTRUCTORS---

//---PUBLIC METHODS---

//---PRIVATE METHODS---

//---ACCESSOR/MUTATOR METHODS---

    /**
     * This takes an XMLPacket so that the reading
     * component can extract the data it needs to update
     * the display.
     *
     * @param packet the packet
     * @throws DataFormatException if there was a problem converting the data for display
     */
    public void setValue(XMLPacket packet) throws DataFormatException;

    /**
     * Returns the string showing the packet
     * attribute that the component is looking after
     *
     * @return the packet reference
     */
    public String getPacketAttribute();

//---ATTRIBUTES---

//---STATIC ATTRIBUTES---

}
Revision:	1.9
Committed:	Tue May 29 17:41:32 2001 UTC (22 years, 11 months ago) by tdb
Branch:	MAIN
Changes since 1.8:	+4 -4 lines
Log Message:	The last of the central monitoring system packages to be changed to the newer structure. It has changed from; uk.org.iscream.conient.* to; uk.org.iscream.cms.conient.* This is in keeping with the new style of packaging.
#	User	Rev	Content
1	ajm	1.2	//---PACKAGE DECLARATION---
2	tdb	1.9	package uk.org.iscream.cms.conient.datacomponents;
3	ajm	1.2
4			//---IMPORTS---
5	tdb	1.9	import uk.org.iscream.cms.server.util.XMLPacket;
6	ajm	1.2
7			/**
8	ajm	1.3	* This interface is used by all
9			* components that will be used to display
10			* inbound data. The HostDisplayPanel class
11			* uses it as a generic way to tell a specific
12			* class that holds data to update its data with
13	ajm	1.8	* a given packet.
14	ajm	1.2	*
15	ajm	1.3	* A related class is the VisibleDataComponent
16			* abstract class, this is specifically for components
17	ajm	1.5	* that will display data and thus implements this
18			* interface.
19	ajm	1.2	*
20			* @author $Author: ajm4 $
21	tdb	1.9	* @version $Id: DataComponent.java,v 1.8 2001/03/18 14:43:39 ajm4 Exp $
22	ajm	1.2	*/
23	ajm	1.3	public interface DataComponent {
24	ajm	1.2
25			//---FINAL ATTRIBUTES---
26
27			/**
28			* The current CVS revision of this class
29			*/
30	tdb	1.9	public final String REVISION = "$Revision: 1.8 $";
31	ajm	1.2
32			//---STATIC METHODS---
33
34			//---CONSTRUCTORS---
35
36			//---PUBLIC METHODS---
37
38			//---PRIVATE METHODS---
39
40			//---ACCESSOR/MUTATOR METHODS---
41	ajm	1.3
42	ajm	1.2	/**
43	ajm	1.8	* This takes an XMLPacket so that the reading
44			* component can extract the data it needs to update
45			* the display.
46	ajm	1.2	*
47	ajm	1.8	* @param packet the packet
48	ajm	1.2	* @throws DataFormatException if there was a problem converting the data for display
49			*/
50	ajm	1.8	public void setValue(XMLPacket packet) throws DataFormatException;
51	ajm	1.6
52			/**
53			* Returns the string showing the packet
54			* attribute that the component is looking after
55			*
56			* @return the packet reference
57			*/
58			public String getPacketAttribute();
59	ajm	1.2
60			//---ATTRIBUTES---
61
62			//---STATIC ATTRIBUTES---
63
64	ajm	1.5	}