com.irisel.oms.olapi.beans
Interface InstanceSet

All Known Implementing Classes:

DataInstanceSet, DBInstanceSet

public interface InstanceSet

Author:

Jose Manuel Gomez

Method Summary

boolean	absolute(int row)
void	close() frees resources (closes the result set)
void	copyMetadataFrom(DataInstance di)
void	copyMetadataTo(DataInstance di)
boolean	first() rewinds to the first record
java.lang.String	getClassname() Returns the classname
java.lang.String[]	getClassnames() Returns the classname for each field If implemented, useful for views.
Instance	getCurrentInstance()
java.sql.Date	getDate(int i)
java.sql.Date	getDate(java.lang.String field)
Instance	getInstance(int row) Returns row by index.
int	getInstanceCount()
Instance[]	getInstances()
int	getInteger(int i)
int	getInteger(java.lang.String field)
long	getLong(int i)
long	getLong(java.lang.String field)
java.lang.String[]	getNames()
java.lang.String[]	getOriginalPropertyNames() For views, where the original name can be aliased
int	getRow()
java.lang.String	getString(int i)
java.lang.String	getString(java.lang.String field)
java.lang.String	getType()
java.lang.Object	getValue(int column)
java.lang.Object	getValue(int row, int col) Obtain the value for a row and column index
java.lang.Class	getValueClass(int column) The class for a given column
java.lang.Class[]	getValueClasses()
java.lang.String	getValueClassName(int column) The class name for a given column
java.lang.String[]	getValueClassNames()
java.lang.Object[][]	getValues()
java.lang.Object[]	getValues(int row)
java.lang.Object[]	getValuesByColumn(int col)
java.lang.Object[]	getValuesByColumn(java.lang.String colname)
boolean	last() rewinds to the last record
boolean	next() moves one position down the resultset
void	setClassname(java.lang.String string)
void	setValues(java.lang.Object[][] data)
java.lang.String	toJSON()
JSONObject	toJSONObject()

Method Detail

getClassname

java.lang.String getClassname()

Returns the classname

Returns:

getClassnames

java.lang.String[] getClassnames()

Returns the classname for each field If implemented, useful for views.

Returns:

getType

java.lang.String getType()

Returns:

the type (DM.TYPE_TABLE, DM.TYPE_VIEW)

getInstanceCount

int getInstanceCount()

Returns:

the size of the resultset

getCurrentInstance

Instance getCurrentInstance()

Returns:

the current instance

getInstance

Instance getInstance(int row)

Returns row by index. First row is 0.

Parameters:

row - index of the record to get

Returns:

getInstances

Instance[] getInstances()

Returns:

all instances as array

getNames

java.lang.String[] getNames()

Returns:

Array of strings of the field names

getOriginalPropertyNames

java.lang.String[] getOriginalPropertyNames()

For views, where the original name can be aliased

Returns:

Array of original names of fields

getValue

java.lang.Object getValue(int row,
                          int col)

Obtain the value for a row and column index

Parameters:

row -

col -

Returns:

the value for a row and column index

getValues

java.lang.Object[] getValues(int row)

Parameters:

row - index of the row

Returns:

getValuesByColumn

java.lang.Object[] getValuesByColumn(int col)

Parameters:

col - index of the column

Returns:

getValuesByColumn

java.lang.Object[] getValuesByColumn(java.lang.String colname)

Parameters:

colname -

Returns:

the values for a column

getValues

java.lang.Object[][] getValues()

Returns:

all values as a bidimensional array

getValueClass

java.lang.Class getValueClass(int column)

The class for a given column

Parameters:

column - index of the column

Returns:

getValueClassName

java.lang.String getValueClassName(int column)

The class name for a given column

Parameters:

column - index of the column

Returns:

getValueClasses

java.lang.Class[] getValueClasses()

Returns:

the Java classes for the values

getValueClassNames

java.lang.String[] getValueClassNames()

Returns:

the Java class names for the values

first

boolean first()

rewinds to the first record

Returns:

true if success

last

boolean last()

rewinds to the last record

Returns:

true if success

next

boolean next()

moves one position down the resultset

Returns:

true if not at the end of the resultset

getRow

int getRow()

Returns:

the current row

close

void close()

frees resources (closes the result set)

getValue

java.lang.Object getValue(int column)

Parameters:

column - index to get value for

Returns:

value for the column index

absolute

boolean absolute(int row)

Returns:

copyMetadataTo

void copyMetadataTo(DataInstance di)

Parameters:

di - destination to copy metadata to.

copyMetadataFrom

void copyMetadataFrom(DataInstance di)

Parameters:

di - source to copy data from

setValues

void setValues(java.lang.Object[][] data)

Parameters:

data - values to set

setClassname

void setClassname(java.lang.String string)

Parameters:

string - name of the class

toJSONObject

JSONObject toJSONObject()

Returns:

JSONObject map representation of the records

toJSON

java.lang.String toJSON()

Returns:

JSON String representation of the records

getString

java.lang.String getString(int i)

getInteger

int getInteger(int i)

getLong

long getLong(int i)

getDate

java.sql.Date getDate(int i)

getString

java.lang.String getString(java.lang.String field)

getInteger

int getInteger(java.lang.String field)

getLong

long getLong(java.lang.String field)

getDate

java.sql.Date getDate(java.lang.String field)