|
ContactCenters V. 0.9.9. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectumontreal.iro.lecuyer.xmlconfig.AbstractParam
umontreal.iro.lecuyer.xmlconfig.DBSourceArray2D
public class DBSourceArray2D
Represents a source array whose data is
extracted from a database using JDBC.
The elements of the array are obtained by
performing a query on a database.
Each row of the resulting result set
is a row in the source array, while each column
corresponding to a field of the result set
becomes a column in the array.
The JDBC connection is initialized using
DBConnectionParam
, and the
result set is converted into an array
of objects using
JDBCManager.readObjectData2D(Connection,String)
.
Any numeric object (instances of Number
)
is converted to the target class while
other objects not corresponding to the
target class are converted to string before
they are passed to
String)
.
In a XML file, the dataQuery attribute of an element representing a database-based source array is used to specify the query on the database. The database nested element is then used to describe the connection to the database.
Constructor Summary | |
---|---|
DBSourceArray2D()
|
Method Summary | ||
---|---|---|
void |
addDatabase(DBConnectionParam dbParams1)
For internal use only. |
|
DBSourceArray2D |
clone()
|
|
int |
columns(int row)
Returns the number of columns in row row of the source array. |
|
void |
dispose()
Clears the data in the source array. |
|
|
get(Class<T> pcls,
int row,
int column)
Returns the element at row row and column column of the source array, converted to class pcls. |
|
DBConnectionParam |
getDatabase()
Returns the parameters of the database connection used to obtain data for this source array. |
|
String |
getDataQuery()
Returns the SQL query used to obtain data for the element in the source array. |
|
String |
getElementName()
Returns the name of the XML element representing the type of source array implemented. |
|
void |
init()
Initializes the source array by performing the SQL query. |
|
int |
rows()
Returns the number of rows in the source array. |
|
void |
setDatabase(DBConnectionParam dbParams)
Sets the parameters of the database connection to dbParams. |
|
void |
setDataQuery(String dataQuery)
Sets the SQL query for data to dataQuery. |
|
Element |
toElement(ClassFinder finder,
Node parent,
String elementName,
int spc)
Converts this parameter object to a DOM element using the class finder finder for formatting class names, with parent node parent, element name elementName, and spc spaces for each indentation level. |
Methods inherited from class umontreal.iro.lecuyer.xmlconfig.AbstractParam |
---|
check, createDocument, getId, getXref, setId, setXref, toString, write, write, write, write, write, write, write, write |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DBSourceArray2D()
Method Detail |
---|
public DBConnectionParam getDatabase()
public void setDatabase(DBConnectionParam dbParams)
dbParams
- the parameters for the database connection.public String getDataQuery()
getDatabase()
.
public void setDataQuery(String dataQuery)
dataQuery
- the SQL query for data.public int columns(int row)
SourceArray2D
columns
in interface SourceArray2D
row
- the row to test.
public void dispose()
SourceArray2D
dispose
in interface SourceArray2D
public <T> T get(Class<T> pcls, int row, int column) throws UnsupportedConversionException
SourceArray2D
get
in interface SourceArray2D
T
- the target class.pcls
- the target class.row
- the row index.column
- the column index.
UnsupportedConversionException
public void init()
init
in interface SourceArray2D
public int rows()
SourceArray2D
rows
in interface SourceArray2D
public void addDatabase(DBConnectionParam dbParams1)
public Element toElement(ClassFinder finder, Node parent, String elementName, int spc)
StorableParam
Element
instance with name elementName and add it to the
node parent of the DOM tree. It is recommended to use
DOMUtils
helper methods for this. After the element is created,
attributes can be set and nested contents can be added. The configured DOM
element is then returned.
toElement
in interface StorableParam
finder
- the class finder used to format class names.parent
- the parent of the new element.elementName
- the name of the constructed element.spc
- the number of spaces for each indentation level.
public DBSourceArray2D clone()
clone
in class Object
public String getElementName()
SourceArray2D
getElementName
in interface SourceArray2D
|
ContactCenters V. 0.9.9. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |