|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IList
This interface defines the IList object that is used throughout Content Server for database queries and other representations of tabular data.
Individuals may choose to implement this for custom application purposes. Also, in order to create a custom list object that is accessible through the ICS object or the XML scripting language, you have to implement this interface.
Field Summary | |
---|---|
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. |
Method Summary | |
---|---|
boolean |
atEnd() Return whether this list is at the last row (at the end) of the rows of data. |
IList |
clone(java.lang.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). |
java.lang.String |
getColumnName(int i) Retrieves the name of the column at an offset, counting from 0 (zero). |
byte[] |
getFileData(java.lang.String columname) Returns the data contained in a referenced data file. |
java.lang.String |
getFileString(java.lang.String columname) Returns the string data contained in a referenced data file. |
java.lang.String |
getIndirectColumnName(int index) Supply the upload column by index; this is normally only used by internal IPS generates list objects for url columns ie upload datasource columns. |
java.lang.String |
getName() Retrieves the name of this list. |
java.lang.Object |
getObject(java.lang.String colname) Get an object from the specified column for the current row. |
java.lang.String |
getValue(java.lang.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(java.lang.String newname) Allow the renaming of a list |
boolean |
stringInList(java.lang.String item) Internal CS function; 1 column lists may choose to implement whether a given value is in any row. |
Field Detail |
---|
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.
Method Detail |
---|
java.lang.String getName()
boolean hasData()
int numColumns()
int currentRow()
Rows begin numbering from one.
java.lang.String getValue(java.lang.String columname) throws java.lang.NoSuchFieldException
columname
- The name of the column to get the results for.java.lang.NoSuchFieldException
java.lang.Object getObject(java.lang.String colname) throws java.lang.NoSuchFieldException
The type of data stored in the list is implementation-specific. For example, if the list represents a database query, the object returned will be null unless the column represents a byte array. Other lists may return particular types
java.lang.NoSuchFieldException
byte[] getFileData(java.lang.String columname) throws java.lang.IllegalArgumentException, java.lang.NoSuchFieldException
columname
- The name of the column.java.lang.IllegalArgumentException
- if the column is not an indirect columnjava.lang.NoSuchFieldException
- if the field is invalidjava.lang.String getFileString(java.lang.String columname) throws java.lang.NoSuchFieldException
columname
- The name of the column.java.lang.NoSuchFieldException
- if the column is not an indirect data typevoid flush()
java.lang.String getColumnName(int i) throws java.lang.ArrayIndexOutOfBoundsException
i
- The offset column number.java.lang.ArrayIndexOutOfBoundsException
int numRows()
USE WITH CARE. If the list represents uncached data in a database, a large delay and high memory useage might be encountered as the list must be scanned ON THE DATABASE SIDE to determine the count.
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()
java.lang.String getIndirectColumnName(int index)
IList clone(java.lang.String newname)
A user-defined implementation may decide to provide a deep copy.
void rename(java.lang.String newname)
IList.getName()
boolean stringInList(java.lang.String item)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.