sapphire.tagext

Class QueryTagInfo

java.lang.Object

com.labvantage.sapphire.BaseClass

sapphire.tagext.BaseTagInfo

sapphire.tagext.QueryTagInfo

public class QueryTagInfo
extends BaseTagInfo

Supports query tag information access

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
QueryTagInfo(com.labvantage.sapphire.tagext.QueryData querydata) Default constructor

Method Summary

Modifier and Type	Method and Description
int	findRow(java.lang.String find) Returns the row number of the first row found matching a specified find String.
java.math.BigDecimal	getBigDecimal(int row, java.lang.String columnid) Get a BigDecimal value from a Numeric column.
java.math.BigDecimal	getBigDecimal(java.lang.String columnid) Get a BigDecimal value from a Numeric column for the current row.
java.util.Calendar	getCalendar(int row, java.lang.String columnid) Get a Calendar object from a Date column.
java.util.Calendar	getCalendar(java.lang.String columnid) Get a Calendar object from a Date column for the current row.
int	getColumnCount() Returns the number of columns.
int	getCurrentCol() Returns the current column number.
java.lang.String	getCurrentColId() Returns the current column ID
int	getCurrentRow() Returns the current row number.
int	getInt(int row, java.lang.String columnid) Get an int value from a Numeric column.
int	getInt(java.lang.String columnid) Get an int value from a Numeric column for the current row.
java.lang.Object	getObject(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 columnid) Returns an object containing the String, BigDecimal or Calendar for the current row.
int	getRowCount() Returns the number of rows.
java.lang.String	getString(int row, java.lang.String columnid) Get a string value from a String column.
java.lang.String	getString(java.lang.String columnid) Get a string value from a String column for the current row.
java.lang.String	getValue(int col) Returns a String representing the value for the specified column, independant of column type.
java.lang.String	getValue(int row, int col) Returns a String representing the value for the specified row / column, independant of column type.
java.lang.String	getValue(int row, java.lang.String columnid) Returns a String representing the value for the specified row / column, independant of column type.
java.lang.String	getValue(java.lang.String columnid) Returns a String representing the value for the current row, independant of column type.

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

QueryTagInfo

public QueryTagInfo(com.labvantage.sapphire.tagext.QueryData querydata)

Default constructor

Parameters:

querydata - data set from query

Method Detail

getRowCount

public int getRowCount()

Returns the number of rows.

Returns:

the number of rows.

getCurrentRow

public int getCurrentRow()

Returns the current row number.

Returns:

the current row number.

getColumnCount

public int getColumnCount()

Returns the number of columns.

Returns:

the number of columns.

getCurrentCol

public int getCurrentCol()

Returns the current column number.

Returns:

the current column number.

getCurrentColId

public java.lang.String getCurrentColId()

Returns the current column ID

Returns:

the current column ID

getObject

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

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

Parameters:

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(int row,
                                  java.lang.String columnid)

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

Parameters:

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 columnid)

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

Parameters:

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(int col)

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

Parameters:

col - 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(int row,
                                 java.lang.String columnid)

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

Parameters:

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.

getValue

public java.lang.String getValue(int row,
                                 int col)

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

Parameters:

row - the row containing the required value.

col - 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.

getInt

public int getInt(java.lang.String columnid)

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

Parameters:

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

Returns:

the int value.

getInt

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

Get an int value from a Numeric column.

Parameters:

row - the row containing the required value.

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

Returns:

the int value.

getString

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

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

Parameters:

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

Returns:

the String value.

getString

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

Get a string value from a String column.

Parameters:

row - the row containing the required value.

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

Returns:

the String value.

getBigDecimal

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

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

Parameters:

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

Returns:

the BigDecimal value.

getBigDecimal

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

Get a BigDecimal value from a Numeric column.

Parameters:

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 columnid)

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

Parameters:

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

Returns:

the Calendar.

getCalendar

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

Get a Calendar object from a Date column.

Parameters:

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 find)

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

Parameters:

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

Returns:

the row number of the first matching row.