com.psec.excel

Class ReadExcelRecord

java.lang.Object

com.psec.excel.ReadExcelRecord

Direct Known Subclasses:

DemoExcel.ReadCounts

public abstract class ReadExcelRecord
extends java.lang.Object

The ReadExcelRecord class in combination with the ReadExcelFile class method readExcel or readExcelSmart is used to iterate through a Workbook sheet.

The class is extended with a specific class that is passed into the readExcel or readExcelSmart method.

As each cell of each row that is traversed is processed the canAccept method is called. If accepted the record is added, along with referenced columns translated into fields contained in the extended class definition, to the output set returned by the readExcel or readExcelSmart method.

See Also:

ReadExcelFile class, readExcel method, readExcelSmart method

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ReadExcelRecord.Note Used internally in the WriteExcel clone operation

Field Summary

Fields

Modifier and Type	Field and Description
ReadExcelFile.ColMap	oCM The column map for record set
Row	oRow The Row containing the columns.

Constructor Summary

Constructors

Constructor and Description
ReadExcelRecord()

Method Summary

Modifier and Type	Method and Description
boolean	canAccept() This function can be changed to be selective as to what rows are included in the Row set.
abstract java.lang.String[]	getColMap() The ColMap string definition is returned.

Methods inherited from class java.lang.Object

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

Field Detail

oCM

public ReadExcelFile.ColMap oCM

The column map for record set

oRow

public Row oRow

The Row containing the columns.

Constructor Detail

ReadExcelRecord

public ReadExcelRecord()

Method Detail

getColMap

public abstract java.lang.String[] getColMap()

The ColMap string definition is returned.

The ColMap is an array of strings. Each string describes a group of cells that are mapped into the fields of the extended ReadExcelRecord instance.

The format of each string is

n1=field1;n2=field2;....;nn=fieldn

where

• nx - the absolute column number relative to 0
• fieldx - the field within ReadExcelRecord to populate with the value
• ; - separates each fild definition

Typically each set of fields is separated by a "/" so the example creates 3 columns (1, 7, 13) on each row where values are inspected.

"1=fldA;2=fldB;4=fldC/5=fldA;6=fldB;8=fldC/13=fldA;14=fldB;16=fldC".split("/");

canAccept

public boolean canAccept()
                  throws java.lang.Exception

This function can be changed to be selective as to what rows are included in the Row set.

Throws:

java.lang.Exception