LocalResult (H2 Database Engine 2.0.0 API)

java.lang.Object
- org.h2.result.LocalResult

所有已实现的接口:

AutoCloseable, ResultInterface, ResultTarget
```
public class LocalResult
extends Object
implements ResultInterface, ResultTarget
```
A local result set contains all row data of a result set. This is the object generated by engine, and it is also used directly by the ResultSet class in the embedded mode. If the result does not fit in memory, it is written to a temporary file.

构造器概要

构造器
构造器和说明
`LocalResult()` Construct a local result object.
`LocalResult(SessionLocal session, Expression[] expressions, int visibleColumnCount, int resultColumnCount)` Construct a local result object.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addRow(Value... values)` Add a row to this object.
`void`	`addRowForTable(Row row)` Add a row for a table.
`void`	`close()` Close the result and delete any temporary files
`boolean`	`containsDistinct(Value[] values)` Check if this result set contains the given row.
`boolean`	`containsNull()` Check if this result set contains a NULL value.
`LocalResult`	`createShallowCopy(Session targetSession)` Create a shallow copy of the result set.
`Value[]`	`currentRow()` Get the current row.
`Row`	`currentRowForTable()` Retrieve the current row
`void`	`done()` This method is called after all rows have been added.
`static LocalResult`	`forTable(SessionLocal session, Table table)` Constructs a new local result object for the specified table.
`String`	`getAlias(int i)` Get the column alias name for the column.
`String`	`getColumnName(int i)` Get the column name.
`TypeInfo`	`getColumnType(int i)` Get the column data type.
`int`	`getFetchSize()` Get the current fetch size for this result set.
`int`	`getNullable(int i)` Check if this column is nullable.
`long`	`getRowCount()` Get the number of rows in this object.
`long`	`getRowId()` Get the current row id, starting with 0
`String`	`getSchemaName(int i)` Get the schema name for the column, if one exists.
`String`	`getTableName(int i)` Get the table name for the column, if one exists.
`int`	`getVisibleColumnCount()` Get the number of visible columns.
`boolean`	`hasNext()` Check if this result has more rows to fetch.
`boolean`	`isAfterLast()` Check if the current position is after last row.
`boolean`	`isClosed()` Check if this result set is closed.
`boolean`	`isIdentity(int i)` Check if this is an identity column.
`boolean`	`isLazy()` Check if this a lazy execution result.
`void`	`limitsWereApplied()` A hint that sorting, offset and limit may be ignored by this result because they were applied during the query.
`boolean`	`needToClose()` Check if this result set should be closed, for example because it is buffered using a temporary file.
`boolean`	`next()` Go to the next row.
`void`	`removeDistinct(Value[] values)` Remove the row from the result set if it exists.
`void`	`reset()` Go to the beginning of the result, that means before the first row.
`void`	`setDistinct()` Remove duplicate rows.
`void`	`setDistinct(int[] distinctIndexes)` Remove rows with duplicates in columns with specified indexes.
`void`	`setFetchPercent(boolean fetchPercent)`
`void`	`setFetchSize(int fetchSize)` Set the fetch size for this result set.
`void`	`setForDataChangeDeltaTable()` Sets value collection mode for data change delta tables.
`void`	`setLimit(long limit)` Set the number of rows that this result will return at the maximum.
`void`	`setMaxMemoryRows(int maxValue)` Redefine count of maximum rows holds in memory for the result.
`void`	`setOffset(long offset)` Set the offset of the first row to return.
`void`	`setSortOrder(SortOrder sort)` Sets sort order to be used by this result.
`void`	`setWithTies(SortOrder withTiesSortOrder)` Enables inclusion of tied rows to result and sets the sort order for tied rows.
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - LocalResult
```
public LocalResult()
```
    Construct a local result object.
  - LocalResult
```
public LocalResult(SessionLocal session,
                   Expression[] expressions,
                   int visibleColumnCount,
                   int resultColumnCount)
```
    Construct a local result object.
    
    参数:
    
    session - the session
    
    expressions - the expression array
    
    visibleColumnCount - the number of visible columns
    
    resultColumnCount - the number of columns including visible columns and additional virtual columns for ORDER BY and DISTINCT ON clauses
- 方法详细资料
  - forTable
```
public static LocalResult forTable(SessionLocal session,
                                   Table table)
```
    Constructs a new local result object for the specified table.
    
    参数:
    
    session - the session
    
    table - the table
    
    返回:
    
    the local result
  - isLazy
```
public boolean isLazy()
```
    从接口复制的说明: ResultInterface
    
    Check if this a lazy execution result.
    
    指定者:
    
    isLazy 在接口中 ResultInterface
    
    返回:
    
    true if it is a lazy result
  - setMaxMemoryRows
```
public void setMaxMemoryRows(int maxValue)
```
    Redefine count of maximum rows holds in memory for the result.
    
    参数:
    
    maxValue - Maximum rows count in memory.
    
    另请参阅:
    
    SysProperties.MAX_MEMORY_ROWS
  - setForDataChangeDeltaTable
```
public void setForDataChangeDeltaTable()
```
    Sets value collection mode for data change delta tables.
  - createShallowCopy
```
public LocalResult createShallowCopy(Session targetSession)
```
    Create a shallow copy of the result set. The data and a temporary table (if there is any) is not copied.
    
    指定者:
    
    createShallowCopy 在接口中 ResultInterface
    
    参数:
    
    targetSession - the session of the copy
    
    返回:
    
    the copy if possible, or null if copying is not possible
  - setSortOrder
```
public void setSortOrder(SortOrder sort)
```
    Sets sort order to be used by this result. When rows are presorted by the query this method should not be used.
    
    参数:
    
    sort - the sort order
  - setDistinct
```
public void setDistinct()
```
    Remove duplicate rows.
  - setDistinct
```
public void setDistinct(int[] distinctIndexes)
```
    Remove rows with duplicates in columns with specified indexes.
    
    参数:
    
    distinctIndexes - distinct indexes
  - containsDistinct
```
public boolean containsDistinct(Value[] values)
```
    Check if this result set contains the given row.
    
    参数:
    
    values - the row
    
    返回:
    
    true if the row exists
  - containsNull
```
public boolean containsNull()
```
    Check if this result set contains a NULL value. This method may reset this result.
    
    返回:
    
    true if there is a NULL value
  - removeDistinct
```
public void removeDistinct(Value[] values)
```
    Remove the row from the result set if it exists.
    
    参数:
    
    values - the row
  - reset
```
public void reset()
```
    从接口复制的说明: ResultInterface
    
    Go to the beginning of the result, that means before the first row.
    
    指定者:
    
    reset 在接口中 ResultInterface
  - currentRowForTable
```
public Row currentRowForTable()
```
    Retrieve the current row
    
    返回:
    
    row
  - currentRow
```
public Value[] currentRow()
```
    从接口复制的说明: ResultInterface
    
    Get the current row.
    
    指定者:
    
    currentRow 在接口中 ResultInterface
    
    返回:
    
    the row
  - next
```
public boolean next()
```
    从接口复制的说明: ResultInterface
    
    Go to the next row.
    
    指定者:
    
    next 在接口中 ResultInterface
    
    返回:
    
    true if a row exists
  - getRowId
```
public long getRowId()
```
    从接口复制的说明: ResultInterface
    
    Get the current row id, starting with 0. -1 is returned when next() was not called yet.
    
    指定者:
    
    getRowId 在接口中 ResultInterface
    
    返回:
    
    the row id
  - isAfterLast
```
public boolean isAfterLast()
```
    从接口复制的说明: ResultInterface
    
    Check if the current position is after last row.
    
    指定者:
    
    isAfterLast 在接口中 ResultInterface
    
    返回:
    
    true if after last
  - addRowForTable
```
public void addRowForTable(Row row)
```
    Add a row for a table.
    
    参数:
    
    row - the row to add
  - addRow
```
public void addRow(Value... values)
```
    Add a row to this object.
    
    指定者:
    
    addRow 在接口中 ResultTarget
    
    参数:
    
    values - the row to add
  - getVisibleColumnCount
```
public int getVisibleColumnCount()
```
    从接口复制的说明: ResultInterface
    
    Get the number of visible columns. More columns may exist internally for sorting or grouping.
    
    指定者:
    
    getVisibleColumnCount 在接口中 ResultInterface
    
    返回:
    
    the number of columns
  - done
```
public void done()
```
    This method is called after all rows have been added.
  - getRowCount
```
public long getRowCount()
```
    从接口复制的说明: ResultInterface
    
    Get the number of rows in this object.
    
    指定者:
    
    getRowCount 在接口中 ResultInterface
    
    指定者:
    
    getRowCount 在接口中 ResultTarget
    
    返回:
    
    the number of rows
  - limitsWereApplied
```
public void limitsWereApplied()
```
    从接口复制的说明: ResultTarget
    
    A hint that sorting, offset and limit may be ignored by this result because they were applied during the query. This is useful for WITH TIES clause because result may contain tied rows above limit.
    
    指定者:
    
    limitsWereApplied 在接口中 ResultTarget
  - hasNext
```
public boolean hasNext()
```
    从接口复制的说明: ResultInterface
    
    Check if this result has more rows to fetch.
    
    指定者:
    
    hasNext 在接口中 ResultInterface
    
    返回:
    
    true if it has
  - setLimit
```
public void setLimit(long limit)
```
    Set the number of rows that this result will return at the maximum.
    
    参数:
    
    limit - the limit (-1 means no limit, 0 means no rows)
  - setFetchPercent
```
public void setFetchPercent(boolean fetchPercent)
```
    参数:
    
    fetchPercent - whether limit expression specifies percentage of rows
  - setWithTies
```
public void setWithTies(SortOrder withTiesSortOrder)
```
    Enables inclusion of tied rows to result and sets the sort order for tied rows. The specified sort order must be the same as sort order if sort order was set. Passed value will be used if sort order was not set that is possible when rows are presorted.
    
    参数:
    
    withTiesSortOrder - the sort order for tied rows
  - needToClose
```
public boolean needToClose()
```
    从接口复制的说明: ResultInterface
    
    Check if this result set should be closed, for example because it is buffered using a temporary file.
    
    指定者:
    
    needToClose 在接口中 ResultInterface
    
    返回:
    
    true if close should be called.
  - close
```
public void close()
```
    从接口复制的说明: ResultInterface
    
    Close the result and delete any temporary files
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    指定者:
    
    close 在接口中 ResultInterface
  - getAlias
```
public String getAlias(int i)
```
    从接口复制的说明: ResultInterface
    
    Get the column alias name for the column.
    
    指定者:
    
    getAlias 在接口中 ResultInterface
    
    参数:
    
    i - the column number (starting with 0)
    
    返回:
    
    the alias name
  - getTableName
```
public String getTableName(int i)
```
    从接口复制的说明: ResultInterface
    
    Get the table name for the column, if one exists.
    
    指定者:
    
    getTableName 在接口中 ResultInterface
    
    参数:
    
    i - the column number (starting with 0)
    
    返回:
    
    the table name or null
  - getSchemaName
```
public String getSchemaName(int i)
```
    从接口复制的说明: ResultInterface
    
    Get the schema name for the column, if one exists.
    
    指定者:
    
    getSchemaName 在接口中 ResultInterface
    
    参数:
    
    i - the column number (starting with 0)
    
    返回:
    
    the schema name or null
  - getColumnName
```
public String getColumnName(int i)
```
    从接口复制的说明: ResultInterface
    
    Get the column name.
    
    指定者:
    
    getColumnName 在接口中 ResultInterface
    
    参数:
    
    i - the column number (starting with 0)
    
    返回:
    
    the column name
  - getColumnType
```
public TypeInfo getColumnType(int i)
```
    从接口复制的说明: ResultInterface
    
    Get the column data type.
    
    指定者:
    
    getColumnType 在接口中 ResultInterface
    
    参数:
    
    i - the column number (starting with 0)
    
    返回:
    
    the column data type
  - getNullable
```
public int getNullable(int i)
```
    从接口复制的说明: ResultInterface
    
    Check if this column is nullable.
    
    指定者:
    
    getNullable 在接口中 ResultInterface
    
    参数:
    
    i - the column number (starting with 0)
    
    返回:
    
    Column.NULLABLE_*
  - isIdentity
```
public boolean isIdentity(int i)
```
    从接口复制的说明: ResultInterface
    
    Check if this is an identity column.
    
    指定者:
    
    isIdentity 在接口中 ResultInterface
    
    参数:
    
    i - the column number (starting with 0)
    
    返回:
    
    true for identity columns
  - setOffset
```
public void setOffset(long offset)
```
    Set the offset of the first row to return.
    
    参数:
    
    offset - the offset
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - isClosed
```
public boolean isClosed()
```
    Check if this result set is closed.
    
    指定者:
    
    isClosed 在接口中 ResultInterface
    
    返回:
    
    true if it is
  - getFetchSize
```
public int getFetchSize()
```
    从接口复制的说明: ResultInterface
    
    Get the current fetch size for this result set.
    
    指定者:
    
    getFetchSize 在接口中 ResultInterface
    
    返回:
    
    the fetch size
  - setFetchSize
```
public void setFetchSize(int fetchSize)
```
    从接口复制的说明: ResultInterface
    
    Set the fetch size for this result set.
    
    指定者:
    
    setFetchSize 在接口中 ResultInterface
    
    参数:
    
    fetchSize - the new fetch size

类 LocalResult

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

LocalResult

LocalResult

方法详细资料

forTable

isLazy

setMaxMemoryRows

setForDataChangeDeltaTable

createShallowCopy

setSortOrder

setDistinct

setDistinct

containsDistinct

containsNull

removeDistinct

reset

currentRowForTable

currentRow

next

getRowId

isAfterLast

addRowForTable

addRow

getVisibleColumnCount

done

getRowCount

limitsWereApplied

hasNext

setLimit

setFetchPercent

setWithTies

needToClose

close

getAlias

getTableName

getSchemaName

getColumnName

getColumnType

getNullable

isIdentity

setOffset

toString

isClosed

getFetchSize

setFetchSize