|
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.ExcelSourceArray2D
public class ExcelSourceArray2D
Represents a source array whose contents is read from a Microsoft Excel workbook. Each row of the sheet with the given name, and contained in the workbook pointed to by a URL becomes a row of the source array, with elements of the row separated using commas. Data is read using JExcel API.
In the XML file, the URL attribute of an element representing a Excel source array must be used to indicate the URL of the data file. The sheetName attribute can also be used to indicate the name of a sheet. By default, the first sheet is read.
Constructor Summary | |
---|---|
ExcelSourceArray2D()
|
Method Summary | ||
---|---|---|
static void |
clearCache()
|
|
ExcelSourceArray2D |
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. |
|
String |
getElementName()
Returns the name of the XML element representing the type of source array implemented. |
|
String |
getSheetName()
Returns the name of the sheet to extract data from. |
|
URL |
getURL()
Returns the URL of the text file containing the values of the array, in CSV format. |
|
void |
init()
Initializes the source array. |
|
int |
rows()
Returns the number of rows in the source array. |
|
void |
setSheetName(String sheetName)
Sets the sheet name to sheetName. |
|
void |
setURL(URL url)
Sets the URL pointing to the CSV file containing the elements of this array to url. |
|
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 ExcelSourceArray2D()
Method Detail |
---|
public URL getURL()
public void setURL(URL url)
url
- the URL of the data.public String getSheetName()
public void setSheetName(String sheetName)
sheetName
- the sheet name.public int columns(int row)
SourceArray2D
columns
in interface SourceArray2D
row
- the row to test.
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()
SourceArray2D
init
in interface SourceArray2D
public int rows()
SourceArray2D
rows
in interface SourceArray2D
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 void dispose()
SourceArray2D
dispose
in interface SourceArray2D
public ExcelSourceArray2D clone()
clone
in class Object
public String getElementName()
SourceArray2D
getElementName
in interface SourceArray2D
public static void clearCache()
|
ContactCenters V. 0.9.9. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |