io.odysz.module.xtable

Class XMLTable

java.lang.Object

io.odysz.module.xtable.XMLTable

public class XMLTable
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XMLTable.IMapValue
static interface	XMLTable.IParser<T extends XMLTable.IMapValue>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_tableID
protected HashMap<String,Integer>	columns
protected String[]	currentRec
static int	duplicateIgnor If pk is duplicating, merging record is ignored.
static int	duplicateReplace If pk is duplicating, this obj's record is replaced with merging.
protected HashMap<String,Integer>	pkCols
protected ArrayList<String[]>	rows

Constructor Summary

Constructors

Constructor and Description
XMLTable(HashMap<String,Integer> fromColumns, HashMap<String,Integer> fromPkCols, ArrayList<ArrayList<Object>> fromList) This can be used to clone from FLResultset. Becareful, the cols and rows indexes in result set start at 1, but in XMLTable that start at 0! All columns and rows idxes are -1.
XMLTable(String tableID, HashMap<String,Integer> fromColumns, HashMap<String,Integer> fromPkCols) Constructing an empty table, table structure value copied from parameters.
XMLTable(String newTableID, HashMap<String,Integer> fromColumns, HashMap<String,Integer> fromPkCols, ArrayList<String[]> fromList) value copy and construct a new table, according to parameters.
XMLTable(String tableID, String cols, String pk, ILogger log) Construct an empty table according to cols and pk. Table construction not finished without calling endTablePush().

Method Summary

Modifier and Type	Method and Description
protected void	appendFieldValue(int colIdx, String fieldValue)
protected void	appendFieldValue(String colName, String fieldValue)
void	appendRow(HashMap<String,String> row)
XMLTable	beforeFirst()
void	cloneCol(String newName, String oldName) Clone a column index for id reference. Sometimes the E2Engine will refere to a fixed name field to retrieve data, e.g.
void	end()
protected void	endRecordPush(boolean checkPK) Push the temp record into table rows.
XMLTable	endTablePush()
ArrayList<String[]>	findRecords(HashMap<String,String> kv)
XMLTable	findRecordsTable(HashMap<String,String> pkVals)
String	getAttribute(String attr, String defaultVal)
boolean	getBool(String colName, boolean defaultVal)
HashMap<String,Integer>	getColumns()
float	getFloat(String colName, float defaultVal)
float[]	getFloats(String colName, float defaultVal)
int	getInt(int col, int defaultVal)
int	getInt(String colName)
int	getInt(String colName, int defaultVal)
int	getIntAt(int row, int col, int defaultVal)
int	getIntAt(int row, String colName, int defaultVal)
int[]	getInts(String colName, int defaultVal)
HashMap<String,Integer>	getPKs()
String[]	getRecordByPK(String[] pkVals) Find record according to pk values.
String[]	getRow()
String[]	getRowAt(int position)
int	getRowCount()
int	getRowIdx()
ArrayList<String[]>	getRows()
String[]	getRows(String colName)
String	getString(int col)
String	getString(String colName)
String	getStringAt(int row, String colName)
String[]	getStrings(String colName)
String	getTableID()
boolean	goAt(int position)
void	insertRowAt(int rowIdx, HashMap<String,String> row)
void	last() go last record - getXXX(c) got last row's field.
<T extends XMLTable.IMapValue> HashMap<String,T>	map(XMLTable.IParser<T> parser)
void	mergeWith(XMLTable withTable, int duplicateMode) Merge withTable to this object. Table name and colomns order can be different, but both table must have exactly the same columns and pk fields. Note: This method is not suitable for large record's number.
boolean	next()
boolean	previous()
void	remove(HashMap<String,String> kv)
void	setField(String colName, String val)
void	setXmlAttrs(Attributes attributes)
protected void	startRecordPush()
void	startTablePush()

Methods inherited from class java.lang.Object

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

Field Detail

_tableID

protected String _tableID

columns

protected HashMap<String,Integer> columns

pkCols

protected HashMap<String,Integer> pkCols

rows

protected ArrayList<String[]> rows

currentRec

protected String[] currentRec

duplicateIgnor

public static final int duplicateIgnor

If pk is duplicating, merging record is ignored.

See Also:

Constant Field Values

duplicateReplace

public static final int duplicateReplace

If pk is duplicating, this obj's record is replaced with merging.

See Also:

Constant Field Values

Constructor Detail

XMLTable

public XMLTable(String tableID,
                String cols,
                String pk,
                ILogger log)
         throws SAXException

Construct an empty table according to cols and pk.
Table construction not finished without calling endTablePush().

Parameters:

tableID -

cols -

pk -

Throws:

Exception

SAXException

XMLTable

public XMLTable(String tableID,
                HashMap<String,Integer> fromColumns,
                HashMap<String,Integer> fromPkCols)

Constructing an empty table, table structure value copied from parameters. Table construction not finished without calling endTablePush(). This is useful for reduced rows and cols table copying.

Parameters:

tableID -

fromColumns -

fromPkCols -

XMLTable

public XMLTable(String newTableID,
                HashMap<String,Integer> fromColumns,
                HashMap<String,Integer> fromPkCols,
                ArrayList<String[]> fromList)

value copy and construct a new table, according to parameters.

Parameters:

newTableID -

fromColumns -

fromPkCols -

fromList -

XMLTable

public XMLTable(HashMap<String,Integer> fromColumns,
                HashMap<String,Integer> fromPkCols,
                ArrayList<ArrayList<Object>> fromList)

This can be used to clone from FLResultset.
Becareful, the cols and rows indexes in result set start at 1, but in XMLTable that start at 0!
All columns and rows idxes are -1.

Parameters:

fromColumns -

fromPkCols -

fromList -

Method Detail

appendFieldValue

protected void appendFieldValue(String colName,
                                String fieldValue)
                         throws SAXParseException

Throws:

SAXParseException

appendFieldValue

protected void appendFieldValue(int colIdx,
                                String fieldValue)
                         throws SAXParseException

Throws:

SAXParseException

startRecordPush

protected void startRecordPush()
                        throws SAXParseException

Throws:

SAXParseException

endRecordPush

protected void endRecordPush(boolean checkPK)
                      throws SAXParseException

Push the temp record into table rows. For data validation, checkPK shall be true. But it's a serious performance defect. Set checkPK to false when deploying a release version.

Parameters:

checkPK -

Throws:

SAXParseException

getRecordByPK

public String[] getRecordByPK(String[] pkVals)
                       throws SAXParseException

Find record according to pk values. pkVals is exactly the same order specified in xmlfile/table pk attribute.
IMPORTANT: There are no index or any other performance facilities, be careful!

Parameters:

pkVals -

Returns:

target record

Throws:

SAXParseException

startTablePush

public void startTablePush()

endTablePush

public XMLTable endTablePush()

beforeFirst

public XMLTable beforeFirst()
                     throws SAXException

Throws:

SAXException

last

public void last()
          throws SAXException

go last record - getXXX(c) got last row's field.

Throws:

SAXException

next

public boolean next()
             throws SAXException

Throws:

SAXException

goAt

public boolean goAt(int position)
             throws SAXException

Throws:

SAXException

end

public void end()
         throws SAXException

Throws:

SAXException

previous

public boolean previous()
                 throws SAXException

Throws:

SAXException

getRow

public String[] getRow()
                throws SAXException

Throws:

SAXException

getString

public String getString(int col)
                 throws SAXException

Parameters:

col - start from 0.

Returns:

target field value

Throws:

SAXException

getString

public String getString(String colName)
                 throws SAXException

Throws:

SAXException

getStringAt

public String getStringAt(int row,
                          String colName)
                   throws SAXException

Throws:

SAXException

getTableID

public String getTableID()

getRowCount

public int getRowCount()

getRowIdx

public int getRowIdx()

findRecords

public ArrayList<String[]> findRecords(HashMap<String,String> kv)
                                throws SAXException

Parameters:

kv - - [key = colname, val = fieldVal]

Returns:

record list

Throws:

SAXException

findRecordsTable

public XMLTable findRecordsTable(HashMap<String,String> pkVals)
                          throws SAXException

Parameters:

pkVals - - [key = colname, val = fieldVal]

Returns:

target table

Throws:

SAXException

getRowAt

public String[] getRowAt(int position)
                  throws SAXException

Throws:

SAXException

getColumns

public HashMap<String,Integer> getColumns()

getPKs

public HashMap<String,Integer> getPKs()

cloneCol

public void cloneCol(String newName,
                     String oldName)
              throws SAXException

Clone a column index for id reference.
Sometimes the E2Engine will refere to a fixed name field to retrieve data, e.g. "itemId".

Parameters:

newName -

oldName -

Throws:

SAXException

getRows

public ArrayList<String[]> getRows()

getRows

public String[] getRows(String colName)
                 throws SAXException

Throws:

SAXException

getInt

public int getInt(String colName,
                  int defaultVal)

getInt

public int getInt(String colName)
           throws SAXException

Throws:

SAXException

getInt

public int getInt(int col,
                  int defaultVal)

getIntAt

public int getIntAt(int row,
                    String colName,
                    int defaultVal)

getIntAt

public int getIntAt(int row,
                    int col,
                    int defaultVal)

getBool

public boolean getBool(String colName,
                       boolean defaultVal)

getStrings

public String[] getStrings(String colName)
                    throws SAXException

Throws:

SAXException

getFloat

public float getFloat(String colName,
                      float defaultVal)

getFloats

public float[] getFloats(String colName,
                         float defaultVal)
                  throws SAXException

Throws:

SAXException

getInts

public int[] getInts(String colName,
                     int defaultVal)
              throws SAXException

Throws:

SAXException

setXmlAttrs

public void setXmlAttrs(Attributes attributes)

getAttribute

public String getAttribute(String attr,
                           String defaultVal)

setField

public void setField(String colName,
                     String val)
              throws SAXException

Throws:

SAXException

mergeWith

public void mergeWith(XMLTable withTable,
                      int duplicateMode)
               throws SAXException

Merge withTable to this object.
Table name and colomns order can be different, but both table must have exactly the same columns and pk fields.
Note:
This method is not suitable for large record's number. There is a performance problem, especially when both table has many duplicated records. xTable is not designed for DB functioning, it's designed for retrieve data such as App configurations.

Parameters:

withTable -

duplicateMode - one of duplicateIgnor and duplicateReplace

Throws:

SAXException

appendRow

public void appendRow(HashMap<String,String> row)
               throws SAXException

Throws:

SAXException

insertRowAt

public void insertRowAt(int rowIdx,
                        HashMap<String,String> row)
                 throws SAXException

Throws:

SAXException

remove

public void remove(HashMap<String,String> kv)
            throws SAXException

Throws:

SAXException

map

public <T extends XMLTable.IMapValue> HashMap<String,T> map(XMLTable.IParser<T> parser)
                                                     throws SAXException,
                                                            SemanticException

Throws:

SAXException

SemanticException