railo.runtime.type
Interface Query

All Superinterfaces:

Castable, java.lang.Cloneable, Collection, Dumpable, Iterator, Iteratorable, Query, java.sql.ResultSet, java.io.Serializable

All Known Subinterfaces:

QueryTable

public interface Query

extends Collection, Iterator, Query

inteface for resultset (query) object

Nested Class Summary

Nested classes inherited from class railo.runtime.type.Collection

Collection.Key

Field Summary

static int	ORDER_ASC Constant ORDER_ASC, used for method sort
static int	ORDER_DESC Constant ORDER_DESC, used for method sort

Fields inherited from interface java.sql.ResultSet

CLOSE_CURSORS_AT_COMMIT, CONCUR_READ_ONLY, CONCUR_UPDATABLE, FETCH_FORWARD, FETCH_REVERSE, FETCH_UNKNOWN, HOLD_CURSORS_OVER_COMMIT, TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE

Method Summary

boolean	addColumn(Collection.Key columnName, Array content) adds a new column to the resultset
boolean	addColumn(Collection.Key columnName, Array content, int type) adds a new column to the resultset
boolean	addColumn(java.lang.String columnName, Array content) Deprecated. use instead addColumn(railo.runtime.type.Collection.Key, Array)
boolean	addColumn(java.lang.String columnName, Array content, int type) Deprecated. use instead addColumn(railo.runtime.type.Collection.Key, Array, int)
boolean	addRow(int count) adds a new row to the resultset
java.lang.Object	clone()
int	executionTime()
java.lang.Object	getAt(Collection.Key key, int row) return a value of the resultset by specifed colmn and row
java.lang.Object	getAt(Collection.Key key, int row, java.lang.Object defaultValue) return a value of the resultset by specifed colmn and row, otherwise to getAt this method throw no exception if value dont exist (return null)
java.lang.Object	getAt(java.lang.String key, int row) Deprecated. use instead getAt(railo.runtime.type.Collection.Key, int)
java.lang.Object	getAt(java.lang.String key, int row, java.lang.Object defaultValue) Deprecated. use instead getAt(railo.runtime.type.Collection.Key, int, Object)
QueryColumn	getColumn(Collection.Key key) return the query column matching to key
QueryColumn	getColumn(Collection.Key key, QueryColumn column) return the query column matching to key, if key not exist return null
QueryColumn	getColumn(java.lang.String key) Deprecated. use instead getColumn(railo.runtime.type.Collection.Key)
QueryColumn	getColumn(java.lang.String key, QueryColumn column) Deprecated. use instead getColumn(railo.runtime.type.Collection.Key, QueryColumn)
Array	getMetaDataSimple()
int[]	getTypes()
java.util.Map	getTypesAsMap()
int	getUpdateCount()
boolean	isCached() is query from cache or not
QueryColumn	removeColumn(Collection.Key key) remove column matching to key
QueryColumn	removeColumn(java.lang.String key) Deprecated. use instead removeColumn(railo.runtime.type.Collection.Key)
QueryColumn	removeColumnEL(Collection.Key key) remove column matching to key
QueryColumn	removeColumnEL(java.lang.String key) Deprecated. use instead removeColumnEL(railo.runtime.type.Collection.Key)
int	removeRow(int row) remove row from query
int	removeRowEL(int row) remove row from query
java.lang.Object	setAt(Collection.Key key, int row, java.lang.Object value) set a value at the defined position
java.lang.Object	setAt(java.lang.String key, int row, java.lang.Object value) Deprecated. use instead setAtEL(railo.runtime.type.Collection.Key, int, Object)
java.lang.Object	setAtEL(Collection.Key key, int row, java.lang.Object value) set a value at the defined position
java.lang.Object	setAtEL(java.lang.String key, int row, java.lang.Object value) Deprecated. use instead setAtEL(railo.runtime.type.Collection.Key, int, Object)
void	setCached(boolean isCached) sets if query is form cache or not
void	setExecutionTime(long l) sets the execution Time of the query
void	sort(Collection.Key column) sorts a query by a column, direction is asc
void	sort(Collection.Key strColumn, int order) sorts a query by a column
void	sort(java.lang.String column) Deprecated. use instead sort(railo.runtime.type.Collection.Key)
void	sort(java.lang.String strColumn, int order) Deprecated. use instead sort(railo.runtime.type.Collection.Key, int)

Methods inherited from interface railo.runtime.type.Collection

clear, containsKey, containsKey, duplicate, get, get, get, get, keys, keysAsString, remove, removeEL, set, set, setEL, setEL, size

Methods inherited from interface railo.runtime.dump.Dumpable

toDumpData

Methods inherited from interface railo.runtime.type.Iteratorable

iterator, keyIterator

Methods inherited from interface railo.runtime.op.Castable

castToBoolean, castToBooleanValue, castToDateTime, castToDateTime, castToDoubleValue, castToDoubleValue, castToString, castToString, compareTo, compareTo, compareTo, compareTo

Methods inherited from interface railo.runtime.type.Iterator

getCurrentrow, getRecordcount, go, go, isEmpty, next, next, reset, reset

Methods inherited from interface com.allaire.cfx.Query

addRow, getColumnIndex, getColumns, getData, getName, getRowCount, setData

Methods inherited from interface java.sql.ResultSet

absolute, afterLast, beforeFirst, cancelRowUpdates, clearWarnings, close, deleteRow, findColumn, first, getArray, getArray, getAsciiStream, getAsciiStream, getBigDecimal, getBigDecimal, getBigDecimal, getBigDecimal, getBinaryStream, getBinaryStream, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getCharacterStream, getCharacterStream, getClob, getClob, getConcurrency, getCursorName, getDate, getDate, getDate, getDate, getDouble, getDouble, getFetchDirection, getFetchSize, getFloat, getFloat, getInt, getInt, getLong, getLong, getMetaData, getObject, getObject, getObject, getObject, getRef, getRef, getRow, getShort, getShort, getStatement, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getType, getUnicodeStream, getUnicodeStream, getURL, getURL, getWarnings, insertRow, isAfterLast, isBeforeFirst, isFirst, isLast, last, moveToCurrentRow, moveToInsertRow, next, previous, refreshRow, relative, rowDeleted, rowInserted, rowUpdated, setFetchDirection, setFetchSize, updateArray, updateArray, updateAsciiStream, updateAsciiStream, updateBigDecimal, updateBigDecimal, updateBinaryStream, updateBinaryStream, updateBlob, updateBlob, updateBoolean, updateBoolean, updateByte, updateByte, updateBytes, updateBytes, updateCharacterStream, updateCharacterStream, updateClob, updateClob, updateDate, updateDate, updateDouble, updateDouble, updateFloat, updateFloat, updateInt, updateInt, updateLong, updateLong, updateNull, updateNull, updateObject, updateObject, updateObject, updateObject, updateRef, updateRef, updateRow, updateShort, updateShort, updateString, updateString, updateTime, updateTime, updateTimestamp, updateTimestamp, wasNull

Field Detail

ORDER_ASC

public static final int ORDER_ASC

Constant ORDER_ASC, used for method sort

See Also:

Constant Field Values

ORDER_DESC

public static final int ORDER_DESC

Constant ORDER_DESC, used for method sort

See Also:

Constant Field Values

Method Detail

getUpdateCount

public int getUpdateCount()

Returns:

return how many lines are affected by a update/insert

getAt

public java.lang.Object getAt(java.lang.String key,
                              int row)
                       throws PageException

Deprecated. use instead getAt(railo.runtime.type.Collection.Key, int)

return a value of the resultset by specifed colmn and row

Parameters:

key - column to get

row - row to get from (1-recordcount)

Returns:

value at the called poition

Throws:

PageException - if invalid position definition

getAt

public java.lang.Object getAt(Collection.Key key,
                              int row)
                       throws PageException

return a value of the resultset by specifed colmn and row

Parameters:

key - column to get

row - row to get from (1-recordcount)

Returns:

value at the called poition

Throws:

PageException - if invalid position definition

getAt

public java.lang.Object getAt(java.lang.String key,
                              int row,
                              java.lang.Object defaultValue)

Deprecated. use instead getAt(railo.runtime.type.Collection.Key, int, Object)

return a value of the resultset by specifed colmn and row, otherwise to getAt this method throw no exception if value dont exist (return null)

Parameters:

key - column to get

row - row to get from (1-recordcount)

Returns:

value at the called poition

getAt

public java.lang.Object getAt(Collection.Key key,
                              int row,
                              java.lang.Object defaultValue)

return a value of the resultset by specifed colmn and row, otherwise to getAt this method throw no exception if value dont exist (return null)

Parameters:

key - column to get

row - row to get from (1-recordcount)

Returns:

value at the called poition

setAt

public java.lang.Object setAt(java.lang.String key,
                              int row,
                              java.lang.Object value)
                       throws PageException

Deprecated. use instead setAtEL(railo.runtime.type.Collection.Key, int, Object)

set a value at the defined position

Parameters:

key - column to set

row - row to set

value - value to fill

Returns:

filled value

Throws:

PageException

setAt

public java.lang.Object setAt(Collection.Key key,
                              int row,
                              java.lang.Object value)
                       throws PageException

set a value at the defined position

Parameters:

key - column to set

row - row to set

value - value to fill

Returns:

filled value

Throws:

PageException

setAtEL

public java.lang.Object setAtEL(java.lang.String key,
                                int row,
                                java.lang.Object value)

Deprecated. use instead setAtEL(railo.runtime.type.Collection.Key, int, Object)

set a value at the defined position

Parameters:

key - column to set

row - row to set

value - value to fill

Returns:

filled value

setAtEL

public java.lang.Object setAtEL(Collection.Key key,
                                int row,
                                java.lang.Object value)

set a value at the defined position

Parameters:

key - column to set

row - row to set

value - value to fill

Returns:

filled value

addRow

public boolean addRow(int count)

adds a new row to the resultset

Parameters:

count - count of rows to add

Returns:

return if row is addded or nod (always true)

removeRow

public int removeRow(int row)
              throws PageException

remove row from query

Parameters:

row -

Returns:

return new rowcount

Throws:

PageException

removeRowEL

public int removeRowEL(int row)

remove row from query

Parameters:

row -

Returns:

return new rowcount

addColumn

public boolean addColumn(java.lang.String columnName,
                         Array content)
                  throws PageException

Deprecated. use instead addColumn(railo.runtime.type.Collection.Key, Array)

adds a new column to the resultset

Parameters:

columnName - name of the new column

content - content of the new column inside a array (must have same size like query has records)

Returns:

if column is added return true otherwise false (always true, throw error when false)

Throws:

PageException

addColumn

public boolean addColumn(Collection.Key columnName,
                         Array content)
                  throws PageException

adds a new column to the resultset

Parameters:

columnName - name of the new column

content - content of the new column inside a array (must have same size like query has records)

Returns:

if column is added return true otherwise false (always true, throw error when false)

Throws:

PageException

addColumn

public boolean addColumn(java.lang.String columnName,
                         Array content,
                         int type)
                  throws PageException

Deprecated. use instead addColumn(railo.runtime.type.Collection.Key, Array, int)

adds a new column to the resultset

Parameters:

columnName - name of the new column

content - content of the new column inside a array (must have same size like query has records)

type - data type from (java.sql.Types)

Returns:

if column is added return true otherwise false (always true, throw error when false)

Throws:

PageException

addColumn

public boolean addColumn(Collection.Key columnName,
                         Array content,
                         int type)
                  throws PageException

adds a new column to the resultset

Parameters:

columnName - name of the new column

content - content of the new column inside a array (must have same size like query has records)

type - data type from (java.sql.Types)

Returns:

if column is added return true otherwise false (always true, throw error when false)

Throws:

PageException

clone

public java.lang.Object clone()

Specified by:

clone in interface Collection

Returns:

Coloned Object

getTypes

public int[] getTypes()

Returns:

return all types

getTypesAsMap

public java.util.Map getTypesAsMap()

Returns:

returns all types as Map (key==column)

getColumn

public QueryColumn getColumn(java.lang.String key)
                      throws PageException

Deprecated. use instead getColumn(railo.runtime.type.Collection.Key)

return the query column matching to key

Parameters:

key - key to get

Returns:

QieryColumn object

Throws:

PageException

getColumn

public QueryColumn getColumn(Collection.Key key)
                      throws PageException

return the query column matching to key

Parameters:

key - key to get

Returns:

QieryColumn object

Throws:

PageException

getColumn

public QueryColumn getColumn(java.lang.String key,
                             QueryColumn column)

Deprecated. use instead getColumn(railo.runtime.type.Collection.Key, QueryColumn)

return the query column matching to key, if key not exist return null

Parameters:

key - key to get

Returns:

QieryColumn object

getColumn

public QueryColumn getColumn(Collection.Key key,
                             QueryColumn column)

return the query column matching to key, if key not exist return null

Parameters:

key - key to get

Returns:

QieryColumn object

removeColumn

public QueryColumn removeColumn(java.lang.String key)
                         throws PageException

Deprecated. use instead removeColumn(railo.runtime.type.Collection.Key)

remove column matching to key

Parameters:

key - key to remove

Returns:

QueryColumn object removed

Throws:

PageException

removeColumn

public QueryColumn removeColumn(Collection.Key key)
                         throws PageException

remove column matching to key

Parameters:

key - key to remove

Returns:

QueryColumn object removed

Throws:

PageException

removeColumnEL

public QueryColumn removeColumnEL(java.lang.String key)

Deprecated. use instead removeColumnEL(railo.runtime.type.Collection.Key)

remove column matching to key

Parameters:

key - key to remove

Returns:

QueryColumn object removed or null if column not exists

removeColumnEL

public QueryColumn removeColumnEL(Collection.Key key)

remove column matching to key

Parameters:

key - key to remove

Returns:

QueryColumn object removed or null if column not exists

executionTime

public int executionTime()

Returns:

returns the execution time

setExecutionTime

public void setExecutionTime(long l)

sets the execution Time of the query

Parameters:

l -

sort

public void sort(java.lang.String column)
          throws PageException

Deprecated. use instead sort(railo.runtime.type.Collection.Key)

sorts a query by a column, direction is asc

Parameters:

column - colun to sort

Throws:

PageException

sort

public void sort(Collection.Key column)
          throws PageException

sorts a query by a column, direction is asc

Parameters:

column - colun to sort

Throws:

PageException

sort

public void sort(java.lang.String strColumn,
                 int order)
          throws PageException

Deprecated. use instead sort(railo.runtime.type.Collection.Key, int)

sorts a query by a column

Parameters:

strColumn - column to sort

order - sort type (Query.ORDER_ASC or Query.ORDER_DESC)

Throws:

PageException

sort

public void sort(Collection.Key strColumn,
                 int order)
          throws PageException

sorts a query by a column

Parameters:

strColumn - column to sort

order - sort type (Query.ORDER_ASC or Query.ORDER_DESC)

Throws:

PageException

setCached

public void setCached(boolean isCached)

sets if query is form cache or not

Parameters:

isCached - is cached or not

isCached

public boolean isCached()

is query from cache or not

Returns:

is cached or not

getMetaDataSimple

public Array getMetaDataSimple()

Returns:

returns array with meta data to the query (only column names and type)