conient/datacomponents/DataComponent.java

/* 
 * i-scream central monitoring system
 * http://www.i-scream.org.uk
 * Copyright (C) 2000-2002 i-scream
 * 
 * This program 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.
 * 
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

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

//---IMPORTS---
import uk.org.iscream.cms.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: tdb $
 * @version $Id: DataComponent.java,v 1.11 2002/05/21 16:47:10 tdb Exp $
 */
public interface DataComponent {
    
//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.11 $";
    
//---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.12
Committed:	Wed Feb 5 19:35:04 2003 UTC (21 years, 3 months ago) by tdb
Branch:	MAIN
Changes since 1.11:	+3 -3 lines
Log Message:	Conient now uses the new seperate i-scream util package.
#	User	Rev	Content
1	tdb	1.10	/*
2			* i-scream central monitoring system
3	tdb	1.11	* http://www.i-scream.org.uk
4	tdb	1.10	* Copyright (C) 2000-2002 i-scream
5			*
6			* This program is free software; you can redistribute it and/or
7			* modify it under the terms of the GNU General Public License
8			* as published by the Free Software Foundation; either version 2
9			* of the License, or (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License
17			* along with this program; if not, write to the Free Software
18			* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19			*/
20
21	ajm	1.2	//---PACKAGE DECLARATION---
22	tdb	1.9	package uk.org.iscream.cms.conient.datacomponents;
23	ajm	1.2
24			//---IMPORTS---
25	tdb	1.12	import uk.org.iscream.cms.util.XMLPacket;
26	ajm	1.2
27			/**
28	ajm	1.3	* This interface is used by all
29			* components that will be used to display
30			* inbound data. The HostDisplayPanel class
31			* uses it as a generic way to tell a specific
32			* class that holds data to update its data with
33	ajm	1.8	* a given packet.
34	ajm	1.2	*
35	ajm	1.3	* A related class is the VisibleDataComponent
36			* abstract class, this is specifically for components
37	ajm	1.5	* that will display data and thus implements this
38			* interface.
39	ajm	1.2	*
40	tdb	1.10	* @author $Author: tdb $
41	tdb	1.12	* @version $Id: DataComponent.java,v 1.11 2002/05/21 16:47:10 tdb Exp $
42	ajm	1.2	*/
43	ajm	1.3	public interface DataComponent {
44	ajm	1.2
45			//---FINAL ATTRIBUTES---
46
47			/**
48			* The current CVS revision of this class
49			*/
50	tdb	1.12	public final String REVISION = "$Revision: 1.11 $";
51	ajm	1.2
52			//---STATIC METHODS---
53
54			//---CONSTRUCTORS---
55
56			//---PUBLIC METHODS---
57
58			//---PRIVATE METHODS---
59
60			//---ACCESSOR/MUTATOR METHODS---
61	ajm	1.3
62	ajm	1.2	/**
63	ajm	1.8	* This takes an XMLPacket so that the reading
64			* component can extract the data it needs to update
65			* the display.
66	ajm	1.2	*
67	ajm	1.8	* @param packet the packet
68	ajm	1.2	* @throws DataFormatException if there was a problem converting the data for display
69			*/
70	ajm	1.8	public void setValue(XMLPacket packet) throws DataFormatException;
71	ajm	1.6
72			/**
73			* Returns the string showing the packet
74			* attribute that the component is looking after
75			*
76			* @return the packet reference
77			*/
78			public String getPacketAttribute();
79	ajm	1.2
80			//---ATTRIBUTES---
81
82			//---STATIC ATTRIBUTES---
83
84	ajm	1.5	}