jas.statistics.db
Class Table

java.lang.Object
  jas.statistics.db.Table

All Implemented Interfaces:

ISimEventListener

Direct Known Subclasses:

CollectionTable

public class Table
extends java.lang.Object
implements ISimEventListener

An object representing a database table which stores one or more variables from the simulation model. For each time the table is updated, it stores on database one record containing the values corresponding to the columns managed by the table.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa

Field Summary

static int	PK_IDENTITY
static int	PK_NOTHING
static int	PK_SIMULATION_TIME

Constructor Summary

Table(java.lang.String name, boolean multiRun)
Create a new table with the given name.

Table(java.lang.String name, boolean appendRows, int primaryKeyType)
Create a new table with the given name.

Method Summary

void	addColumn(java.lang.String name, boolean nullable, int type, int size, boolean identity, boolean primarykey) Add a generic column definition to the table.
void	addDoubleColumn(java.lang.String name, IDoubleSource source) Add a double column, which is able to get values from a double source.
void	addDoubleColumn(java.lang.String name, IDoubleSource source, int valueId) Add a double column, which is able to get values from a double source.
void	addFloatColumn(java.lang.String name, IFloatSource source) Add a float column, which is able to get values from a float source.
void	addFloatColumn(java.lang.String name, IFloatSource source, int valueId) Add a float column, which is able to get values from a float source.
void	addIntColumn(java.lang.String name, IIntSource source) Add an integer column, which is able to get values from an integer source.
void	addIntColumn(java.lang.String name, IIntSource source, int valueId) Add an integer column, which is able to get values from an integer source.
void	addLongColumn(java.lang.String name, ILongSource source) Add a long column, which is able to get values from a long source.
void	addLongColumn(java.lang.String name, ILongSource source, int valueId) Add a long column, which is able to get values from a long source.
void	addStringColumn(java.lang.String name, int size, IStringSource source) Add a string column, which is able to get values from a string source.
void	addStringColumn(java.lang.String name, int size, IStringSource source, int valueId) Add a string column, which is able to get values from a string source.
java.lang.String	generateCreationStatement() Generate a SQL string to be used to create the table in the database.
Column	getColumn(java.lang.String name) Search for a column with the given name.
java.util.ArrayList	getColumns() The list of columns defined for the table.
Database	getDb() Return the Database object which created this table.
java.lang.String	getName() Return the name of the table.
void	performAction(int actionType) The object implementing this interface is able to receive an event notify.
void	setDb(Database database) Attach the table to the given Database object.
void	update() It retrieves values from the columns and add a new row in the table on database.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PK_IDENTITY

public static final int PK_IDENTITY

See Also:

Constant Field Values

PK_NOTHING

public static final int PK_NOTHING

See Also:

Constant Field Values

PK_SIMULATION_TIME

public static final int PK_SIMULATION_TIME

See Also:

Constant Field Values

Constructor Detail

Table

public Table(java.lang.String name,
             boolean multiRun)

Create a new table with the given name.

Parameters:

name - The name of the table. It must be unique in a database.

Table

public Table(java.lang.String name,
             boolean appendRows,
             int primaryKeyType)

Create a new table with the given name.

Parameters:

name - The name of the table. It must be unique in a database.

Method Detail

addColumn

public void addColumn(java.lang.String name,
                      boolean nullable,
                      int type,
                      int size,
                      boolean identity,
                      boolean primarykey)

Add a generic column definition to the table. The column will not be bounded to any data source, so the update has to be done manually.

Parameters:

name - The unique name name of the column.

nullable - True if the column will accept null values.

type - The data type of the column. @see java.sql.Types for more details.

size - The maximum size of the field in bytes.

identity - If true the column will be automatically set by the database engine.

primarykey - True if the column is a primary key of the table.

addDoubleColumn

public void addDoubleColumn(java.lang.String name,
                            IDoubleSource source)

Add a double column, which is able to get values from a double source.

Parameters:

name - The unique name name of the column.

source - An IDoubleSource object, from which to retrieve values, using the default valueId.

addDoubleColumn

public void addDoubleColumn(java.lang.String name,
                            IDoubleSource source,
                            int valueId)

Add a double column, which is able to get values from a double source.

Parameters:

name - The unique name name of the column.

source - An IDoubleSource object, from which to retrieve values.

valueId - The valueId for the double source.

addFloatColumn

public void addFloatColumn(java.lang.String name,
                           IFloatSource source)

Add a float column, which is able to get values from a float source.

Parameters:

name - The unique name name of the column.

source - An IFloatSource object, from which to retrieve values, using the default valueId.

addFloatColumn

public void addFloatColumn(java.lang.String name,
                           IFloatSource source,
                           int valueId)

Add a float column, which is able to get values from a float source.

Parameters:

name - The unique name name of the column.

source - An IFloatSource object, from which to retrieve values.

valueId - The valueId for the float source.

addIntColumn

public void addIntColumn(java.lang.String name,
                         IIntSource source)

Add an integer column, which is able to get values from an integer source.

Parameters:

name - The unique name name of the column.

source - An IIntSource object, from which to retrieve values, using the default valueId.

addIntColumn

public void addIntColumn(java.lang.String name,
                         IIntSource source,
                         int valueId)

Add an integer column, which is able to get values from an integer source.

Parameters:

name - The unique name name of the column.

source - An IIntSource object, from which to retrieve values.

valueId - The valueId for the integer source.

addLongColumn

public void addLongColumn(java.lang.String name,
                          ILongSource source)

Add a long column, which is able to get values from a long source.

Parameters:

name - The unique name name of the column.

source - An ILongSource object, from which to retrieve values, using the default valueId.

addLongColumn

public void addLongColumn(java.lang.String name,
                          ILongSource source,
                          int valueId)

Add a long column, which is able to get values from a long source.

Parameters:

name - The unique name name of the column.

source - An ILongSource object, from which to retrieve values.

valueId - The valueId for the integer source.

addStringColumn

public void addStringColumn(java.lang.String name,
                            int size,
                            IStringSource source)

Add a string column, which is able to get values from a string source. It uses the default valueId for for the IStringSource.

Parameters:

name - The unique name name of the column.

size - The maximum allowed length of the String.

source - An IStringSource object, from which to retrieve values, using the default valueId.

addStringColumn

public void addStringColumn(java.lang.String name,
                            int size,
                            IStringSource source,
                            int valueId)

Add a string column, which is able to get values from a string source.

Parameters:

name - The unique name name of the column.

size - The maximum allowed length of the String.

source - An IStringSource object, from which to retrieve values.

valueId - The valueId for the source string.

generateCreationStatement

public java.lang.String generateCreationStatement()

Generate a SQL string to be used to create the table in the database.

Returns:

A SQL compliant creation script.

getColumn

public Column getColumn(java.lang.String name)

Search for a column with the given name.

Parameters:

name - The name of the column to be found.

Returns:

The column with the given name, or null if not found.

getColumns

public java.util.ArrayList getColumns()

The list of columns defined for the table.

Returns:

An ArrayList object with the current list of columns.

getDb

public Database getDb()

Return the Database object which created this table.

Returns:

The Database owner.

getName

public java.lang.String getName()

Return the name of the table.

Returns:

The name of the table.

performAction

public void performAction(int actionType)

Description copied from interface: ISimEventListener

The object implementing this interface is able to receive an event notify.

Specified by:

performAction in interface ISimEventListener

Parameters:

actionType - The switch id to select the right action to perform. It might be an Sim.EVENT_* or a custom defined constant.

setDb

public void setDb(Database database)

Attach the table to the given Database object.

Parameters:

database - A Database object.

update

public void update()

It retrieves values from the columns and add a new row in the table on database.