com.cs.software.engine.datastore

Class DataView

java.lang.Object

com.cs.software.engine.datastore.DataView

public class DataView
extends Object

ObjectStorage manages a ResultSet returned from a query against a table. It maintains the table Values read from a table can be written in XML with a variant of getXmlData and CSV format with getCSVData. A java.text.Format object can be attached to any field, to format the field when it is written.

ObjectStorage caches a ResultSet by tag. This tag, and row/column indexes can be passed in to a variant of getField to read a value from the ResultSet. The number of rows in the ResultSet is available with getRowCount.

Field Summary

Fields

Modifier and Type	Field and Description
protected Hashtable<String,DataIntf>	dataFields
protected List<Map<String,Object>>	dataMapList
protected boolean	errors
protected MetadataIntf	metadata

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataView()
	DataView(MetadataIntf aMetadata)

Method Summary

Modifier and Type	Method and Description
void	addField(TypeDBIntf aTypeDB)
void	addField(TypeIntf aType)
void	clearTableData()
void	deleteField(String aFieldName)
void	deleteRows(int aStart, int aNum)
String	getClassName()
TypeBaseIntf	getColType(int aCol)
TypeBaseIntf	getColType(String aColName)
String	getColumnName(int rowNum) Will return the name of the column based on an index number of the result set
String	getCSVData()
Enumeration<DataIntf>	getData()
DataIntf	getData(int aCol)
DataIntf	getData(String aFieldName)
DataIntf	getData(TypeBaseIntf aType)
Map<String,Object>	getDataMap(int aRow)
void	getDataMap(int aRow, Map<String,Object> aDatabaseRecord)
Map<String,Object>	getDataMapNoneNull(int aRow)
Map<String,String>	getDataMapStr(int aRow)
int	getDefError()
Object	getField(int aRow, int aCol)
Object	getField(int aRow, String aFieldName)
BigDecimal[]	getFieldDataBigDecimal(String aFieldName)
boolean[]	getFieldDataBoolean(String aFieldName)
char[]	getFieldDataChar(String aFieldName)
Date[]	getFieldDataDate(String aFieldName)
double[]	getFieldDataDouble(String aFieldName)
float[]	getFieldDataFloat(String aFieldName)
int[]	getFieldDataInt(String aFieldName)
long[]	getFieldDataLong(String aFieldName)
short[]	getFieldDataShort(String aFieldName)
String[]	getFieldDataString(String aFieldName)
String	getFieldStr(int aRow, int aCol)
String	getFieldStr(int aRow, String aFieldName)
String	getJSONData(String aLabelField)
MetadataIntf	getMetadata()
boolean	getNew(int aRow)
int	getNumberFields()
int	getRowCount()
String	getXmlData()
String	getXmlData(String aRowTag)
String	getXmlData(String aRowTag, int startRow, int numOfRows)
String	getXmlData(String aRootTag, String aRowTag)
String	getXmlData(String aRowTag, String aFilterTag, String aFilterValue)
String	getXmlDataGLxxx(String aRowTag, Map<String,String> aData)
void	init()
boolean	isNull(int aRow, int aCol)
boolean	isNull(int aRow, String aFieldName)
void	setAction(int aRow, int aAction)
void	setDataMap(Map<String,Object> aData)
int	setField(int aRow, int aCol, Object aValue)
int	setField(int aRow, int aCol, String aValue)
int	setField(int aRow, String aFieldName, Object aValue)
int	setField(int aRow, String aFieldName, String aValue)
void	setFieldFormat(int aCol, Format aFormat)
void	setFieldFormat(String aFieldName, Format aFormat)
protected void	setMetadata(MetadataIntf aMetadata)
void	setNew(int aRow, boolean aFlag)
void	writeCSVData(Writer aWriter)
void	writeXmlData(Writer aWriter, String aRowTag)
void	writeXmlRootBottom(Writer aWriter, String aRootTag)
void	writeXmlRootTop(Writer aWriter, String aRootTag)

Methods inherited from class java.lang.Object

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

Field Detail

dataMapList

protected List<Map<String,Object>> dataMapList

metadata

protected MetadataIntf metadata

errors

protected boolean errors

dataFields

protected Hashtable<String,DataIntf> dataFields

Constructor Detail

DataView

protected DataView()

DataView

public DataView(MetadataIntf aMetadata)

Method Detail

setMetadata

protected void setMetadata(MetadataIntf aMetadata)

deleteField

public void deleteField(String aFieldName)

addField

public void addField(TypeIntf aType)
              throws ClassNotFoundException

Throws:

ClassNotFoundException

addField

public void addField(TypeDBIntf aTypeDB)
              throws ClassNotFoundException

Throws:

ClassNotFoundException

init

public void init()

clearTableData

public void clearTableData()

getMetadata

public MetadataIntf getMetadata()

setAction

public void setAction(int aRow,
                      int aAction)

deleteRows

public void deleteRows(int aStart,
                       int aNum)
                throws Exception

Throws:

Exception

getClassName

public String getClassName()

getNumberFields

public int getNumberFields()

getColType

public TypeBaseIntf getColType(int aCol)

getColType

public TypeBaseIntf getColType(String aColName)

setFieldFormat

public void setFieldFormat(String aFieldName,
                           Format aFormat)

setFieldFormat

public void setFieldFormat(int aCol,
                           Format aFormat)

getData

public Enumeration<DataIntf> getData()

getData

public DataIntf getData(String aFieldName)

getData

public DataIntf getData(int aCol)

getData

public DataIntf getData(TypeBaseIntf aType)

getRowCount

public int getRowCount()

getXmlData

public String getXmlData()

getXmlData

public String getXmlData(String aRootTag,
                         String aRowTag)

getXmlData

public String getXmlData(String aRowTag,
                         int startRow,
                         int numOfRows)

getJSONData

public String getJSONData(String aLabelField)

getXmlData

public String getXmlData(String aRowTag)

getXmlDataGLxxx

public String getXmlDataGLxxx(String aRowTag,
                              Map<String,String> aData)

getXmlData

public String getXmlData(String aRowTag,
                         String aFilterTag,
                         String aFilterValue)

writeXmlRootTop

public void writeXmlRootTop(Writer aWriter,
                            String aRootTag)
                     throws IOException

Throws:

IOException

writeXmlRootBottom

public void writeXmlRootBottom(Writer aWriter,
                               String aRootTag)
                        throws IOException

Throws:

IOException

writeXmlData

public void writeXmlData(Writer aWriter,
                         String aRowTag)
                  throws IOException

Throws:

IOException

getCSVData

public String getCSVData()

writeCSVData

public void writeCSVData(Writer aWriter)
                  throws IOException

Throws:

IOException

getDataMap

public Map<String,Object> getDataMap(int aRow)

getDataMapNoneNull

public Map<String,Object> getDataMapNoneNull(int aRow)

getDataMapStr

public Map<String,String> getDataMapStr(int aRow)

getDataMap

public void getDataMap(int aRow,
                       Map<String,Object> aDatabaseRecord)

getFieldDataBoolean

public boolean[] getFieldDataBoolean(String aFieldName)

getFieldDataChar

public char[] getFieldDataChar(String aFieldName)

getFieldDataDate

public Date[] getFieldDataDate(String aFieldName)

getFieldDataDouble

public double[] getFieldDataDouble(String aFieldName)

getFieldDataBigDecimal

public BigDecimal[] getFieldDataBigDecimal(String aFieldName)

getFieldDataFloat

public float[] getFieldDataFloat(String aFieldName)

getFieldDataShort

public short[] getFieldDataShort(String aFieldName)

getFieldDataLong

public long[] getFieldDataLong(String aFieldName)

getFieldDataInt

public int[] getFieldDataInt(String aFieldName)

getFieldDataString

public String[] getFieldDataString(String aFieldName)

isNull

public boolean isNull(int aRow,
                      String aFieldName)

isNull

public boolean isNull(int aRow,
                      int aCol)

getField

public Object getField(int aRow,
                       String aFieldName)

getFieldStr

public String getFieldStr(int aRow,
                          String aFieldName)

getField

public Object getField(int aRow,
                       int aCol)

getFieldStr

public String getFieldStr(int aRow,
                          int aCol)

setField

public int setField(int aRow,
                    String aFieldName,
                    String aValue)

setField

public int setField(int aRow,
                    int aCol,
                    String aValue)

setField

public int setField(int aRow,
                    String aFieldName,
                    Object aValue)

setField

public int setField(int aRow,
                    int aCol,
                    Object aValue)

setNew

public void setNew(int aRow,
                   boolean aFlag)

getNew

public boolean getNew(int aRow)

getDefError

public int getDefError()

getColumnName

public String getColumnName(int rowNum)

Will return the name of the column based on an index number of the result set

Parameters:

rowNum - the column index number

Returns:

The name of the field.

setDataMap

public void setDataMap(Map<String,Object> aData)