net.windward.datasource.abstract_datasource

Interface IDataSourceResultRow

All Known Implementing Classes:

DataSourceResultRow, JdbcResultRow, JsonResultRow

public interface IDataSourceResultRow

Method Summary

Modifier and Type	Method and Description
FieldResult	getFieldEx(int index, int mode, java.lang.String tagType) Get a field from this row.
FieldResult	getFieldEx(java.lang.String fieldName, int mode, java.lang.String tagType) Get a field from this row.
java.lang.String	getFieldName(int index)
java.lang.String[]	getFieldNames() Get the names of every field in this row (i.e.
java.lang.String	getQuery()
java.lang.String	getUniquePath()
java.lang.Object	getValue(int mode, java.lang.String tagType) Get the value in this result row.

Method Detail

getFieldNames

java.lang.String[] getFieldNames()

Get the names of every field in this row (i.e. column names)

getFieldEx

FieldResult getFieldEx(java.lang.String fieldName,
                       int mode,
                       java.lang.String tagType)
                throws DataSourceException

Get a field from this row. Note that this could return a IDataSourceResultSet in the case of nested objects.

Parameters:

fieldName - The name of the field desired.

mode - One of the BaseTag.MODE_* values.

tagType - The type= value from the tag (BaseTag.TYPE_*, etc.) from the tag calling this. Can be null or the empty string.

Returns:

The requested field.

Throws:

DataSourceException

getValue

java.lang.Object getValue(int mode,
                          java.lang.String tagType)
                   throws DataSourceException

Get the value in this result row. Return null if don't have a value (ie SQL row of data).

Parameters:

mode - One of the BaseTag.MODE_ values.

tagType - The type= value from the tag (BaseTag.TYPE_*, etc.) from the tag calling this. Can be null or the empty string.

Returns:

The value in this result. null if this does not have a value.

Throws:

DataSourceException

getFieldEx

FieldResult getFieldEx(int index,
                       int mode,
                       java.lang.String tagType)
                throws DataSourceException

Get a field from this row. Note that this could return a IDataSourceResultSet in the case of nested objects.

Parameters:

index - the 0-based index of the field requested.

mode - One of the BaseTag.MODE_* values.

tagType - The type= value from the tag (BaseTag.TYPE_*, etc.) from the tag calling this. Can be null or the empty string.

Returns:

The requested field.

Throws:

DataSourceException

getQuery

java.lang.String getQuery()

getUniquePath

java.lang.String getUniquePath()
                        throws DataSourceException

Throws:

DataSourceException

getFieldName

java.lang.String getFieldName(int index)