ViewIndex (H2 Database Engine wt-1.0.1 API)

java.lang.Object
- org.h2.engine.DbObjectBase
- - org.h2.schema.SchemaObjectBase
  - - org.h2.index.BaseIndex
    - - org.h2.index.ViewIndex

所有已实现的接口:

DbObject, Index, SpatialIndex, SchemaObject
```
public class ViewIndex
extends BaseIndex
implements SpatialIndex
```
This object represents a virtual index for a query. Actually it only represents a prepared SELECT statement.

字段概要
- 从类继承的字段 org.h2.index.BaseIndex
  columnIds, columns, indexColumns, indexType, isMultiVersion, table
- 从类继承的字段 org.h2.engine.DbObjectBase
  comment, database, trace
- 从接口继承的字段 org.h2.engine.DbObject
  AGGREGATE, COMMENT, CONSTANT, CONSTRAINT, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, TABLE_OR_VIEW, TRIGGER, USER, USER_DATATYPE

构造器概要

构造器
构造器和说明
`ViewIndex(TableView view, String querySQL, ArrayList<Parameter> originalParameters, boolean recursive)` Constructor for the original index in `TableView`.
`ViewIndex(TableView view, ViewIndex index, Session session, int[] masks, TableFilter[] filters, int filter, SortOrder sortOrder)` Constructor for plan item generation.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`add(Session session, Row row)` Add a row to the index.
`boolean`	`canGetFirstOrLast()` Check if the index can directly look up the lowest or highest value of a column.
`void`	`checkRename()` Check if this object can be renamed.
`void`	`close(Session session)` Close this index.
`IndexLookupBatch`	`createLookupBatch(TableFilter[] filters, int filter)` Creates new lookup batch.
`Cursor`	`find(Session session, SearchRow first, SearchRow last)` Find a row or a list of rows and create a cursor to iterate over the result.
`Cursor`	`findByGeometry(TableFilter filter, SearchRow first, SearchRow last, SearchRow intersection)` Find a row or a list of rows and create a cursor to iterate over the result.
`Cursor`	`findFirstOrLast(Session session, boolean first)` Find the first (or last) value of this index.
`double`	`getCost(Session session, int[] masks, TableFilter[] filters, int filter, SortOrder sortOrder, HashSet<Column> allColumnsSet)` Estimate the cost to search for rows given the search mask.
`long`	`getDiskSpaceUsed()` Get the used disk space for this index.
`String`	`getPlanSQL()` Get the message to show in a EXPLAIN statement.
`Query`	`getQuery()`
`long`	`getRowCount(Session session)` Get the row count of this table, for the given session.
`long`	`getRowCountApproximation()` Get the approximated row count for this table.
`Session`	`getSession()`
`boolean`	`isExpired()`
`boolean`	`isRecursive()`
`boolean`	`needRebuild()` Check if the index needs to be rebuilt.
`void`	`remove(Session session)` Remove the index.
`void`	`remove(Session session, Row row)` Remove a row from the index.
`void`	`setRecursive(boolean value)`
`void`	`setupQueryParameters(Session session, SearchRow first, SearchRow last, SearchRow intersection)` Set the query parameters.
`void`	`truncate(Session session)` Remove all rows from the index.

从类继承的方法 org.h2.index.BaseIndex
canFindNext, canScan, checkIndexColumnTypes, commit, compareRows, containsNullAndAllowMultipleNull, find, findNext, getColumnIndex, getColumns, getCostRangeIndex, getCreateSQL, getCreateSQLForCopy, getDropSQL, getDuplicateKeyException, getIndexColumns, getIndexType, getRow, getTable, getType, initBaseIndex, isHidden, isRowIdIndex, removeChildrenAndResources, setSortedInsertMode

从类继承的方法 org.h2.schema.SchemaObjectBase
getSchema, getSQL, initSchemaObjectBase

从类继承的方法 org.h2.engine.DbObjectBase
getChildren, getComment, getDatabase, getId, getModificationId, getName, initDbObjectBase, invalidate, isTemporary, isValid, rename, setComment, setModified, setObjectName, setTemporary, toString

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

从接口继承的方法 org.h2.index.Index
canFindNext, canScan, commit, compareRows, find, findNext, getColumnIndex, getColumns, getIndexColumns, getIndexType, getRow, getTable, isRowIdIndex, setSortedInsertMode

从接口继承的方法 org.h2.schema.SchemaObject
getSchema, isHidden

从接口继承的方法 org.h2.engine.DbObject
getChildren, getComment, getCreateSQL, getCreateSQLForCopy, getDatabase, getDropSQL, getId, getName, getSQL, getType, isTemporary, removeChildrenAndResources, rename, setComment, setTemporary

- 构造器详细资料
  - ViewIndex
```
public ViewIndex(TableView view,
                 String querySQL,
                 ArrayList<Parameter> originalParameters,
                 boolean recursive)
```
    Constructor for the original index in TableView.
    
    参数:
    
    view - the table view
    
    querySQL - the query SQL
    
    originalParameters - the original parameters
    
    recursive - if the view is recursive
  - ViewIndex
```
public ViewIndex(TableView view,
                 ViewIndex index,
                 Session session,
                 int[] masks,
                 TableFilter[] filters,
                 int filter,
                 SortOrder sortOrder)
```
    Constructor for plan item generation. Over this index the query will be executed.
    
    参数:
    
    view - the table view
    
    index - the view index
    
    session - the session
    
    masks - the masks
    
    filters - table filters
    
    filter - current filter
    
    sortOrder - sort order
- 方法详细资料
  - createLookupBatch
```
public IndexLookupBatch createLookupBatch(TableFilter[] filters,
                                          int filter)
```
    从接口复制的说明: Index
    
    Creates new lookup batch. Note that returned IndexLookupBatch instance can be used multiple times.
    
    指定者:
    
    createLookupBatch 在接口中 Index
    
    覆盖:
    
    createLookupBatch 在类中 BaseIndex
    
    参数:
    
    filters - the table filters
    
    filter - the filter index (0, 1,...)
    
    返回:
    
    created batch or null if batched lookup is not supported by this index.
  - getSession
```
public Session getSession()
```
  - isExpired
```
public boolean isExpired()
```
  - getPlanSQL
```
public String getPlanSQL()
```
    从接口复制的说明: Index
    
    Get the message to show in a EXPLAIN statement.
    
    指定者:
    
    getPlanSQL 在接口中 Index
    
    覆盖:
    
    getPlanSQL 在类中 BaseIndex
    
    返回:
    
    the plan
  - close
```
public void close(Session session)
```
    从接口复制的说明: Index
    
    Close this index.
    
    指定者:
    
    close 在接口中 Index
    
    参数:
    
    session - the session used to write data
  - add
```
public void add(Session session,
                Row row)
```
    从接口复制的说明: Index
    
    Add a row to the index.
    
    指定者:
    
    add 在接口中 Index
    
    参数:
    
    session - the session to use
    
    row - the row to add
  - remove
```
public void remove(Session session,
                   Row row)
```
    从接口复制的说明: Index
    
    Remove a row from the index.
    
    指定者:
    
    remove 在接口中 Index
    
    参数:
    
    session - the session
    
    row - the row
  - getCost
```
public double getCost(Session session,
                      int[] masks,
                      TableFilter[] filters,
                      int filter,
                      SortOrder sortOrder,
                      HashSet<Column> allColumnsSet)
```
    从接口复制的说明: Index
    
    Estimate the cost to search for rows given the search mask. There is one element per column in the search mask. For possible search masks, see IndexCondition.
    
    指定者:
    
    getCost 在接口中 Index
    
    参数:
    
    session - the session
    
    masks - per-column comparison bit masks, null means 'always false', see constants in IndexCondition
    
    filters - all joined table filters
    
    filter - the current table filter index
    
    sortOrder - the sort order
    
    allColumnsSet - the set of all columns
    
    返回:
    
    the estimated cost
  - find
```
public Cursor find(Session session,
                   SearchRow first,
                   SearchRow last)
```
    从接口复制的说明: Index
    
    Find a row or a list of rows and create a cursor to iterate over the result.
    
    指定者:
    
    find 在接口中 Index
    
    参数:
    
    session - the session
    
    first - the first row, or null for no limit
    
    last - the last row, or null for no limit
    
    返回:
    
    the cursor to iterate over the results
  - findByGeometry
```
public Cursor findByGeometry(TableFilter filter,
                             SearchRow first,
                             SearchRow last,
                             SearchRow intersection)
```
    从接口复制的说明: SpatialIndex
    
    Find a row or a list of rows and create a cursor to iterate over the result.
    
    指定者:
    
    findByGeometry 在接口中 SpatialIndex
    
    参数:
    
    filter - the table filter (which possibly knows about additional conditions)
    
    first - the lower bound
    
    last - the upper bound
    
    intersection - the geometry which values should intersect with, or null for anything
    
    返回:
    
    the cursor to iterate over the results
  - setupQueryParameters
```
public void setupQueryParameters(Session session,
                                 SearchRow first,
                                 SearchRow last,
                                 SearchRow intersection)
```
    Set the query parameters.
    
    参数:
    
    session - the session
    
    first - the lower bound
    
    last - the upper bound
    
    intersection - the intersection
  - getQuery
```
public Query getQuery()
```
  - remove
```
public void remove(Session session)
```
    从接口复制的说明: Index
    
    Remove the index.
    
    指定者:
    
    remove 在接口中 Index
    
    参数:
    
    session - the session
  - truncate
```
public void truncate(Session session)
```
    从接口复制的说明: Index
    
    Remove all rows from the index.
    
    指定者:
    
    truncate 在接口中 Index
    
    参数:
    
    session - the session
  - checkRename
```
public void checkRename()
```
    从类复制的说明: DbObjectBase
    
    Check if this object can be renamed. System objects may not be renamed.
    
    指定者:
    
    checkRename 在接口中 DbObject
    
    指定者:
    
    checkRename 在类中 DbObjectBase
  - needRebuild
```
public boolean needRebuild()
```
    从接口复制的说明: Index
    
    Check if the index needs to be rebuilt. This method is called after opening an index.
    
    指定者:
    
    needRebuild 在接口中 Index
    
    返回:
    
    true if a rebuild is required.
  - canGetFirstOrLast
```
public boolean canGetFirstOrLast()
```
    从接口复制的说明: Index
    
    Check if the index can directly look up the lowest or highest value of a column.
    
    指定者:
    
    canGetFirstOrLast 在接口中 Index
    
    返回:
    
    true if it can
  - findFirstOrLast
```
public Cursor findFirstOrLast(Session session,
                              boolean first)
```
    从接口复制的说明: Index
    
    Find the first (or last) value of this index. The cursor returned is positioned on the correct row, or on null if no row has been found.
    
    指定者:
    
    findFirstOrLast 在接口中 Index
    
    参数:
    
    session - the session
    
    first - true if the first (lowest for ascending indexes) or last value should be returned
    
    返回:
    
    a cursor (never null)
  - setRecursive
```
public void setRecursive(boolean value)
```
  - getRowCount
```
public long getRowCount(Session session)
```
    从接口复制的说明: Index
    
    Get the row count of this table, for the given session.
    
    指定者:
    
    getRowCount 在接口中 Index
    
    参数:
    
    session - the session
    
    返回:
    
    the row count
  - getRowCountApproximation
```
public long getRowCountApproximation()
```
    从接口复制的说明: Index
    
    Get the approximated row count for this table.
    
    指定者:
    
    getRowCountApproximation 在接口中 Index
    
    返回:
    
    the approximated row count
  - getDiskSpaceUsed
```
public long getDiskSpaceUsed()
```
    从接口复制的说明: Index
    
    Get the used disk space for this index.
    
    指定者:
    
    getDiskSpaceUsed 在接口中 Index
    
    返回:
    
    the estimated number of bytes
  - isRecursive
```
public boolean isRecursive()
```

类 ViewIndex

字段概要

从类继承的字段 org.h2.index.BaseIndex

从类继承的字段 org.h2.engine.DbObjectBase

从接口继承的字段 org.h2.engine.DbObject

构造器概要

方法概要

从类继承的方法 org.h2.index.BaseIndex

从类继承的方法 org.h2.schema.SchemaObjectBase

从类继承的方法 org.h2.engine.DbObjectBase

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

从接口继承的方法 org.h2.index.Index

从接口继承的方法 org.h2.schema.SchemaObject

从接口继承的方法 org.h2.engine.DbObject

构造器详细资料

ViewIndex

ViewIndex

方法详细资料

createLookupBatch

getSession

isExpired

getPlanSQL

close

add

remove

getCost

find

findByGeometry

setupQueryParameters

getQuery

remove

truncate

checkRename

needRebuild

canGetFirstOrLast

findFirstOrLast

setRecursive

getRowCount

getRowCountApproximation

getDiskSpaceUsed

isRecursive