public interface IList
Modifier and Type | Field and Description |
---|---|
static int |
first
Command indicating that
IList.moveToRow(int, int) should move to the first row. |
static int |
gotorow
Command indicating that
IList.moveToRow(int, int) should move to the specified row. |
static int |
last
Command indicating that
IList.moveToRow(int, int) should move to the last row. |
static int |
next
Command indicating that
IList.moveToRow(int, int) should move to the next row. |
static int |
prev
Command indicating that
IList.moveToRow(int, int) should move to the previous row. |
Modifier and Type | Method and Description |
---|---|
boolean |
atEnd()
Return whether this list is at the last row (at the end) of the rows of data.
|
IList |
clone(String newname)
Normally used internally by CS server to shallow copy a list object; return null from a user defined list object if support isn't implemented or desired.
|
int |
currentRow()
Returns the number of the current row of this list.
|
void |
flush()
Flushes a list object, clearing the resultset from the cache and notifies the rest of the cluster member (if any).
|
String |
getColumnName(int i)
Retrieves the name of the column at an offset, counting from 0 (zero).
|
byte[] |
getFileData(String columname)
Returns the data contained in a referenced data file.
|
String |
getFileString(String columname)
Returns the string data contained in a referenced data file.
|
String |
getIndirectColumnName(int index)
Supplies the upload column by index.
|
String |
getName()
Retrieves the name of this list.
|
Object |
getObject(String colname)
Get an object from the specified column for the current row.
|
String |
getValue(String columname)
Retrieves the value of a named column for the current row.
|
boolean |
hasData()
Checks if the list contains any data.
|
boolean |
moveTo(int i)
Moves the list to a given row number.
|
boolean |
moveToRow(int how, int v)
Move to a new row given a specific command
|
int |
numColumns()
Retrieves the number of columns in the list, excluding indirect columns.
|
int |
numIndirectColumns()
Return a count of columns which are meant to be indirect data pointers; normally only used by internal CS ilist objects so the default implementation for a user-defined ilist should return 0
|
int |
numRows()
Returns the number of rows in a list.
|
void |
rename(String newname)
Allow the renaming of a list
|
boolean |
stringInList(String item)
Internal CS function; 1 column lists may choose to implement whether a given value is in any row.
|
static final int next
IList.moveToRow(int, int)
should move to the next row.static final int prev
IList.moveToRow(int, int)
should move to the previous row.static final int first
IList.moveToRow(int, int)
should move to the first row.static final int last
IList.moveToRow(int, int)
should move to the last row.static final int gotorow
IList.moveToRow(int, int)
should move to the specified row.String getName()
boolean hasData()
int numColumns()
int currentRow()
String getValue(String columname) throws NoSuchFieldException
columname
- The name of the column to get the results for.NoSuchFieldException
- on errorObject getObject(String colname) throws NoSuchFieldException
colname
- The name of the column to get the results for.NoSuchFieldException
- on errorbyte[] getFileData(String columname) throws IllegalArgumentException, NoSuchFieldException
columname
- The name of the column.IllegalArgumentException
- if the column is not an indirect columnNoSuchFieldException
- if the field is invalidString getFileString(String columname) throws NoSuchFieldException
columname
- The name of the column.NoSuchFieldException
- if the column is not an indirect data typevoid flush()
String getColumnName(int i) throws ArrayIndexOutOfBoundsException
i
- The offset column number.ArrayIndexOutOfBoundsException
- on accessing out of array indexint numRows()
boolean moveTo(int i)
i
- The row number, numbered from one.boolean atEnd()
boolean moveToRow(int how, int v)
how
- commandv
- value of the new row if how is IList.gotorow
int numIndirectColumns()
String getIndirectColumnName(int index)
index
- an IntegerIList clone(String newname)
newname
- new namevoid rename(String newname)
newname
- new nameIList.getName()
boolean stringInList(String item)
item
- an Item