uk.org.iscream.cms.conient.datacomponents
Interface DataComponent

All Known Implementing Classes:
VisibleDataComponent

public interface DataComponent

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.

Version:
$Id: DataComponent.java,v 1.13 2004/08/01 10:40:10 tdb Exp $
Author:
$Author: tdb $

Field Summary
static String REVISION
          The current CVS revision of this class
 
Method Summary
 String getPacketAttribute()
          Returns the string showing the packet attribute that the component is looking after
 void setValue(XMLPacket packet)
          This takes an XMLPacket so that the reading component can extract the data it needs to update the display.
 

Field Detail

REVISION

public static final String REVISION
The current CVS revision of this class

See Also:
Constant Field Values
Method Detail

setValue

public void setValue(XMLPacket packet)
              throws DataFormatException
This takes an XMLPacket so that the reading component can extract the data it needs to update the display.

Parameters:
packet - the packet
Throws:
DataFormatException - if there was a problem converting the data for display

getPacketAttribute

public String getPacketAttribute()
Returns the string showing the packet attribute that the component is looking after

Returns:
the packet reference


Copyright © 2000-2003 i-scream. All Rights Reserved.