Package quadbase.ChartAPI

Class DBInfo

java.lang.Object
quadbase.common.util.internal.DBInfoBasic
quadbase.ChartAPI.DBInfo
All Implemented Interfaces:
quadbase.common.util.IDatabaseInfo, quadbase.common.util.IJNDIDatabaseInfo, IDatabaseInfo
Direct Known Subclasses:
SimpleQueryFileInfo
public class DBInfo extends quadbase.common.util.internal.DBInfoBasic implements IDatabaseInfo
DBInfo

This class provides an implementation for the @link quadbase.util.IDatabaseInfo interface. It stores information necessary to retrieve data from a database.

An example of a DBInfo object is :-

    DBInfo databaseInfo = new DBInfo(new DBInfo("jdbc:odbc:woodview",
      "sun.jdbc.odbc.JdbcOdbcDriver",
      "userName",
      "passWord",
    "select * from sales");
See Also:

  • Constructor Details

    • DBInfo

      @Deprecated public DBInfo(String url, String driver, String username, String password, String query, Applet applet)
      Deprecated.
      Creates a new instance of DbInfo.
      Parameters:
      url - URL of database in form of jdbc:databaseName://machineName(or IPaddress)/schemeName
      driver - JDBC driver class name use
      username - login user name
      password - login password
      query - SQL query to retrieve data from database
      applet - an applet or null if the program is an application

    • DBInfo

      public DBInfo(String url, String driver, String username, String password, String query)
      Creates a new instance of DbInfo.
      Parameters:
      url - URL of database in form of jdbc:databaseName://machineName(or IPaddress)/schemeName
      driver - JDBC driver class name used
      username - login user name
      password - login password
      query - SQL query to retrieve data from database

    • DBInfo

      public DBInfo(String url, String driver, String username, String password, String query, Vector<String> additionalDb)
      Creates a new instance of DbInfo.
      Parameters:
      url - URL of database in form of jdbc:databaseName://machineName(or IPaddress)/schemeName
      driver - JDBC driver class name used
      username - login user name
      password - login password
      query - SQL query to retrieve data from database

    • DBInfo

      public DBInfo(String JNDIName, String query, Hashtable<String,String> env)
      Creates a new instance of DBInfo.
      Parameters:
      JNDIName - JNDI lookup name for the data base
      query - SQL query to retrieve data from data base
      env - Environment properties for the initial context.  Contains INITIAL_CONTEXT_FACTORY and PROVIDER_URL

    • DBInfo

      public DBInfo(quadbase.common.util.IDatabaseInfo dbInfo)
      Creates a new instance of DBInfo.
      Parameters:
      dbInfo - Creates a DBInfo object using information in dbInfo.

    • DBInfo

      @Deprecated public DBInfo(Connection conn, String query, Applet applet)
      Deprecated.
      Creates a new instance of DBInfo using the given Connection object.
      Parameters:
      conn - a connection to the database
      query - SQL query to retrieve data from database
      applet - the parent applet or null if called from application

    • DBInfo

      public DBInfo(Connection conn, String query)
      Creates a new instance of DBInfo using the given Connection object.
      Parameters:
      conn - a connection to the database
      query - SQL query to retrieve data from database

  • Method Details

    • getURLString

      public String getURLString()
      Gets the URL of database.
      Specified by:
      getURLString in interface quadbase.common.util.IDatabaseInfo
      Specified by:
      getURLString in interface IDatabaseInfo
      Overrides:
      getURLString in class quadbase.common.util.internal.DBInfoBasic

    • getDriverName

      public String getDriverName()
      Gets the JDBC driver name.
      Specified by:
      getDriverName in interface quadbase.common.util.IDatabaseInfo
      Specified by:
      getDriverName in interface IDatabaseInfo
      Overrides:
      getDriverName in class quadbase.common.util.internal.DBInfoBasic

    • getUserID

      public String getUserID()
      Gets the user name.
      Specified by:
      getUserID in interface quadbase.common.util.IDatabaseInfo
      Specified by:
      getUserID in interface IDatabaseInfo
      Overrides:
      getUserID in class quadbase.common.util.internal.DBInfoBasic

    • getPassword

      public String getPassword()
      Gets the password
      Specified by:
      getPassword in interface quadbase.common.util.IDatabaseInfo
      Specified by:
      getPassword in interface IDatabaseInfo
      Overrides:
      getPassword in class quadbase.common.util.internal.DBInfoBasic

    • getQuery

      public String getQuery()
      Gets the SQL query
      Specified by:
      getQuery in interface quadbase.common.util.IDatabaseInfo
      Specified by:
      getQuery in interface IDatabaseInfo
      Specified by:
      getQuery in interface quadbase.common.util.IJNDIDatabaseInfo
      Overrides:
      getQuery in class quadbase.common.util.internal.DBInfoBasic

    • getConnection

      public Connection getConnection()
      Gets the connection object, if one exists.
      Specified by:
      getConnection in interface quadbase.common.util.IDatabaseInfo
      Specified by:
      getConnection in interface IDatabaseInfo
      Specified by:
      getConnection in interface quadbase.common.util.IJNDIDatabaseInfo
      Overrides:
      getConnection in class quadbase.common.util.internal.DBInfoBasic

    • getJNDIName

      public String getJNDIName()
      Gets the JNDI lookup name of the data base.
      Specified by:
      getJNDIName in interface quadbase.common.util.IJNDIDatabaseInfo
      Overrides:
      getJNDIName in class quadbase.common.util.internal.DBInfoBasic

    • isUseJNDIDataSource

      public boolean isUseJNDIDataSource()
      Returns if the DBInfo uses JNDI DataSource.
      Overrides:
      isUseJNDIDataSource in class quadbase.common.util.internal.DBInfoBasic

    • getEnvProperties

      public Hashtable<String,String> getEnvProperties()
      Gets environment properties for initial context.
      Specified by:
      getEnvProperties in interface quadbase.common.util.IJNDIDatabaseInfo
      Overrides:
      getEnvProperties in class quadbase.common.util.internal.DBInfoBasic

    • setURLString

      public void setURLString(String url)
      Sets the URL of database.
      Overrides:
      setURLString in class quadbase.common.util.internal.DBInfoBasic

    • setDriverName

      public void setDriverName(String driver)
      Sets the JDBC driver name.
      Overrides:
      setDriverName in class quadbase.common.util.internal.DBInfoBasic

    • setUserID

      public void setUserID(String username)
      Sets the user name.
      Overrides:
      setUserID in class quadbase.common.util.internal.DBInfoBasic

    • setPassword

      public void setPassword(String password)
      Sets the password.
      Overrides:
      setPassword in class quadbase.common.util.internal.DBInfoBasic

    • setQuery

      public void setQuery(String query)
      Sets the SQL query.
      Overrides:
      setQuery in class quadbase.common.util.internal.DBInfoBasic

    • setJNDIName

      public void setJNDIName(String name)
      Sets the JNDI lookup name.
      Overrides:
      setJNDIName in class quadbase.common.util.internal.DBInfoBasic

    • setUseJNDIDataSource

      public void setUseJNDIDataSource(boolean b)
      Sets if use JNDI DataSource.
      Overrides:
      setUseJNDIDataSource in class quadbase.common.util.internal.DBInfoBasic

    • setEnvProperties

      public void setEnvProperties(Hashtable<String,String> env)
      Sets environment properties for initial context.
      Overrides:
      setEnvProperties in class quadbase.common.util.internal.DBInfoBasic

    • getDatabaseConnection

      public static Connection getDatabaseConnection(String driverName, String urlString, String userName, String passwd)
      This static function establishes a connection to the specified database and returns a connection object to it.
      Parameters:
      urlString - The url to the database
      driver - The driver name
      username - The username used to connect to the database
      password - The database password
      Returns:
      connection The connection object

    • getDatabaseConnection

      public static Connection getDatabaseConnection(String JNDIName, Hashtable<String,String> env) throws SQLException
      This static function establishes a connection to the specified database and returns a connection object to it.
      Parameters:
      JNDIName - JNDI lookup name for the database
      env - Environment properties for initial context
      Returns:
      connection The connection object
      Throws:
      SQLException

    • setConnection

      public void setConnection(Connection conn)
      This function sets the connection field in this object.
      Overrides:
      setConnection in class quadbase.common.util.internal.DBInfoBasic
      Parameters:
      connection - A reference to the Connection object.

    • establishConnection

      public boolean establishConnection()
      This function establishes a connection to the database specified by the URL string.
      Overrides:
      establishConnection in class quadbase.common.util.internal.DBInfoBasic
      Returns:
      true if connection is established, false otherwise

    • closeConnection

      public void closeConnection()
      This function closes the connection to the database.
      Overrides:
      closeConnection in class quadbase.common.util.internal.DBInfoBasic

    • fetchData

      public DbData fetchData() throws SQLException
      Gets the data from database, return as instance of DbData. ClassNotFoundException is thrown if JDBC driver not found. If there is error in SQL execution an SQLException will throw.
      Throws:
      SQLException

    • getColData

      public static quadbase.chart.ColData[] getColData(quadbase.common.util.IDatabaseInfo dbInfo, boolean isSpreadSheet, boolean[] transposeCol) throws Exception
      Throws:
      Exception