sapphire.tagext

Class SDITagInfo

java.lang.Object

com.labvantage.sapphire.BaseClass

sapphire.tagext.BaseTagInfo

sapphire.tagext.SDITagInfo

public class SDITagInfo
extends BaseTagInfo

Supports custom tag functions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG_VAR_NAME

Fields inherited from class com.labvantage.sapphire.BaseClass

FAILURE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
SDITagInfo(java.util.HashMap querydatamap) Default constructor

Method Summary

Modifier and Type	Method and Description
int	findRow(java.lang.String dataset, java.lang.String find) Returns the row number of the first row found matching a specified find String.
java.math.BigDecimal	getBigDecimal(java.lang.String dataset, int row, java.lang.String columnid) Get a BigDecimal value from a Numeric column.
java.math.BigDecimal	getBigDecimal(java.lang.String dataset, java.lang.String columnid) Get a BigDecimal value from a Numeric column for the current row.
java.util.Calendar	getCalendar(java.lang.String dataset, int row, java.lang.String columnid) Get a Calendar object from a Date column.
java.util.Calendar	getCalendar(java.lang.String dataset, java.lang.String columnid) Get a Calendar object from a Date column for the current row.
java.lang.Object	getChildTagData(java.lang.String dataname) Internal method, not currently supported.
int	getColumnCount(java.lang.String dataset) Returns the number of columns.
int	getCurrentCol(java.lang.String dataset) Returns the current column number.
java.lang.String	getCurrentColId(java.lang.String dataset) Returns the current column number.
int	getCurrentRow() Returns the current row number for the primary dataset.
int	getCurrentRow(java.lang.String dataset) Returns the current row number.
DataSet	getDataSet(java.lang.String dataset) Returns a sapphire.util.DataSet object for the specified dataset
java.lang.String	getError() Returns any errors that may have been generated, particularly after a "round-trip".
int	getInt(java.lang.String dataset, int row, java.lang.String columnid) Get an int value from a Numeric column.
int	getInt(java.lang.String dataset, java.lang.String columnid) Get an int value from a Numeric column for the current row.
java.lang.String[]	getKeycols()
java.lang.Object	getObject(java.lang.String dataset, int row, java.lang.String columnid) Returns an object containing the String, BigDecimal or Calendar for the specified row / column.
java.lang.Object	getObject(java.lang.String dataset, java.lang.String columnid) Returns an object containing the String, BigDecimal or Calendar for the current row.
PageContext	getPageContext() Returns the original PageContext containing the sdiinfo
com.labvantage.sapphire.tagext.QueryData	getQueryData(java.lang.String dataset) Internal method, not currently supported.
int	getRowCount() Returns the number of rows for the primary dataset.
int	getRowCount(java.lang.String dataset) Returns the number of rows.
java.lang.String	getRowId(java.lang.String dataset) Returns a unique identifier for the row.
java.lang.String	getRowStatus(java.lang.String dataset) Returns the "update" status of the row.
java.lang.String	getSdcid() Returns the sdcid
SDIData	getSDIData() Returns the original SDIData for the data
SDIRequest	getSDIRequest() Returns the original SDIRequest for the data
java.lang.String	getString(java.lang.String dataset, int row, java.lang.String columnid) Get a string value from a String column.
java.lang.String	getString(java.lang.String dataset, java.lang.String columnid) Get a string value from a String column for the current row.
java.lang.String	getValue(java.lang.String dataset, int row, java.lang.String columnid) Returns String SDI query result for specified row
java.lang.String	getValue(java.lang.String dataset, java.lang.String columnid) Returns a String representing the value for the current row, independant of column type.
boolean	isGrouping(java.lang.String dataset) Internal method, not currently supported.
boolean	isTemplateRow() Internal method, not currently supported.
boolean	isTemplateRow(java.lang.String dataset) Internal method, not currently supported.
void	setChildTagData(java.lang.String dataname, java.lang.Object data) Internal method, not currently supported.
void	setDataSet(java.lang.String datasetName, DataSet dataset)
void	setError(java.lang.String error) Internal method.
void	setKeycols(java.lang.String[] keycols)
void	setPageContext(PageContext pageContext) Sets the original PageContext containing the sdiinfo
void	setSdcid(java.lang.String sdcid) Sets the sdcid for the collection of data
void	setSDIData(SDIData sdiData) Sets the original SDIData for the data
void	setSDIRequest(SDIRequest sdiRequest) Sets the original SDIRequest for the data

Methods inherited from class sapphire.tagext.BaseTagInfo

getErrorCodes, getErrorStack, getLastError, setErrorStack

Methods inherited from class java.lang.Object

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

Field Detail

TAG_VAR_NAME

public static final java.lang.String TAG_VAR_NAME

See Also:

Constant Field Values

Constructor Detail

SDITagInfo

public SDITagInfo(java.util.HashMap querydatamap)

Default constructor

Parameters:

querydatamap - maps SDI data

Method Detail

getSDIData

public SDIData getSDIData()

Returns the original SDIData for the data

Returns:

the original SDIData for the data

setSDIData

public void setSDIData(SDIData sdiData)

Sets the original SDIData for the data

Parameters:

sdiData - the original SDIData for the data

getSDIRequest

public SDIRequest getSDIRequest()

Returns the original SDIRequest for the data

Returns:

the original SDIRequest for the data

setSDIRequest

public void setSDIRequest(SDIRequest sdiRequest)

Sets the original SDIRequest for the data

Parameters:

sdiRequest - the original SDIRequest for the data

getPageContext

public PageContext getPageContext()

Returns the original PageContext containing the sdiinfo

Returns:

the original PageContext containing the sdiinfo

setPageContext

public void setPageContext(PageContext pageContext)

Sets the original PageContext containing the sdiinfo

Parameters:

pageContext - the original PageContext containing the sdiinfo

setSdcid

public void setSdcid(java.lang.String sdcid)

Sets the sdcid for the collection of data

Parameters:

sdcid - the sdcid for the collection of data

getSdcid

public java.lang.String getSdcid()

Returns the sdcid

Returns:

the sdcid for the collection of data

setError

public void setError(java.lang.String error)

Internal method. Not currently supported.

getError

public java.lang.String getError()

Returns any errors that may have been generated, particularly after a "round-trip".

Returns:

any errors that may have been generated, particularly after a "round-trip".

getKeycols

public java.lang.String[] getKeycols()

setKeycols

public void setKeycols(java.lang.String[] keycols)

getRowCount

public int getRowCount()

Returns the number of rows for the primary dataset.

Returns:

the number of rows.

getRowCount

public int getRowCount(java.lang.String dataset)

Returns the number of rows.

Parameters:

dataset - the identity (dataset name) of dataset

Returns:

the number of rows.

getCurrentRow

public int getCurrentRow()

Returns the current row number for the primary dataset.

Returns:

the current row number.

getCurrentRow

public int getCurrentRow(java.lang.String dataset)

Returns the current row number.

Parameters:

dataset - the identity (dataset name) of dataset

Returns:

the current row number.

getColumnCount

public int getColumnCount(java.lang.String dataset)

Returns the number of columns.

Parameters:

dataset - the identity (dataset name) of dataset

Returns:

the number of columns.

getCurrentCol

public int getCurrentCol(java.lang.String dataset)

Returns the current column number.

Parameters:

dataset - the identity (dataset name) of dataset

Returns:

the current column number.

getCurrentColId

public java.lang.String getCurrentColId(java.lang.String dataset)

Returns the current column number.

Parameters:

dataset - the identity (dataset name) of dataset

Returns:

the current column number.

getObject

public java.lang.Object getObject(java.lang.String dataset,
                                  java.lang.String columnid)

Returns an object containing the String, BigDecimal or Calendar for the current row.

Parameters:

dataset - the identity (dataset name) of dataset

columnid - the columnid containing the required value.

Returns:

the object (if it exists) otherwise null, or null if an invalid row or column is specified.

getObject

public java.lang.Object getObject(java.lang.String dataset,
                                  int row,
                                  java.lang.String columnid)

Returns an object containing the String, BigDecimal or Calendar for the specified row / column.

Parameters:

dataset - the identity (dataset name) of dataset

row - the row containing the required value.

columnid - the columnid containing the required value.

Returns:

the object (if it exists) otherwise null, or null if an invalid row or column is specified.

getValue

public java.lang.String getValue(java.lang.String dataset,
                                 java.lang.String columnid)

Returns a String representing the value for the current row, independant of column type.

Parameters:

dataset - the identity (dataset name) of dataset

columnid - the column containing the required value (this can be either a String, Number or Date column).

Returns:

String representing the specified value. BigDecimals have their double values formatted using a java.text.NumberFormat class. Calendars are formatted using the java.text.DateFormat class.

getValue

public java.lang.String getValue(java.lang.String dataset,
                                 int row,
                                 java.lang.String columnid)

Returns String SDI query result for specified row

Parameters:

dataset - the identity (dataset name) of dataset

row - the row containing the required value.

columnid - the column containing the required value (this can be either a String, Number or Date column).

Returns:

String representing the specified value. BigDecimals have their double values formatted using a java.text.NumberFormat class. Calendars are formatted using the java.text.DateFormat class.

getString

public java.lang.String getString(java.lang.String dataset,
                                  java.lang.String columnid)

Get a string value from a String column for the current row.

Parameters:

dataset - the identity (dataset name) of dataset

columnid - the column containing the required value (this must be a String column).

Returns:

the String value.

getString

public java.lang.String getString(java.lang.String dataset,
                                  int row,
                                  java.lang.String columnid)

Get a string value from a String column.

Parameters:

dataset - the identity (dataset name) of dataset

row - the row containing the required value.

columnid - the column containing the required value (this must be a String column).

Returns:

the String value.

getInt

public int getInt(java.lang.String dataset,
                  java.lang.String columnid)

Get an int value from a Numeric column for the current row.

Parameters:

dataset - the identity (dataset name) of dataset

columnid - the column containing the required value (this must be a Numeric column).

Returns:

the int value.

getInt

public int getInt(java.lang.String dataset,
                  int row,
                  java.lang.String columnid)

Get an int value from a Numeric column.

Parameters:

dataset - the identity (dataset name) of dataset

row - the row containing the required value.

columnid - the column containing the required value (this must be a Numeric column).

Returns:

the int value.

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String dataset,
                                          java.lang.String columnid)

Get a BigDecimal value from a Numeric column for the current row.

Parameters:

dataset - the identity (dataset name) of dataset

columnid - the column containing the required value (this must be a Numeric column).

Returns:

the BigDecimal value.

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String dataset,
                                          int row,
                                          java.lang.String columnid)

Get a BigDecimal value from a Numeric column.

Parameters:

dataset - the identity (dataset name) of dataset

row - the row containing the required value.

columnid - the column containing the required value (this must be a Numeric column).

Returns:

the BigDecimal value.

getCalendar

public java.util.Calendar getCalendar(java.lang.String dataset,
                                      java.lang.String columnid)

Get a Calendar object from a Date column for the current row.

Parameters:

dataset - the identity (dataset name) of dataset

columnid - the column containing the required value (this must be a Date column).

Returns:

the Calendar.

getCalendar

public java.util.Calendar getCalendar(java.lang.String dataset,
                                      int row,
                                      java.lang.String columnid)

Get a Calendar object from a Date column.

Parameters:

dataset - the identity (dataset name) of dataset

row - the row containing the required value.

columnid - the column containing the required value (this must be a Date column).

Returns:

the Calendar.

findRow

public int findRow(java.lang.String dataset,
                   java.lang.String find)

Returns the row number of the first row found matching a specified find String.

Parameters:

dataset - the identity (dataset name) of dataset

find - comma separated list of find criteria. e.g. "col1=XXX,col2=99,col3=YYY"

Returns:

the row number of the first matching row.

getRowStatus

public java.lang.String getRowStatus(java.lang.String dataset)

Returns the "update" status of the row. All rows are initially set to "S" - indicating that they have been selected. On subsequent "round-trips", the status may have been changed to either "U" to indicate that a database update is required, or "D" to indicate that the row has been deleted. These status chanages either occur automatically in the web page through use of the tag, or manually through use of the sdiSetRowStatus() javascript method.

Parameters:

dataset - the identity (dataset name) of dataset

Returns:

the row status (S, U or D).

getRowId

public java.lang.String getRowId(java.lang.String dataset)

Returns a unique identifier for the row. This unique row identifier will be unique, independant of any sorting, filtering or "round-tripping".

Parameters:

dataset - the identity (dataset name) of dataset

Returns:

the unique row identifier

getDataSet

public DataSet getDataSet(java.lang.String dataset)

Returns a sapphire.util.DataSet object for the specified dataset

Parameters:

dataset - the identity (dataset name) of dataset

Returns:

the DataSet object

isTemplateRow

public boolean isTemplateRow()

Internal method, not currently supported.

isGrouping

public boolean isGrouping(java.lang.String dataset)

Internal method, not currently supported.

isTemplateRow

public boolean isTemplateRow(java.lang.String dataset)

Internal method, not currently supported.

getQueryData

public com.labvantage.sapphire.tagext.QueryData getQueryData(java.lang.String dataset)

Internal method, not currently supported.

setChildTagData

public void setChildTagData(java.lang.String dataname,
                            java.lang.Object data)

Internal method, not currently supported.

getChildTagData

public java.lang.Object getChildTagData(java.lang.String dataname)

Internal method, not currently supported.

setDataSet

public void setDataSet(java.lang.String datasetName,
                       DataSet dataset)