cms/conient/DataReader.java

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

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

/**
 * The class reads in data from a BufferedReader,
 * it then converts it to an XMLPacket and adds
 * it to its Queue for anything that wants it.
 *
 * @author  $Author: ajm4 $
 * @version $Id: DataReader.java,v 1.6 2001/01/22 03:03:39 ajm4 Exp $
 */
public class DataReader extends Thread {

//---FINAL ATTRIBUTES---

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

//---CONSTRUCTORS---

    /**
     * Constructs a new data reader, giving it its BufferedReader
     * and Queue.
     *
     * @param inBound the BufferedReader this class should use
     * @param dataQueue the queue new data should be placed on
     */
    public DataReader(BufferedReader inBound, Queue dataQueue) {
        _inBound = inBound;
        _dataQueue = dataQueue;
    }

//---PUBLIC METHODS---

    /**
     * This thread reads data from the BufferedReader.
     * It does this until either there is a problem
     * or it is told to stop.
     *
     * Any data it reads it converts to XML and then 
     * adds to its queue.
     */
    public void run() {
        try {
            String line;
            
            // continue until we are told to stop
            while (_running) {
                line = _inBound.readLine();
                _dataQueue.add(line);
            }
        
            // close the BufferedReader
            _inBound.close();
        
        } catch (IOException e) {
            SwingClient.addMessage("Data Channel Shutdown: reason - "+e);
            _running = false;
        }
    }

    /**
     * This method allows other classes 
     * to shutdown this data reader.
     */
    public void shutdown() {
        _running = false;
    }

//---PRIVATE METHODS---

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

//---ATTRIBUTES---

    /**
     * The reader we are reading from.
     */
    BufferedReader _inBound;
    
    /**
     * The Queue we place data on.
     */
    Queue _dataQueue;
    
    /**
     * The state of this thread.
     */
    boolean _running = true;
    
//---STATIC ATTRIBUTES---

}
Revision:	1.7
Committed:	Wed Jan 24 03:09:45 2001 UTC (23 years, 3 months ago) by ajm
Branch:	MAIN
Changes since 1.6:	+50 -14 lines
Log Message:	all packaged up all javadoc'd still not handling stuff (sockets) right just yet.... but its all in a fit state to be PROPER and continue working and expanding on
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.ac.ukc.iscream.conient;
3
4	//---IMPORTS---
5	import java.io.*;
6	import uk.ac.ukc.iscream.util.*;
7
8	/**
9	* The class reads in data from a BufferedReader,
10	* it then converts it to an XMLPacket and adds
11	* it to its Queue for anything that wants it.
12	*
13	* @author $Author: ajm4 $
14	* @version $Id: DataReader.java,v 1.6 2001/01/22 03:03:39 ajm4 Exp $
15	*/
16	public class DataReader extends Thread {
17
18	//---FINAL ATTRIBUTES---
19
20	/**
21	* The current CVS revision of this class
22	*/
23	public final String REVISION = "$Revision: 1.6 $";
24
25	//---STATIC METHODS---
26
27	//---CONSTRUCTORS---
28
29	/**
30	* Constructs a new data reader, giving it its BufferedReader
31	* and Queue.
32	*
33	* @param inBound the BufferedReader this class should use
34	* @param dataQueue the queue new data should be placed on
35	*/
36	public DataReader(BufferedReader inBound, Queue dataQueue) {
37	_inBound = inBound;
38	_dataQueue = dataQueue;
39	}
40
41	//---PUBLIC METHODS---
42
43	/**
44	* This thread reads data from the BufferedReader.
45	* It does this until either there is a problem
46	* or it is told to stop.
47	*
48	* Any data it reads it converts to XML and then
49	* adds to its queue.
50	*/
51	public void run() {
52	try {
53	String line;
54
55	// continue until we are told to stop
56	while (_running) {
57	line = _inBound.readLine();
58	_dataQueue.add(line);
59	}
60
61	// close the BufferedReader
62	_inBound.close();
63
64	} catch (IOException e) {
65	SwingClient.addMessage("Data Channel Shutdown: reason - "+e);
66	_running = false;
67	}
68	}
69
70	/**
71	* This method allows other classes
72	* to shutdown this data reader.
73	*/
74	public void shutdown() {
75	_running = false;
76	}
77
78	//---PRIVATE METHODS---
79
80	//---ACCESSOR/MUTATOR METHODS---
81
82	//---ATTRIBUTES---
83
84	/**
85	* The reader we are reading from.
86	*/
87	BufferedReader _inBound;
88
89	/**
90	* The Queue we place data on.
91	*/
92	Queue _dataQueue;
93
94	/**
95	* The state of this thread.
96	*/
97	boolean _running = true;
98
99	//---STATIC ATTRIBUTES---
100
101	}