server/rootfilter/CIWrapper.java

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

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

/**
 * A ClientInterface wrapper - the CI objects are pushed data,
 * yet data is pulled from the queue. This will sit inbetween
 * for now, until the CI design is changed.
 *
 * @author  $Author: tdb1 $
 * @version $Id $
 */
public class CIWrapper extends Thread {

//---FINAL ATTRIBUTES---

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

//---CONSTRUCTORS---

    /**
     * Sets up the wrapper, with a single destination and a queue.
     *
     * @param destination the client interface to send the xml to
     * @param queue a reference to a queue to use
     */
    public CIWrapper(ClientInterface destination, Queue queue){
        // set the Thread name
        setName("rootfilter.CIWrapper");
        
        _destination = destination;
        _queue = queue;
        _queueID = queue.getQueue();
    }

//---PUBLIC METHODS---

    /**
     * start the thread and thus gets and sends data
     */
    public void run() {
        String xml = null;
        while(true) {
            try {
                xml = (String) _queue.get(_queueID);
            }
            catch (InvalidQueueException e) {
                _logger.write(toString(), Logger.ERROR, "Queue error: "+e);
            }
            _destination.receiveXML(xml);
        }
    }

    /**
     * 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.NameFormat 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---

//---ATTRIBUTES---

    /**
     * A reference to a Queue object.
     */
    private Queue _queue;
    
    /**
     * Our Queue id.
     */
    private int _queueID;
    
    /**
     * the interface this thread is sending data to
     */
    private ClientInterface _destination;
    
    /**
     * 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 = RootFilter.NAME;

    /**
     * This holds a reference to the
     * system logger that is being used.
     */
    private Logger _logger = ReferenceManager.getInstance().getLogger();

//---STATIC ATTRIBUTES---

}
Revision:	1.8
Committed:	Tue Mar 13 16:37:31 2001 UTC (23 years, 2 months ago) by tdb
Branch:	MAIN
Changes since 1.7:	+8 -2 lines
Log Message:	Now makes use of the ConfigurationProxy.
#	User	Rev	Content
1	tdb	1.1	//---PACKAGE DECLARATION---
2			package uk.ac.ukc.iscream.rootfilter;
3
4			//---IMPORTS---
5			import uk.ac.ukc.iscream.core.*;
6	tdb	1.4	import uk.ac.ukc.iscream.componentmanager.*;
7	tdb	1.1	import uk.ac.ukc.iscream.clientinterface.*;
8			import uk.ac.ukc.iscream.util.*;
9
10			/**
11			* A ClientInterface wrapper - the CI objects are pushed data,
12			* yet data is pulled from the queue. This will sit inbetween
13			* for now, until the CI design is changed.
14			*
15	tdb	1.2	* @author $Author: tdb1 $
16	tdb	1.1	* @version $Id $
17			*/
18			public class CIWrapper extends Thread {
19
20			//---FINAL ATTRIBUTES---
21
22			/**
23			* The current CVS revision of this class
24			*/
25	tdb	1.8	public final String REVISION = "$Revision: 1.7 $";
26	tdb	1.1
27			//---STATIC METHODS---
28
29			//---CONSTRUCTORS---
30
31			/**
32			* Sets up the wrapper, with a single destination and a queue.
33			*
34			* @param destination the client interface to send the xml to
35			* @param queue a reference to a queue to use
36			*/
37			public CIWrapper(ClientInterface destination, Queue queue){
38	tdb	1.7	// set the Thread name
39			setName("rootfilter.CIWrapper");
40
41	tdb	1.1	_destination = destination;
42			_queue = queue;
43	tdb	1.5	_queueID = queue.getQueue();
44	tdb	1.1	}
45
46			//---PUBLIC METHODS---
47
48			/**
49			* start the thread and thus gets and sends data
50			*/
51			public void run() {
52	tdb	1.3	String xml = null;
53	tdb	1.1	while(true) {
54			try {
55	tdb	1.6	xml = (String) _queue.get(_queueID);
56	tdb	1.1	}
57			catch (InvalidQueueException e) {
58			_logger.write(toString(), Logger.ERROR, "Queue error: "+e);
59			}
60			_destination.receiveXML(xml);
61			}
62			}
63
64			/**
65			* Overrides the {@link java.lang.Object#toString() Object.toString()}
66			* method to provide clean logging (every class should have this).
67			*
68	tdb	1.8	* This uses the uk.ac.ukc.iscream.util.NameFormat class
69			* to format the toString()
70			*
71	tdb	1.1	* @return the name of this class and its CVS revision
72			*/
73			public String toString() {
74	tdb	1.8	return FormatName.getName(
75			_name,
76			getClass().getName(),
77			REVISION);
78	tdb	1.1	}
79
80			//---PRIVATE METHODS---
81
82			//---ACCESSOR/MUTATOR METHODS---
83
84			//---ATTRIBUTES---
85
86			/**
87			* A reference to a Queue object.
88			*/
89			private Queue _queue;
90	tdb	1.5
91			/**
92			* Our Queue id.
93			*/
94			private int _queueID;
95	tdb	1.1
96			/**
97			* the interface this thread is sending data to
98			*/
99			private ClientInterface _destination;
100
101			/**
102			* This is the friendly identifier of the
103			* component this class is running in.
104			* eg, a Filter may be called "filter1",
105			* If this class does not have an owning
106			* component, a name from the configuration
107			* can be placed here. This name could also
108			* be changed to null for utility classes.
109			*/
110			private String _name = RootFilter.NAME;
111
112			/**
113			* This holds a reference to the
114			* system logger that is being used.
115			*/
116			private Logger _logger = ReferenceManager.getInstance().getLogger();
117
118			//---STATIC ATTRIBUTES---
119
120			}