RBNBBase.java

/* RBNBBase.java
 * ************************************************************************
 * Created on May 7, 2004
 *
 * A base class for all RBNB widgets
 *
 */
package org.nees.rbnb;

import java.util.Hashtable;
import java.util.Enumeration;

import java.io.IOException;

import com.rbnb.sapi.*;

//import COM.Creare.Utility.ArgHandler; //for argument parsing
import com.rbnb.utility.ArgHandler; //for argument parsing

public abstract class RBNBBase
{

    private static final String SERVER_NAME_NAME = "ServerHostName";
    private static final String SERVER_NAME = "localhost";
    private static final String SERVER_PORT_NAME = "ServerPortNumber";
    private static final String SERVER_PORT = "3333";
    private String serverName = SERVER_NAME;
    private String serverPort = SERVER_PORT;
    private String server = serverName + ":" + serverPort;
    
    protected static final String DATA_SOURCE_CHANNEL = "Untyped_Unnamed_data_source";
    protected static final String DATA_SOURCE_NAME = "data.txt";
    protected static final String LOGGING_SOURCE_CHANNEL = "Untyped_Unnamed_debug_log_source";
    protected static final String LOGGING_SOURCE_NAME = "log.txt";
    protected static final String COMMAND_PLUGIN_CHANNEL = "Untyped_Unnamed_command_plugin";
    protected static final String COMMAND_PLUGIN_NAME = "command.text";
    
    protected String dataSourceChannel = DATA_SOURCE_CHANNEL;
    protected String dataSourceName = DATA_SOURCE_NAME;
    protected String loggingSourceChannel = LOGGING_SOURCE_CHANNEL;
    protected String loggindSourceName = LOGGING_SOURCE_NAME;
    protected String commandPluginChannel = COMMAND_PLUGIN_CHANNEL;
    protected String commandPluginName = COMMAND_PLUGIN_NAME;

    private static String[] baseParameterNameArray;
    private static String[] baseParameterTypeArray;
    private static Object[] baseParameterDefaultArray;
    
    private Hashtable parameters = new Hashtable();
    
    static
    {
        setBaseParamterArrays();        
    }
    
    private static void setBaseParamterArrays()
    {
        baseParameterNameArray = new String[2];
        baseParameterTypeArray = new String[2];
        baseParameterDefaultArray = new Object[2];
        
        baseParameterNameArray[0] = SERVER_NAME_NAME;
        baseParameterTypeArray[0] =
            RBNBBaseParameterHolder.STRING_TYPE;
        baseParameterDefaultArray[0] = SERVER_NAME;
        
        baseParameterNameArray[1] = SERVER_PORT_NAME;
        baseParameterTypeArray[1] =
            RBNBBaseParameterHolder.STRING_TYPE;
        baseParameterDefaultArray[1] = SERVER_PORT;
    }
    
    protected void initialize()
    {
        parameters = new Hashtable();
        setDefaultParameters();
    }
    
    protected boolean setArgs(String[] args) throws IllegalArgumentException
    {
        if (!setBaseArgs(args)) return false;
        return setInstanceArgs(args);
    }
    
    private void setDefaultParameters() {
        String[] n = getParameterNameArray();
        String[] t = getParameterTypeArray();
        Object[] d = getParameterDefaultArray();
        
        for (int i = 0; i < n.length; i++)
            setNewParameter(n[i],t[i],d[i]);
    }

    protected abstract void setParamterArrays();

    public void setBaseVarialbesFromParametes()
    {
        serverName = SERVER_NAME;
        try{
            Object obj = getValueWithDefault(SERVER_NAME_NAME, SERVER_NAME);
            serverName = (String)obj;
        } catch (Throwable ignore){}

        serverPort = SERVER_PORT;
        try{
            Object obj = getValueWithDefault(SERVER_PORT_NAME, SERVER_PORT);
            serverPort = (String)obj;
        } catch (Throwable ignore){}
        
        server = serverName + ":" + serverPort;
    }
    
    protected Object getValueWithDefault(String parameterName, Object sourceDefualt)
    {
        RBNBBaseParameterHolder p = getParameter(parameterName);
        Object d = p.getDefaultValue();
        Object v = p.getValue();
        if (v == null) v = d;
        if (v == null) v = sourceDefualt;
        return v;
    }

    protected boolean setBaseArgs(String[] args) throws IllegalArgumentException
    {   
        //parse args
        try {
            ArgHandler ah=new ArgHandler(args);
            if (ah.checkFlag('h')) {
                printUsage();
                return false;
            }
            if (ah.checkFlag('s')) {
                String a=ah.getOption('s');
                if (a!=null) setServerName(a);
            }
            if (ah.checkFlag('p')) {
                String a=ah.getOption('p');
                if (a!=null) setServerPort(a);
            }
        } catch (Exception e) {
            throw new IllegalArgumentException("setArg failed: " + e);
        }
        return true;
    }
    
    public void setServerName(String name) {
        serverName = name;
        this.setParameterValue(SERVER_NAME_NAME,new String(name));
    }

    public void setServerPort(String port) {
        serverPort = port;
        this.setParameterValue(SERVER_PORT_NAME,new String(port));
    }

    public String getServer()
    {
        server = serverName + ":" + serverPort;
        return server;
    }

    protected abstract boolean setInstanceArgs(String[] args) throws IllegalArgumentException;

    protected void printUsage() {
        System.out.println("[-s Server Hostname *" + SERVER_NAME + "] ");
        System.out.println("[-p Server Port Number *" + SERVER_PORT + "] ");
    }

    protected String getTemplateName()
    {
        String fullName = this.getClass().getName();
        int pos = fullName.lastIndexOf(".");
        String shortName = "";
        if (pos > -1)
            shortName = fullName.substring(pos+1,fullName.length());
        else
            shortName = fullName;
        return shortName;
    }
    
    protected Hashtable getParamterTable()
    {
        return parameters;
    }

    protected void setNewParameter(String name, String type, Object defaultValue)
        throws IllegalArgumentException
    {
System.out.println("Set new parameter (in " + this.getTemplateName() + ") name = " + name);
        if (name == null) throw new IllegalArgumentException("Null Name not allowed.");
        RBNBBaseParameterHolder p = new RBNBBaseParameterHolder(name, type, defaultValue);
        parameters.put(name, p);
    }

    protected void setParameterValue(String name, Object value)
        throws IllegalArgumentException
    {
        RBNBBaseParameterHolder p = (RBNBBaseParameterHolder) parameters.get(name);
        if (p != null) p.setValue(value);
    }
    
    protected RBNBBaseParameterHolder getParameter(String name)
    {
        return (RBNBBaseParameterHolder) parameters.get(name);
    }

    public abstract String[] getParameterNameArray();
    
    public abstract String[] getParameterTypeArray();

    public abstract Object[] getParameterDefaultArray();

    public String[] getBaseParameterNameArray() {
        return baseParameterNameArray;
    }

    public String[] getBaseParameterTypeArray() {
        return baseParameterTypeArray;
    }

    public Object[] getBaseParameterDefaultArray() {
        return baseParameterDefaultArray;
    }
    
    public abstract void setVariablesFromParameters();
    
    public abstract boolean start();
    
    public abstract boolean stop();

    public abstract boolean isRunning();
}
/*
 * $Header: /disks/cvs/neesgrid/turbine/src/org/nees/rbnb/RBNBBase.java,v 1.10 2004/07/15 17:36:41 weymouth Exp $
 */

---