001/*
002 * Copyright (c) 2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: berkley $'
006 * '$Date: 2010-04-28 00:12:36 +0000 (Wed, 28 Apr 2010) $' 
007 * '$Revision: 24000 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.ecoinformatics.seek.R;
031
032import org.rosuda.JRI.RMainLoopCallbacks;
033import org.rosuda.JRI.Rengine;
034
035/**
036 * A simple buffering console that is used to cache the output from an R session
037 * and then can be used to return the console output as a string.
038 * 
039 * @author Matt Jones
040 */
041public class RConsole implements RMainLoopCallbacks {
042        /**
043         * A buffer which caches the output of the R session standard output.
044         */
045        private StringBuffer consoleText = null;
046
047        /**
048         * Construct the R Console class and initialize the buffer containing the
049         * text.
050         */
051        public RConsole() {
052                super();
053                consoleText = new StringBuffer();
054        }
055
056        public void clear() {
057                consoleText = new StringBuffer();
058        }
059
060        /**
061         * After an R session has ended, get a String representation of the output
062         * of the R session.
063         * 
064         * @return String containing the text of the R session output
065         */
066        public String getConsoleOutput() {
067                return consoleText.toString();
068        }
069
070        /**
071         * Callback that is called when text is available from the R Engine and
072         * should be written to the console.
073         */
074        public void rWriteConsole(Rengine re, String text, int oType) {
075                consoleText.append(text);
076        }
077
078        //
079        // The remaining callback methods are not used, but need to have
080        // implementations to satisfy the interface definition.
081        //
082        public void rBusy(Rengine re, int which) {
083                System.out.println("rBusy(" + which + ")");
084        }
085
086        public String rReadConsole(Rengine re, String prompt, int addToHistory) {
087                return null;
088        }
089
090        public void rShowMessage(Rengine re, String message) {
091                System.out.println("rShowMessage \"" + message + "\"");
092        }
093
094        public String rChooseFile(Rengine re, int newFile) {
095                return "";
096        }
097
098        public void rFlushConsole(Rengine re) {
099        }
100
101        public void rLoadHistory(Rengine re, String filename) {
102        }
103
104        public void rSaveHistory(Rengine re, String filename) {
105        }
106}