public class ResultSet extends RecordList implements HasDataArrivedHandlers
com.smartgwt.client.data.List
interface that automatically fetches
DataSource records when items are requested from the List. ResultSets provide robust,
customizable, high-performance cache management for ListGrids and other built-in Smart GWT
components, and can be used as cache managers by custom components.
ResultSets manage data paging, that is, loading records in batches as the user navigates the data set. A ResultSet will switch to using client-side sorting and filtering when possible to improve responsiveness and reduce server load. ResultSets also participate in automatic cache synchronization, observing operations on DataSources and automatically updating their caches.
Creation
A ResultSet can be passed to any component that expects a List, and the List APIs can be
called directly on the ResultSet as long as the caller is able to deal with asynchronous
loading; see getRange()
.
Generally ResultSets do not need to be created directly, but are created by DataBound
components as an automatic consequence of calling
DataBound Component Methods
.
For example, the ListGrid.fetchData()
causes ListGrid.data
to become an
automatically created ResultSet
object. Automatically created ResultSets
can be customized via properties on ListGrids such as ListGrid.dataPageSize
and
ListGrid.dataProperties
. All ResultSets for a given
DataSource may also be
customized via setting DataSource.resultSetClass
to the
name of a ResultSet
subclass
in which
defaults have been changed.
A ResultSet defaults to using data paging, setting DSRequest.startRow
and
DSRequest.endRow
in issued dsRequests. Server code may always
return more rows than
the ResultSet requests and the ResultSet will correctly integrate those rows based on
DSResponse.startRow
/endRow
.
Hence the server can always avoid paging mode by simply returning all matching rows.
A ResultSet can be created directly with just the ID of a DataSource
:
ResultSet resultSet = new ResultSet(); resultSet.setDataSource(dataSourceID);
Directly created ResultSets are typically used by custom components, or as a means of managing datasets that will be used by several components.
When created directly rather than via a dataBoundComponent, a newly created ResultSet will
not issue it's first "fetch" DSRequest
until data is accessed (for example, via
get()
).
Paging and total dataset length
When using data paging, the server communicates the total number of records that match the
current search criteria by setting DSResponse.totalRows
. The
ResultSet will then
return this number from getLength()
, and ListGrids and other
components will show a scrollbar that allows the user to jump to the end of the dataset
directly.
However, the ResultSet does not require that the server calculate the true length of the
dataset, which can be costly for an extremely large, searchable dataset. Instead, the
server may advertise a totalRows
value that is one page larger
than the last row loaded. This results in a UI sometimes called "progressive loading",
where the user may load more rows by scrolling past the end of the currently loaded rows,
but is not allowed to skip to the end of the dataset.
The Smart GWT server offers built in support for progressive loading at the
dataSource
,
operationBinding
and
request
level for SQL-backed dataSources.
Setting progressiveLoading
or DataBoundComponent.progressiveLoading
to
true will also enable this feature where available.
Where available, progressive loading will also be enabled automatically
for very large data sets if a
DataSource.progressiveLoadingThreshold
is specified.
Note that the Smart GWT server is not a requirement for progressive loading -
any DataSource implementation can enable progressive loading by simply populating
the DSResponse.totalRows
property with an appropriate value.
We recommend the DSResponse.progressiveLoading
attribute be set to true
as well - this allows client side logic to treat the reported totalRows
value specially if necessary.
No client-side settings are required to enable this mode - it is entirely server-driven.
However, it is usually coupled with disabling sorting
,
since
server-side sorting would also force the server to traverse the entire dataset.
Client-side Sorting and Filtering
If a ResultSet obtains a full cache for the current set of filter criteria, it will automatically switch to client-side sorting, and will also use client-side filtering if the filter criteria are later changed but appear to be more restrictive than the criteria in use when the ResultSet obtained a full cache.
The useClientSorting
and
useClientFiltering
flags can be used to disable
client-side sorting and filtering respectively if these behaviors don't match server-based
sorting and filtering. However, because client-side sorting and filtering radically improve
responsiveness and reduce server load, it is better to customize the ResultSet so that it
can match server-side sorting and filtering behaviors.
Sorting behavior is primarily customized via the "sort normalizer" passed to
sortByProperty()
, either via direct calls on a standalone
ResultSet, or via
ListGridField.sortNormalizer()
for a
ListGrid-managed ResultSet.
By default, client-side filtering interprets the criteria
passed to
setCriteria()
as a set of field values that records must match
(similarly to the built-in SQL/Hibernate connectors built into the Smart GWT Server).
Custom client-side filtering logic can be implemented by overriding
applyFilter()
. Overriding
compareCriteria()
allows you to control when the ResultSet
uses client-side vs server-side filtering, and the ResultSet has two default
criteria policies
built-in.
Modifying ResultSets
Records cannot be directly added or removed from a ResultSet via com.smartgwt.client.data.List
APIs such as removeAt()
, unless it always filters locally, since
this would break the consistency of server and client row numbering needed for data paging,
and also create some issues with automatic cache synchronization. Set
modifiable
to enable the com.smartgwt.client.data.List
modification APIs on a
fetchMode
:"local" ResultSet. Note that the special
FilteredList
class sets this property to allow developers to modify its data.
Use DataSource.addData()
/removeData()
to add/remove
rows from the DataSource
, and the ResultSet will reflect the changes automatically.
Alternatively, the DataSource.updateCaches()
method may be
called to only update
local caches of the DataSource in question, without generating any server traffic.
To create a locally modifiable cache of Records from a DataSource, you
can use DataSource.fetchData()
to retrieve a List of Records which
can
be modified directly, or you can create a client-only DataSource
from
the retrieved data to share a modifiable cache between several
DataBoundComponents.
Updates and Automatic Cache Synchronization
Once a ResultSet has retrieved data or has been initialized with data, the ResultSet will observe any successful "update", "add" or "remove" dsRequests against their DataSource, regardless of the component that initiated them. A ResultSet with a full cache for the current filter criteria will integrate updates into the cache automatically.
Updated rows that no longer match the current filter criteria will be removed
automatically. To prevent this, you can set neverDropUpdatedRows
.
Added rows will similarly be added to the cache only if they match current filter criteria.
Note that the client-side filtering described above is also used to determine whether
updated or added rows should be in the cache. If any aspect of automated cache update is
ever incorrect, dropCacheOnUpdate
can be set for the
ResultSet or DSResponse.invalidateCache
can be set for an
individual dsResponse.
If automatic cache synchronization isn't working, troubleshoot the problem using the steps suggested in the FAQ.
Regarding operationIds
and how they affect caching,
take into account that cache sync is based on the fetch used - any add or update operation
uses a fetch to retrieve updated data, and the operationId of that fetch can be set via
cacheSyncOperation
.
If the operationId of the cache is different from the operationId of the cache update data,
it won't be used to update the cache, since the fields included and other aspects of the
data are allowed to be different across different operationIds. This allows to maintain
distinct caches on a per component basis, so when two components are using separate
operationIds they are assumed to have distinct caches, because updates performed with
one operationId will not affect the cache obtained via another operationId.
Also, take into account that operationId must be unique per DataSource, across all
operationTypes for that DataSource.
Data Paging with partial cache
When in paging mode with a partial cache, a ResultSet relies on server side sorting, setting
DSRequest.sortBy
to the current sort field and direction. In order
for the cache to
remain coherent, row numbering must continue to agree between server and client as new
fetches are issued, otherwise, duplicate rows or missing rows may occur.
If concurrent modifications by other users are allowed, generally the server should set
DSResponse.invalidateCache
to clear the cache when
concurrent modification is
detected.
In paging mode with a partial cache, any successful "update" or "add" operation may cause client and server row numbering to become out of sync. This happens because the update may affect the sort order, and client and server cannot be guaranteed to match for sets of records that have equivalent values for the sort field.
For this reason, after an "add" or "update" operation with a partial cache, the ResultSet
will automatically mark cache for invalidation the next time a fetch operation is performed.
Alternatively, if updatePartialCache
is set to false,
the ResultSet will
simply invalidate cache immediately in this circumstance.
RecordList.SortNormalizer
jsObj
config, configOnly, factoryCreated, factoryProperties, id, scClassName
Constructor and Description |
---|
ResultSet() |
ResultSet(DataSource dataSource) |
ResultSet(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
com.google.gwt.event.shared.HandlerRegistration |
addDataArrivedHandler(DataArrivedHandler handler)
Add a dataArrived handler.
|
boolean |
allMatchingRowsCached()
Do we have a complete client-side cache of records for the current filter criteria?
|
boolean |
allRowsCached()
Do we have a complete client-side cache of all records for this DataSource?
|
java.lang.String[] |
applyFilter(java.lang.String[] data,
Criteria criteria)
The ResultSet will call applyFilter() when it needs to determine whether rows match the current filter criteria.
|
java.lang.String[] |
applyFilter(java.lang.String[] data,
Criteria criteria,
DSRequest requestProperties)
The ResultSet will call applyFilter() when it needs to determine whether rows match the current filter criteria.
|
static ResultSet |
asSGWTComponent(com.google.gwt.core.client.JavaScriptObject jsObj)
Returns the existing SGWT ResultSet, or creates and returns one if none exist,
associated with the supplied
JavaScriptObject . |
int |
compareCriteria(Criteria newCriteria,
Criteria oldCriteria)
Default behavior is to call
DataSource.compareCriteria() to
determine whether new criteria is guaranteed more restrictive, equivalent to the old criteria, or not guaranteed more
restrictive, returning 1, 0 or -1 respectively. |
int |
compareCriteria(Criteria newCriteria,
Criteria oldCriteria,
DSRequest requestProperties) |
int |
compareCriteria(Criteria newCriteria,
Criteria oldCriteria,
DSRequest requestProperties,
java.lang.String policy)
Default behavior is to call
DataSource.compareCriteria() to
determine whether new criteria is guaranteed more restrictive, equivalent to the old criteria, or not guaranteed more
restrictive, returning 1, 0 or -1 respectively. |
com.google.gwt.core.client.JavaScriptObject |
create() |
void |
dataArrived(int startRow,
int endRow)
Deprecated.
This method is not an override point in SmartGWT. Use
addDataArrivedHandler(com.smartgwt.client.data.events.DataArrivedHandler) instead. |
void |
ensureCreated()
Ensures that the underlying SmartClient ResultSet object is created for this ResultSet
instance.
|
void |
fetchRowCount()
For cases where the exact size of the data set is not known due to
progressiveLoading , this method may be used to issue an
explicit fetch request to the data source, asking for an accurate row count for the criteria currently applied to this
ResultSet. |
void |
fetchRowCount(RowCountCallback callback) |
void |
fetchRowCount(RowCountCallback callback,
DSRequest dsRequest)
For cases where the exact size of the data set is not known due to
progressiveLoading , this method may be used to issue an
explicit fetch request to the data source, asking for an accurate row count for the criteria currently applied to this
ResultSet. |
void |
filterLocalData()
Derive the current filtered set of data from the cache of all matching rows.
|
Record |
find(java.util.Map properties)
Checks only loaded rows and will not trigger a fetch.
|
Record |
find(java.lang.String propertyName,
java.lang.Object value)
|
Record[] |
findAll(AdvancedCriteria adCriteria)
Filters all objects according to the AdvancedCriteria passed and will not trigger a fetch.
|
Record[] |
findAll(java.util.Map properties)
Checks only loaded rows and will not trigger a fetch.
|
Record[] |
findAll(java.lang.String propertyName,
boolean value)
Checks only loaded rows and will not trigger a fetch.
|
Record[] |
findAll(java.lang.String propertyName,
java.util.Date value)
Find all objects where property == value in the object.
|
Record[] |
findAll(java.lang.String propertyName,
float value)
Checks only loaded rows and will not trigger a fetch.
|
Record[] |
findAll(java.lang.String propertyName,
int value)
Checks only loaded rows and will not trigger a fetch.
|
Record[] |
findAll(java.lang.String propertyName,
java.lang.Long value)
Checks only loaded rows and will not trigger a fetch.
|
Record[] |
findAll(java.lang.String propertyName,
java.lang.String value)
Checks only loaded rows and will not trigger a fetch.
|
Record |
findByKey(java.util.Map keyValue)
Attempt to find the record in the resultSet that has a primary key value that matches the passed in parameter value.
|
Record |
findByKey(java.lang.String keyValue)
Attempt to find the record in the resultSet that has a primary key value that matches the passed in parameter value.
|
int |
findIndex(java.util.Map properties)
|
int |
findIndex(java.lang.String propertyName,
boolean value)
|
int |
findIndex(java.lang.String propertyName,
java.util.Date value)
|
int |
findIndex(java.lang.String propertyName,
float value)
|
int |
findIndex(java.lang.String propertyName,
int value)
|
int |
findIndex(java.lang.String propertyName,
java.lang.Long value)
|
int |
findIndex(java.lang.String propertyName,
java.lang.String value)
|
int |
findNextIndex(int startIndex,
java.util.Map properties)
|
int |
findNextIndex(int startIndex,
java.lang.String propertyName,
boolean value,
int endIndex)
|
int |
findNextIndex(int startIndex,
java.lang.String propertyName,
java.util.Date value,
int endIndex)
|
int |
findNextIndex(int startIndex,
java.lang.String propertyName,
float value,
int endIndex)
|
int |
findNextIndex(int startIndex,
java.lang.String propertyName,
int value,
int endIndex)
|
int |
findNextIndex(int startIndex,
java.lang.String propertyName,
java.lang.Long value,
int endIndex)
|
int |
findNextIndex(int startIndex,
java.lang.String propertyName,
java.lang.String value,
int endIndex)
|
Record |
get(int pos)
Returns the record at the specified position.
|
RecordList |
getAllCachedRows()
Returns a list of all rows that have been cached.
|
Record[] |
getAllRows()
If the complete set of records for a resultSet is available when the resultSet is created, it can be made available to
the resultSet via this property at initialization time.
|
RecordList |
getAllVisibleRows()
Returns a list of the currently visible data, that is, all rows that match the current
criteria, with null entries or
loading markers for
rows that are not yet loaded or in the process of loading, respectively. |
java.lang.Boolean |
getAlwaysRequestVisibleRows()
If true, records requested only for visible area.
|
boolean |
getApplyRowCountToLength()
If
progressiveLoading is active for a ResultSet we may
not know the true size of the data set being displayed. |
boolean |
getAutoFetchRowCount()
If this ResultSet does not know its length due to
DataSource.progressiveLoading , should a row count fetch
automatically when data is loaded? |
boolean |
getBlockingRowCountFetch()
Will the
row count fetch operation block user interaction by
having showPrompt:true ? |
int[] |
getCachedRange(int rowNum)
Returns the index of the first and last cached row around a given row, or null if the row itself is not cached.
|
Criteria |
getCombinedCriteria()
|
AdvancedCriteria |
getCombinedCriteriaAsAdvancedCriteria()
|
Criteria |
getCriteria()
Filter criteria used whenever records are retrieved.
|
CriteriaPolicy |
getCriteriaPolicy()
Decides under what conditions the cache should be dropped when the
Criteria changes. |
DataSource |
getDataSource()
What
DataSource is this resultSet associated with? |
java.lang.Boolean |
getDisableCacheSync()
By default when the data of this ResultSet's dataSource is modified, the ResultSet will be updated to display these
changes.
|
java.lang.Boolean |
getDropCacheOnUpdate()
Whether to discard all cached rows when a modification operation (add, update, remove) occurs on the ResultSet's
DataSource.
|
int |
getFetchDelay()
Delay in milliseconds before fetching rows.
|
FetchMode |
getFetchMode()
Mode of fetching records from the server.
|
java.lang.String |
getFetchOperation()
The
operationId this ResultSet should use when performing
fetch operations. |
Criteria |
getImplicitCriteria()
Criteria that are never shown to or edited by the user and are cumulative with any criteria provided via
DataBoundComponent.initialCriteria , setCriteria() etc. |
int |
getLength()
Return the total number of records that match the current filter criteria.
|
static Record |
getLoadingMarker()
Returns the singleton marker object that is used as a placeholder for records that are being
loaded from the server.
|
boolean |
getModifiable()
When true, allows the ResultSet to be modified by list APIs
List.addAt() ,
List.set() , and List.removeAt() . |
java.lang.Boolean |
getNeverDropUpdatedRows()
By default when a row is returned by the server, the current
filter\n criteria are applied to it, and it may disappear from the cache. |
static ResultSet |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.util.Map |
getPaletteDefaults()
This method returns a Map of config properties suitable for use as the "defaults"
attribute of a
PaletteNode . |
java.lang.Boolean |
getProgressiveLoading()
Sets
progressive loading mode for this ResultSet. |
java.lang.String[] |
getProperty(java.lang.String property)
Like
List.getProperty() . |
Record[] |
getRange(int start,
int end)
Return the items between position start and end, non-inclusive at the end, possibly containing markers for records that
haven't loaded yet.
|
RecordList |
getRangeAsRecordList(int start,
int end)
Return a RecordList with the items between position start and end, non-inclusive at the end.
|
java.lang.Boolean |
getReapplyUnchangedLocalFilter()
To avoid needless work, the ResultSet by default doesn't refilter the data when methods such as
ListGrid.fetchData() or ListGrid.filterData() are called with unchanged criteria. |
boolean |
getRememberDynamicProgressiveLoading()
If
progressiveLoading is not explicitly set, but the
ResultSet recieves a response from the server where DSResponse.progressiveLoading is set to true, should subsequent requests for other rows in the same data set
explicitly request progressiveLoading via DSRequest.progressiveLoading , as long as the criteria are unchanged and the cache is not explicitly invalidated? |
DSRequest |
getRequestProperties()
Allows to set a DSRequest properties to this ResulSet.
|
int |
getResultSize()
How many rows to retrieve at once.
|
int |
getRowCount()
This method retrieves the row-count for this data set.
|
DSRequest |
getRowCountContext()
Request properties for row-count fetch operations performed by
fetchRowCount() . |
java.lang.String |
getRowCountOperation()
The
operationId this ResultSet should use when performing a
row-count fetch operation due to fetchRowCount() . |
java.lang.Integer[] |
getRowCountRange()
If
getRowCountStatus() is "range" this method will return a
two element array containing the lower and upper bound for the rowCount. |
RowCountStatus |
getRowCountStatus()
This method indicates whether
getRowCount() reflects an accurate
row-count for this data set. |
SortSpecifier[] |
getSort()
Return the current sort-specification for this ResultSet as an Array of
SortSpecifier s. |
java.lang.Boolean |
getUpdateCacheFromRequest()
When a successful Add, Update or Remove type operation fires on this ResultSet's dataSource, if
DSResponse.data is unset, should we integrate the submitted data values
(from the request) into our data-set? This attribute will be passed to DataSource.getUpdatedData() as the useDataFromRequest
parameter. |
java.lang.Boolean |
getUpdatePartialCache()
If set to true, updated and added rows will be integrated into the client-side cache even if paging is enabled and cache
is partial.
|
java.lang.Boolean |
getUseClientFiltering()
Whether to filter data locally when we have a complete cache of all DataSource records for the current criteria, and
the user further restricts the criteria (see
DataSource.compareCriteria() ). |
java.lang.Boolean |
getUseClientSorting()
Whether to sort data locally when all records matching the current criteria have been cached.
|
java.util.Map |
getValueMap(java.lang.String idField,
java.lang.String displayField)
Get a map of the form
{ item[idField] -> item[displayField] } , for all items in the list. |
int |
indexOf(java.lang.Object obj)
Return the position in the list of the first instance of the specified object.
|
int |
indexOf(java.lang.Object obj,
int pos) |
int |
indexOf(java.lang.Object obj,
int pos,
int endPos)
Return the position in the list of the first instance of the specified object.
|
int |
indexOf(Record record)
Return the position in the list of the first instance of the specified object.
|
int |
indexOf(Record record,
int pos,
int endPos)
Return the position in the list of the first instance of the specified object.
|
void |
invalidateCache()
Manually invalidate this ResultSet's cache.
|
static boolean |
isResultSet(com.google.gwt.core.client.JavaScriptObject data) |
boolean |
lengthIsKnown()
Whether the ResultSet knows the length of its data set.
|
boolean |
lengthIsProgressive()
Does the length of this ResultSet as returned by
getLength()
reflect the totalRows reported by a DataSource with ProgressiveLoading enabled? |
boolean |
rangeIsLoaded(int startRow,
int endRow)
Whether the given range of rows has been loaded.
|
void |
resort()
Forcibly resort this ResultSet by the current list of
SortSpecifier s. |
boolean |
rowIsLoaded(int rowNum)
Whether the given row has been loaded.
|
ResultSet |
setAllRows(Record... allRows)
If the complete set of records for a resultSet is available when the resultSet is created, it can be made available to
the resultSet via this property at initialization time.
|
ResultSet |
setAlwaysRequestVisibleRows(java.lang.Boolean alwaysRequestVisibleRows)
If true, records requested only for visible area.
|
ResultSet |
setApplyRowCountToLength(boolean applyRowCountToLength)
If
progressiveLoading is active for a ResultSet we may
not know the true size of the data set being displayed. |
ResultSet |
setAutoFetchRowCount(boolean autoFetchRowCount)
If this ResultSet does not know its length due to
DataSource.progressiveLoading , should a row count fetch
automatically when data is loaded? |
ResultSet |
setBlockingRowCountFetch(boolean blockingRowCountFetch)
Will the
row count fetch operation block user interaction by
having showPrompt:true ? |
ResultSet |
setCriteria(Criteria criteria)
Filter criteria used whenever records are retrieved.
|
ResultSet |
setCriteriaPolicy(CriteriaPolicy criteriaPolicy)
Decides under what conditions the cache should be dropped when the
Criteria changes. |
ResultSet |
setDataSource(DataSource dataSource)
What
DataSource is this resultSet associated with? |
ResultSet |
setDisableCacheSync(java.lang.Boolean disableCacheSync)
By default when the data of this ResultSet's dataSource is modified, the ResultSet will be updated to display these
changes.
|
ResultSet |
setDropCacheOnUpdate(java.lang.Boolean dropCacheOnUpdate)
Whether to discard all cached rows when a modification operation (add, update, remove) occurs on the ResultSet's
DataSource.
|
ResultSet |
setFetchDelay(int fetchDelay)
Delay in milliseconds before fetching rows.
|
ResultSet |
setFetchMode(FetchMode fetchMode)
Mode of fetching records from the server.
|
ResultSet |
setFetchOperation(java.lang.String fetchOperation)
The
operationId this ResultSet should use when performing
fetch operations. |
void |
setFullLength(int length)
Set the total number of rows available from the server that match the current filter criteria for this ResultSet.
|
ResultSet |
setImplicitCriteria(Criteria implicitCriteria)
Criteria that are never shown to or edited by the user and are cumulative with any criteria provided via
DataBoundComponent.initialCriteria , setCriteria() etc. |
ResultSet |
setInitialData(Record... initialData)
Initial set of data for the ResultSet.
|
ResultSet |
setInitialLength(java.lang.Integer initialLength)
Initial value of the data set length.
|
void |
setInitialSort(SortSpecifier... sortSpecifiers)
Initial multi property sort specification for this ResultSet's data.
|
void |
setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj) |
ResultSet |
setModifiable(boolean modifiable)
When true, allows the ResultSet to be modified by list APIs
List.addAt() ,
List.set() , and List.removeAt() . |
ResultSet |
setNeverDropUpdatedRows(java.lang.Boolean neverDropUpdatedRows)
By default when a row is returned by the server, the current
filter\n criteria are applied to it, and it may disappear from the cache. |
ResultSet |
setProgressiveLoading(java.lang.Boolean progressiveLoading)
Sets
progressive loading mode for this ResultSet. |
ResultSet |
setReapplyUnchangedLocalFilter(java.lang.Boolean reapplyUnchangedLocalFilter)
To avoid needless work, the ResultSet by default doesn't refilter the data when methods such as
ListGrid.fetchData() or ListGrid.filterData() are called with unchanged criteria. |
ResultSet |
setRememberDynamicProgressiveLoading(boolean rememberDynamicProgressiveLoading)
If
progressiveLoading is not explicitly set, but the
ResultSet recieves a response from the server where DSResponse.progressiveLoading is set to true, should subsequent requests for other rows in the same data set
explicitly request progressiveLoading via DSRequest.progressiveLoading , as long as the criteria are unchanged and the cache is not explicitly invalidated? |
ResultSet |
setRequestProperties(DSRequest requestProperties)
Allows to set a DSRequest properties to this ResulSet.
|
ResultSet |
setResultSize(int resultSize)
How many rows to retrieve at once.
|
ResultSet |
setRowCountContext(DSRequest rowCountContext)
Request properties for row-count fetch operations performed by
fetchRowCount() . |
ResultSet |
setRowCountOperation(java.lang.String rowCountOperation)
The
operationId this ResultSet should use when performing a
row-count fetch operation due to fetchRowCount() . |
void |
setSort()
Sort this ResultSet by the passed list of
SortSpecifier s. |
ResultSet |
setSortSpecifiers(SortSpecifier... sortSpecifiers)
Initial sort specifiers for a ResultSet.
|
ResultSet |
setUpdateCacheFromRequest(java.lang.Boolean updateCacheFromRequest)
When a successful Add, Update or Remove type operation fires on this ResultSet's dataSource, if
DSResponse.data is unset, should we integrate the submitted data values
(from the request) into our data-set? This attribute will be passed to DataSource.getUpdatedData() as the useDataFromRequest
parameter. |
ResultSet |
setUpdatePartialCache(java.lang.Boolean updatePartialCache)
If set to true, updated and added rows will be integrated into the client-side cache even if paging is enabled and cache
is partial.
|
ResultSet |
setUseClientFiltering(java.lang.Boolean useClientFiltering)
Whether to filter data locally when we have a complete cache of all DataSource records for the current criteria, and
the user further restricts the criteria (see
DataSource.compareCriteria() ). |
ResultSet |
setUseClientSorting(java.lang.Boolean useClientSorting)
Whether to sort data locally when all records matching the current criteria have been cached.
|
ResultSet |
sortByProperty(java.lang.String property,
boolean up)
Sort this ResultSet by a property of each record.
|
ResultSet |
sortByProperty(java.lang.String property,
boolean up,
Function normalizer) |
ResultSet |
sortByProperty(java.lang.String property,
boolean up,
Function normalizer,
java.lang.Object context)
Sort this ResultSet by a property of each record.
|
boolean |
unsort()
Clear any
sort specifiers applied to this ResultSet, while
maintaining the current order of records. |
boolean |
usingFilteredData()
Determine whether the ResultSet is showing a filtered, proper subset of the cached rows.
|
boolean |
willFetchData(Criteria newCriteria)
Will changing the criteria for this resultSet require fetching new data from the server, or can the new criteria be
satisfied from data already cached on the client?
Second textMatchStyle parameter determines whether a
change of text-match style will require a server fetch - for example if filter is being changed between an exact match
(from e.g: ListGrid.fetchData() ) and a substring match
(from e.g: ListGrid.filterData() ).This method can be used to determine whether ListGrid.fetchData() or ListGrid.filterData() would cause a server side fetch when passed
a certain set of criteria. |
boolean |
willFetchData(Criteria newCriteria,
TextMatchStyle textMatchStyle)
Will changing the criteria for this resultSet require fetching new data from the server, or can the new criteria be
satisfied from data already cached on the client?
Second textMatchStyle parameter determines whether a
change of text-match style will require a server fetch - for example if filter is being changed between an exact match
(from e.g: ListGrid.fetchData() ) and a substring match
(from e.g: ListGrid.filterData() ).This method can be used to determine whether ListGrid.fetchData() or ListGrid.filterData() would cause a server side fetch when passed
a certain set of criteria. |
add, addAt, addDataChangedHandler, addList, addList, addListAt, contains, contains, containsAll, duplicate, equals, find, find, find, find, findIndex, findNextIndex, findNextIndex, findNextIndex, first, getItems, getJsObj, getOrCreateJsObj, getRangeList, intersect, isARecordList, isCreated, isEmpty, last, lastIndexOf, lastIndexOf, remove, removeAt, removeList, set, setLength, setSort, sort, sort, sortByProperty, toArray
addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getID, getRef, getRuleScope, getScClassName, getTestInstance, hasAutoAssignedID, hasDynamicProperty, internalSetID, internalSetID, isConfigOnly, isFactoryCreated, onBind, onInit, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setFactoryCreated, setID, setProperty, setProperty, setProperty, setProperty, setRuleScope, setScClassName
public ResultSet()
public ResultSet(com.google.gwt.core.client.JavaScriptObject jsObj)
public ResultSet(DataSource dataSource)
public static ResultSet getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
setJavaScriptObject
in class BaseClass
public com.google.gwt.core.client.JavaScriptObject create()
create
in class RecordList
public ResultSet setAllRows(Record... allRows) throws java.lang.IllegalStateException
This cached data can be dropped via a call to invalidateCache()
.
See also initialData
and initialLength
as an alternative approach for initializing a
ResultSet with a partial cache, such that data paging will occur as uncached rows are requested.
Note that
developers wishing to synchronously access a filtered set of client side data may wish to consider creating a FilteredList
.
If this method is called after the component has been drawn/initialized:
Update the allRows
client-side cache of data at runtime.
This method is useful for cases where a full, unfiltered set of data is present on the client and developers wish to filter that data-set locally without going through a fetch operation against a DataSource.
Developers using this pattern may also wish to consider the FilteredList
class.
Note : This is an advanced setting
allRows
- New set of unfiltered cache data. Default value is nullResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdpublic Record[] getAllRows()
This cached data can be dropped via a call to invalidateCache()
.
See also initialData
and initialLength
as an alternative approach for initializing a
ResultSet with a partial cache, such that data paging will occur as uncached rows are requested.
Note that
developers wishing to synchronously access a filtered set of client side data may wish to consider creating a FilteredList
.
public ResultSet setAlwaysRequestVisibleRows(java.lang.Boolean alwaysRequestVisibleRows) throws java.lang.IllegalStateException
Note : This is an advanced setting
alwaysRequestVisibleRows
- New alwaysRequestVisibleRows value. Default value is falseResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getAlwaysRequestVisibleRows()
public ResultSet setApplyRowCountToLength(boolean applyRowCountToLength) throws java.lang.IllegalStateException
progressiveLoading
is active for a ResultSet we may
not know the true size of the data set being displayed. However the exact length may be known thanks to DSResponse.estimatedTotalRows
containing an exact row count,
or due to an explicit row count fetch
having been performed.
If we have an accurate, exact row count, should this be applied to our length
automatically? Doing so means that if this ResultSet is displayed
in a ListGrid
, the scrollable area will reflect the true size of the data set
and the user may drag-scroll all the way to the end of this data set. Depending on how the server side data storage is
implemented and the generated request, requesting row ranges starting at a very large index can be expensive, so this
is not always desirable.
Note that developers may always explicitly tell a ResultSet the true size of its data set
while progressive loading is active via setFullLength()
Note : This is an advanced setting
applyRowCountToLength
- New applyRowCountToLength value. Default value is falseResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdGrid row-range and row-count display
public boolean getApplyRowCountToLength()
progressiveLoading
is active for a ResultSet we may
not know the true size of the data set being displayed. However the exact length may be known thanks to DSResponse.estimatedTotalRows
containing an exact row count,
or due to an explicit row count fetch
having been performed.
If we have an accurate, exact row count, should this be applied to our length
automatically? Doing so means that if this ResultSet is displayed
in a ListGrid
, the scrollable area will reflect the true size of the data set
and the user may drag-scroll all the way to the end of this data set. Depending on how the server side data storage is
implemented and the generated request, requesting row ranges starting at a very large index can be expensive, so this
is not always desirable.
Note that developers may always explicitly tell a ResultSet the true size of its data set
while progressive loading is active via setFullLength()
Grid row-range and row-count display
public ResultSet setAutoFetchRowCount(boolean autoFetchRowCount)
DataSource.progressiveLoading
, should a row count fetch
automatically when data is loaded? The fetch will be issued when the first page of data arrives from the server as part of a progressive-loading response. If the cache is invalidated or the criteria change, a new row count fetch will be issued automatically when new data arrives that does not have an accurate row count.
autoFetchRowCount
- New autoFetchRowCount value. Default value is falseResultSet
instance, for chaining setter callspublic boolean getAutoFetchRowCount()
DataSource.progressiveLoading
, should a row count fetch
automatically when data is loaded? The fetch will be issued when the first page of data arrives from the server as part of a progressive-loading response. If the cache is invalidated or the criteria change, a new row count fetch will be issued automatically when new data arrives that does not have an accurate row count.
public ResultSet setBlockingRowCountFetch(boolean blockingRowCountFetch) throws java.lang.IllegalStateException
row count fetch operation
block user interaction by
having showPrompt:true
?blockingRowCountFetch
- New blockingRowCountFetch value. Default value is trueResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdGrid row-range and row-count display
public boolean getBlockingRowCountFetch()
row count fetch operation
block user interaction by
having showPrompt:true
?Grid row-range and row-count display
public ResultSet setCriteria(Criteria criteria)
Use setCriteria()
to change the criteria after initialization.
If this method is called after the component has been drawn/initialized:
Set the filter criteria to use when fetching rows.
Depending on the result of compareCriteria()
and settings for useClientFiltering
/ FetchMode
, setting criteria may cause a trip to the server to get a new set of rows, or may simply cause already-fetched rows to be re-filtered according to the new Criteria. In either case, the dataset length available from getLength()
may change and rows will appear at different indices.
The filter criteria can be changed while server fetches for data matching the old criteria are still outstanding. If this is the case, the ResultSet will make sure that any records received matching the old criteria are not added to the cache for the new criteria. Any callbacks for responses to the outstanding requests are fired as normal, and the responses' totalRows
counts are kept (as they are still potentially meaningful to components using the ResultSet), but the response data is cleared so that it won't be used inadvertently as data matching the new criteria.
Note: for simple Criteria, any field values in the criteria explicitly specified as null will be passed to the server. By default the server then returns only records whose value is null for that field. This differs from certain higher level methods such as ListGrid.fetchData()
which prune null criteria fields before performing a fetch operation.
criteria
- the filter criteria. Default value is nullResultSet
instance, for chaining setter callspublic Criteria getCriteria()
Use setCriteria()
to change the criteria after initialization.
public ResultSet setCriteriaPolicy(CriteriaPolicy criteriaPolicy)
Criteria
changes.
Note : This is an advanced setting
criteriaPolicy
- New criteriaPolicy value. Default value is nullResultSet
instance, for chaining setter callsCriteria
,
DataSource.setCriteriaPolicy(com.smartgwt.client.types.CriteriaPolicy)
public CriteriaPolicy getCriteriaPolicy()
Criteria
changes.Criteria
,
DataSource.getCriteriaPolicy()
public ResultSet setDataSource(DataSource dataSource) throws java.lang.IllegalStateException
DataSource
is this resultSet associated with?dataSource
- New dataSource value. Default value is nullResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdDataBinding
,
DataSource fields Examplepublic DataSource getDataSource()
DataSource
is this resultSet associated with?DataBinding
,
DataSource fields Examplepublic ResultSet setDisableCacheSync(java.lang.Boolean disableCacheSync) throws java.lang.IllegalStateException
Note : This is an advanced setting
disableCacheSync
- New disableCacheSync value. Default value is falseResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getDisableCacheSync()
public ResultSet setDropCacheOnUpdate(java.lang.Boolean dropCacheOnUpdate) throws java.lang.IllegalStateException
A ResultSet that has a complete cache for the current filter criteria can potentially incorporate a
newly created or updated row based on the data that the server returns when a modification operation completes. However
this is not always possible for ResultSets that show some types of joins, or when the server cannot easily return update
data. In this case set dropCacheOnUpdate
to cause the cache to be discarded when an update occurs.
dropCacheOnUpdate
can be set either directly on a ResultSet, or on a DataSource in order to affect all
ResultSets on that DataSource.
Note : This is an advanced setting
dropCacheOnUpdate
- New dropCacheOnUpdate value. Default value is falseResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getDropCacheOnUpdate()
A ResultSet that has a complete cache for the current filter criteria can potentially incorporate a
newly created or updated row based on the data that the server returns when a modification operation completes. However
this is not always possible for ResultSets that show some types of joins, or when the server cannot easily return update
data. In this case set dropCacheOnUpdate
to cause the cache to be discarded when an update occurs.
dropCacheOnUpdate
can be set either directly on a ResultSet, or on a DataSource in order to affect all
ResultSets on that DataSource.
public ResultSet setFetchDelay(int fetchDelay)
When a get() or getRange() call asked for rows that haven't been loaded, the ResultSet will wait before actually triggering the request. If, during the delay, more get() or getRange() calls are made for missing rows, the final fetch to the server will reflect the most recently requested rows.
The intent of this delay is to avoid triggering many unnecessary fetches during drag-scrolling and similar user interactions.
Note : This is an advanced setting
fetchDelay
- New fetchDelay value. Default value is 0ResultSet
instance, for chaining setter callspublic int getFetchDelay()
When a get() or getRange() call asked for rows that haven't been loaded, the ResultSet will wait before actually triggering the request. If, during the delay, more get() or getRange() calls are made for missing rows, the final fetch to the server will reflect the most recently requested rows.
The intent of this delay is to avoid triggering many unnecessary fetches during drag-scrolling and similar user interactions.
public ResultSet setFetchMode(FetchMode fetchMode) throws java.lang.IllegalStateException
"local"
if allRows
is specified, otherwise "paged"
.
Note : This is an advanced setting
public FetchMode getFetchMode()
"local"
if allRows
is specified, otherwise "paged"
.FetchMode
public ResultSet setFetchOperation(java.lang.String fetchOperation) throws java.lang.IllegalStateException
operationId
this ResultSet should use when performing
fetch operations. Note: if this property is not explicitly set and, for ResultSets automatically created by a
component, DataBoundComponent.fetchOperation
is
also unset, a placeholder value of <dataSourceId>_<operationType> may be reported (e.g. "supplyItem_fetch").
fetchOperation
- New fetchOperation value. Default value is nullResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdpublic java.lang.String getFetchOperation()
operationId
this ResultSet should use when performing
fetch operations. Note: if this property is not explicitly set and, for ResultSets automatically created by a
component, DataBoundComponent.fetchOperation
is
also unset, a placeholder value of <dataSourceId>_<operationType> may be reported (e.g. "supplyItem_fetch").
public ResultSet setImplicitCriteria(Criteria implicitCriteria)
DataBoundComponent.initialCriteria
, setCriteria()
etc.implicitCriteria
- New implicitCriteria value. Default value is nullResultSet
instance, for chaining setter callspublic Criteria getImplicitCriteria()
DataBoundComponent.initialCriteria
, setCriteria()
etc.public ResultSet setInitialData(Record... initialData) throws java.lang.IllegalStateException
This data will be treated exactly as though it were the data returned from the ResultSet's first server fetch.
By default, initialData
will be considered a complete response (all
rows that match the Criteria
which the ResultSet was initialized with).
Set initialLength
to treat initialData
as a partial
response, equivalent to receiving a DSResponse
with startRow:0
,
endRow:initialData.length
and totalRows:initialLength
. Normal data paging will then occur if
data is requested for row indices not filled via initialData
.
initialData
may be provided
as a "sparse" array, that is, slots may be left null indicating rows that have not been loaded. In this way you can
create a ResultSet that is missing rows at the beginning of the dataset, but has loaded rows toward the end, so that you
can create a component that is scrolled to a particular position of a dataset without loading rows at the beginning.
To keep the logic simple and support partial initialData
, the data is assumed to be already sorted and
filtered according to the sortSpecifiers
and criteria
supplied to the ResultSet, since otherwise, for partial
initialData
, sorting or filtering would immediately cause the data to be discarded.
If
initialData
is complete and needs to be sorted or filtered, then don't pass the sortSpecifiers
or criteria
, respectively, when creating the ResultSet. Instead, call
setCriteria()
or setSort()
, respectively, on the instance afterwards.
Note : This is an advanced setting
initialData
- New initialData value. Default value is nullResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdsetFetchMode(com.smartgwt.client.types.FetchMode)
,
setUseClientFiltering(java.lang.Boolean)
public ResultSet setInitialLength(java.lang.Integer initialLength) throws java.lang.IllegalStateException
To create a ResultSet with it's cache partly filled, see initialData
.
Note : This is an advanced setting
initialLength
- New initialLength value. Default value is nullResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdpublic ResultSet setModifiable(boolean modifiable)
List.addAt()
,
List.set()
, and List.removeAt()
. Only applies to fetchMode
:"local"
ResultSets, since in all other cases, such modifications would break the consistency of server and client row numbering
needed for data paging, and also create some issues with automatic cache synchronization. See the "Modifying
ResultSets" subtopic in the ResultSet Overview
for the alternative approach
of updating the DataSource
. One known case where modification can be useful is when
an array has been passed to ListGrid.setData()
for a ListGrid
with ListGrid.filterLocalData
:true. If the data is
filtered using the filterEditor
, then a new local
ResultSet will be created as data
to reflect the filtering.
modifiable
- New modifiable value. Default value is falseResultSet
instance, for chaining setter callsDataSource.addData(com.smartgwt.client.data.Record)
,
DataSource.removeData(com.smartgwt.client.data.Record)
,
DataSource.updateCaches(com.smartgwt.client.data.DSResponse)
public boolean getModifiable()
List.addAt()
,
List.set()
, and List.removeAt()
. Only applies to fetchMode
:"local"
ResultSets, since in all other cases, such modifications would break the consistency of server and client row numbering
needed for data paging, and also create some issues with automatic cache synchronization. See the "Modifying
ResultSets" subtopic in the ResultSet Overview
for the alternative approach
of updating the DataSource
. One known case where modification can be useful is when
an array has been passed to ListGrid.setData()
for a ListGrid
with ListGrid.filterLocalData
:true. If the data is
filtered using the filterEditor
, then a new local
ResultSet will be created as data
to reflect the filtering.
DataSource.addData(com.smartgwt.client.data.Record)
,
DataSource.removeData(com.smartgwt.client.data.Record)
,
DataSource.updateCaches(com.smartgwt.client.data.DSResponse)
public ResultSet setNeverDropUpdatedRows(java.lang.Boolean neverDropUpdatedRows) throws java.lang.IllegalStateException
filter\n criteria
are applied to it, and it may disappear from the cache. Set this flag to true to disable this behavior.
Note : This is an advanced setting
neverDropUpdatedRows
- New neverDropUpdatedRows value. Default value is falseResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getNeverDropUpdatedRows()
filter\n criteria
are applied to it, and it may disappear from the cache. Set this flag to true to disable this behavior.
public ResultSet setProgressiveLoading(java.lang.Boolean progressiveLoading)
progressive loading mode
for this ResultSet. Any
DSRequest
s issued by this ResultSet will copy this setting onto the request, overriding
the OperationBinding- and DataSource-level settings. This setting is applied automatically by DataBoundComponent
s that have their own explicit setting for progressiveLoading
See also the rememberDynamicProgressiveLoading
attribute.
progressiveLoading
- New progressiveLoading value. Default value is nullResultSet
instance, for chaining setter callsDataSource.setProgressiveLoading(java.lang.Boolean)
,
OperationBinding.progressiveLoading
,
DSRequest.setProgressiveLoading(java.lang.Boolean)
,
Progressive Loading
public java.lang.Boolean getProgressiveLoading()
progressive loading mode
for this ResultSet. Any
DSRequest
s issued by this ResultSet will copy this setting onto the request, overriding
the OperationBinding- and DataSource-level settings. This setting is applied automatically by DataBoundComponent
s that have their own explicit setting for progressiveLoading
See also the rememberDynamicProgressiveLoading
attribute.
DataSource.getProgressiveLoading()
,
OperationBinding.progressiveLoading
,
DSRequest.getProgressiveLoading()
,
Progressive Loading
public ResultSet setReapplyUnchangedLocalFilter(java.lang.Boolean reapplyUnchangedLocalFilter)
ListGrid.fetchData()
or ListGrid.filterData()
are called with unchanged criteria.
However, this property can be set true for backward compatibility to force refiltering if we're filtering locally
and the criteria haven't changed. but are narrower
than the criteria used to fetch the current cache. Going forward, we may deprecate this property, so you should move to approach that doesn't require such notification in the case of unchanged criteria.
Note : This is an advanced setting
reapplyUnchangedLocalFilter
- New reapplyUnchangedLocalFilter value. Default value is nullResultSet
instance, for chaining setter callswillFetchData(com.smartgwt.client.data.Criteria)
public java.lang.Boolean getReapplyUnchangedLocalFilter()
ListGrid.fetchData()
or ListGrid.filterData()
are called with unchanged criteria.
However, this property can be set true for backward compatibility to force refiltering if we're filtering locally
and the criteria haven't changed. but are narrower
than the criteria used to fetch the current cache. Going forward, we may deprecate this property, so you should move to approach that doesn't require such notification in the case of unchanged criteria.
willFetchData(com.smartgwt.client.data.Criteria)
public ResultSet setRememberDynamicProgressiveLoading(boolean rememberDynamicProgressiveLoading)
progressiveLoading
is not explicitly set, but the
ResultSet recieves a response from the server where DSResponse.progressiveLoading
is set to true, should subsequent requests for other rows in the same data set
explicitly request progressiveLoading via DSRequest.progressiveLoading
, as long as the criteria are unchanged and the cache is not explicitly invalidated?
This property is useful for the case where the server side DataSource.progressiveLoadingThreshold
enabled
progressive loading after the row-count query determined that the requested data set was very large. By explicitly
requesting progressive loading
for subsequent fetches
the server is able to avoid an unnecessary and potentially expensive row-count query while returning other rows from the
same data set.
rememberDynamicProgressiveLoading
- New rememberDynamicProgressiveLoading value. Default value is trueResultSet
instance, for chaining setter callsProgressive Loading
public boolean getRememberDynamicProgressiveLoading()
progressiveLoading
is not explicitly set, but the
ResultSet recieves a response from the server where DSResponse.progressiveLoading
is set to true, should subsequent requests for other rows in the same data set
explicitly request progressiveLoading via DSRequest.progressiveLoading
, as long as the criteria are unchanged and the cache is not explicitly invalidated?
This property is useful for the case where the server side DataSource.progressiveLoadingThreshold
enabled
progressive loading after the row-count query determined that the requested data set was very large. By explicitly
requesting progressive loading
for subsequent fetches
the server is able to avoid an unnecessary and potentially expensive row-count query while returning other rows from the
same data set.
Progressive Loading
public ResultSet setRequestProperties(DSRequest requestProperties) throws java.lang.IllegalStateException
requestProperties
- New requestProperties value. Default value is nullResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdpublic DSRequest getRequestProperties()
public ResultSet setResultSize(int resultSize)
Applicable only with fetchMode: "paged"
. When a paged ResultSet is
asked for rows that have not yet been loaded, it will fetch adjacent rows that are likely to be required soon, in
batches of this size.
Note : This is an advanced setting
resultSize
- New resultSize value. Default value is 75ResultSet
instance, for chaining setter callspublic int getResultSize()
Applicable only with fetchMode: "paged"
. When a paged ResultSet is
asked for rows that have not yet been loaded, it will fetch adjacent rows that are likely to be required soon, in
batches of this size.
public ResultSet setRowCountContext(DSRequest rowCountContext) throws java.lang.IllegalStateException
fetchRowCount()
. The row-count fetch operation will ultimately be constructed as follows:
rowCountContext
with the resultSet context
,
with rowCountContext properties taking precedenceDSRequest.startRow
and DSRequest.endRow
set to zero, and DSRequest.progressiveLoading
will be explicitly set to false.
The request will also have DSRequest.showPrompt
set to blockingRowCountFetch
so user interactions can be
blocked while the row count is actively being performed.dsRequest
parameter of the fetchRowCount()
method.Note : This is an advanced setting
rowCountContext
- New rowCountContext value. Default value is nullResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdGrid row-range and row-count display
public DSRequest getRowCountContext()
fetchRowCount()
. The row-count fetch operation will ultimately be constructed as follows:
rowCountContext
with the resultSet context
,
with rowCountContext properties taking precedenceDSRequest.startRow
and DSRequest.endRow
set to zero, and DSRequest.progressiveLoading
will be explicitly set to false.
The request will also have DSRequest.showPrompt
set to blockingRowCountFetch
so user interactions can be
blocked while the row count is actively being performed.dsRequest
parameter of the fetchRowCount()
method.Grid row-range and row-count display
public ResultSet setRowCountOperation(java.lang.String rowCountOperation) throws java.lang.IllegalStateException
operationId
this ResultSet should use when performing a
row-count fetch operation due to fetchRowCount()
. See also
rowCountContext
rowCountOperation
- New rowCountOperation value. Default value is nullResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdGrid row-range and row-count display
public java.lang.String getRowCountOperation()
operationId
this ResultSet should use when performing a
row-count fetch operation due to fetchRowCount()
. See also
rowCountContext
Grid row-range and row-count display
public ResultSet setSortSpecifiers(SortSpecifier... sortSpecifiers) throws java.lang.IllegalStateException
setSort()
and getSort()
to sort the data after initialization rather than attempting to
read or modify this property directly. Note: if initialData
was specified, the data is assumed to already be sorted to match this sort configuration.
Note : This is an advanced setting
sortSpecifiers
- New sortSpecifiers value. Default value is nullResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdpublic ResultSet setUpdateCacheFromRequest(java.lang.Boolean updateCacheFromRequest) throws java.lang.IllegalStateException
DSResponse.data
is unset, should we integrate the submitted data values
(from the request) into our data-set? This attribute will be passed to DataSource.getUpdatedData()
as the useDataFromRequest
parameter.
Note : This is an advanced setting
updateCacheFromRequest
- New updateCacheFromRequest value. Default value is trueResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getUpdateCacheFromRequest()
DSResponse.data
is unset, should we integrate the submitted data values
(from the request) into our data-set? This attribute will be passed to DataSource.getUpdatedData()
as the useDataFromRequest
parameter.public ResultSet setUpdatePartialCache(java.lang.Boolean updatePartialCache) throws java.lang.IllegalStateException
updatePartialCache
is false, the cache will be invalidated and new data fetched. If updatePartialCache is enabled and an "add" or "update" operation succeeds with a partial cache:
Note : This is an advanced setting
updatePartialCache
- New updatePartialCache value. Default value is trueResultSet
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getUpdatePartialCache()
updatePartialCache
is false, the cache will be invalidated and new data fetched. If updatePartialCache is enabled and an "add" or "update" operation succeeds with a partial cache:
public ResultSet setUseClientFiltering(java.lang.Boolean useClientFiltering)
DataSource.compareCriteria()
). This may need to be disabled if client-side filtering differs from server-side filtering in a way that affects functionality or is surprising.
Note that you can also prevent client-side filtering
for certain fields, by setting them to filterOn:
'serverOnly'
.
This setting is distinct from fetchMode:"local"
, which explicitly loads all available
DataSource records up front and always performs all filtering on the client.
See applyFilter()
for default filtering behavior.
NOTE: even with
useClientFiltering false, client-side filtering will be used during cache sync to determine if an updated or added row
matches the current criteria. To avoid relying on client-side filtering in this case, either:
- avoid returning
update data when the updated row doesn't match the current filter
- set dropCacheOnUpdate
Note : This is an advanced setting
useClientFiltering
- New useClientFiltering value. Default value is trueResultSet
instance, for chaining setter callspublic java.lang.Boolean getUseClientFiltering()
DataSource.compareCriteria()
). This may need to be disabled if client-side filtering differs from server-side filtering in a way that affects functionality or is surprising.
Note that you can also prevent client-side filtering
for certain fields, by setting them to filterOn:
'serverOnly'
.
This setting is distinct from fetchMode:"local"
, which explicitly loads all available
DataSource records up front and always performs all filtering on the client.
See applyFilter()
for default filtering behavior.
NOTE: even with
useClientFiltering false, client-side filtering will be used during cache sync to determine if an updated or added row
matches the current criteria. To avoid relying on client-side filtering in this case, either:
- avoid returning
update data when the updated row doesn't match the current filter
- set dropCacheOnUpdate
public ResultSet setUseClientSorting(java.lang.Boolean useClientSorting)
This may need to be disabled if client-side sort order differs from server-side sort order in a way that affects functionality or is surprising.
Note : This is an advanced setting
useClientSorting
- New useClientSorting value. Default value is trueResultSet
instance, for chaining setter callspublic java.lang.Boolean getUseClientSorting()
This may need to be disabled if client-side sort order differs from server-side sort order in a way that affects functionality or is surprising.
public boolean allMatchingRowsCached()
Returns false
if
this is a paged data set, and the entire set of records that match the current criteria has not been retrieved from the
server. In other words, a return value of false
means that this ResultSet
has a partial cache.
public boolean allRowsCached()
Becomes true only when the ResultSet obtains a complete cache after a fetch with empty criteria.
public java.lang.String[] applyFilter(java.lang.String[] data, Criteria criteria)
Default behavior is to call DataSource.applyFilter()
to
determine which rows match that provided criteria.
Override this method or DataSource.applyFilter()
to implement your own client-side filtering
behavior.
data
- the list of rowscriteria
- the filter criteriapublic java.lang.String[] applyFilter(java.lang.String[] data, Criteria criteria, DSRequest requestProperties)
Default behavior is to call DataSource.applyFilter()
to
determine which rows match that provided criteria.
Override this method or DataSource.applyFilter()
to implement your own client-side filtering
behavior.
data
- the list of rowscriteria
- the filter criteriarequestProperties
- dataSource request propertiespublic int compareCriteria(Criteria newCriteria, Criteria oldCriteria)
DataSource.compareCriteria()
to
determine whether new criteria is guaranteed more restrictive, equivalent to the old criteria, or not guaranteed more
restrictive, returning 1, 0 or -1 respectively. See DataSource.compareCriteria()
for a full explanation of the default behavior. Override this method or DataSource.compareCriteria()
to implement your own client-side
filtering behavior.
newCriteria
- new filter criteriaoldCriteria
- old filter criteriaCriteriaPolicy
public int compareCriteria(Criteria newCriteria, Criteria oldCriteria, DSRequest requestProperties)
public int compareCriteria(Criteria newCriteria, Criteria oldCriteria, DSRequest requestProperties, java.lang.String policy)
DataSource.compareCriteria()
to
determine whether new criteria is guaranteed more restrictive, equivalent to the old criteria, or not guaranteed more
restrictive, returning 1, 0 or -1 respectively. See DataSource.compareCriteria()
for a full explanation of the default behavior. Override this method or DataSource.compareCriteria()
to implement your own client-side
filtering behavior.
newCriteria
- new filter criteriaoldCriteria
- old filter criteriarequestProperties
- dataSource request propertiespolicy
- overrides CriteriaPolicy
CriteriaPolicy
public com.google.gwt.event.shared.HandlerRegistration addDataArrivedHandler(DataArrivedHandler handler)
Notification fired when data has arrived from the server and has been successfully integrated into the cache.
When
dataArrived()
fires, an immediate call to getRange()
with the startRow
and
endRow
passed as arguments will return a List with no loading markers
.
Note that dataArrived()
won't
fire in the case of the owning component filtering with unchanged criteria (for example using ListGrid.fetchData()
or ListGrid.filterData()
). To support backward compatibility, the
property ResultSet.reapplyUnchangedLocalFilter
can be set to force dataArrived()
to be called if the ResultSet is filtering locally
and the criteria haven't changed but are narrower
than the criteria used to fetch the current cache.
addDataArrivedHandler
in interface HasDataArrivedHandlers
handler
- the dataArrived handlerHandlerRegistration
used to remove this handlerpublic void fetchRowCount()
progressiveLoading
, this method may be used to issue an
explicit fetch request to the data source, asking for an accurate row count for the criteria currently applied to this
ResultSet. The row count will then be available via getRowCount()
, and if applyRowCountToLength
is
true, the length
of the ResultSet will be updated to reflect the
reported value. If the criteria
for the ResultSet change
while a row count fetch is in progress, the rowCount
for the
resultSet will not be updated. In this case the callback passed to this method will still fire, with the
criteriaChanged parameter set to true
Note the fetch request sent to the dataSource will have DSRequest.progressiveLoading
explicitly set to false and
startRow:0
and endRow:0
. See rowCountContext
for full details of the request that will be sent to the dataSource.
Smart GWT server side
dataSources will process such a request by calculating the row-count (for serverType:"sql"
, this means issuing a row-count database
query), skipping any logic to retrieve actual data, and return a response with progressiveLoading:false
and an accurate DSResponse.totalRows
.
If this ResultSet is backed by a custom
dataSource implementation, it is recommended that the dataSource either also returns a response with progressiveLoading:false
and an accurate DSResponse.totalRows
, or uses the DSResponse.estimatedTotalRows
attribute to indicate an
accurate row count for the data set.
The fetch issued by this method will be marked as a background request
.
Grid row-range and row-count display
public void fetchRowCount(RowCountCallback callback)
fetchRowCount()
public void fetchRowCount(RowCountCallback callback, DSRequest dsRequest)
progressiveLoading
, this method may be used to issue an
explicit fetch request to the data source, asking for an accurate row count for the criteria currently applied to this
ResultSet. The row count will then be available via getRowCount()
, and if applyRowCountToLength
is
true, the length
of the ResultSet will be updated to reflect the
reported value. If the criteria
for the ResultSet change
while a row count fetch is in progress, the rowCount
for the
resultSet will not be updated. In this case the callback passed to this method will still fire, with the
criteriaChanged parameter set to true
Note the fetch request sent to the dataSource will have DSRequest.progressiveLoading
explicitly set to false and
startRow:0
and endRow:0
. See rowCountContext
for full details of the request that will be sent to the dataSource.
Smart GWT server side
dataSources will process such a request by calculating the row-count (for serverType:"sql"
, this means issuing a row-count database
query), skipping any logic to retrieve actual data, and return a response with progressiveLoading:false
and an accurate DSResponse.totalRows
.
If this ResultSet is backed by a custom
dataSource implementation, it is recommended that the dataSource either also returns a response with progressiveLoading:false
and an accurate DSResponse.totalRows
, or uses the DSResponse.estimatedTotalRows
attribute to indicate an
accurate row count for the data set.
The fetch issued by this method will be marked as a background request
.
callback
- Callback to fire when the fetch request completes. To retrieve details of the row-count that was retrieved from the
server, use the getRowCount()
and getRowCountStatus()
methods.dsRequest
- Custom properties for the row count fetch requestGrid row-range and row-count display
public void filterLocalData()
This method is automatically called by
setCriteria()
when criteria have actually changed, as well as in
various other situations. You could only need to call this method directly if:
useClientFiltering
:true) and
active allMatchingRowsCached()
. get()
) public Record findByKey(java.util.Map keyValue)
dataSource
. Note, if you pass a simple value to this method, it will be matched against the first primaryKey field. For DataSources with a composite primary key (multiple primaryKey fields), pass a Criteria instance containing just primaryKey entries.
keyValue
- primary key value to search forpublic int[] getCachedRange(int rowNum)
rowNum
- row to checkpublic Criteria getCombinedCriteria()
public AdvancedCriteria getCombinedCriteriaAsAdvancedCriteria()
public int getLength()
This length can only be known, even
approximately, when the first results are retrieved from the server. Before then, the ResultSet returns a large length
in order to encourage viewers to ask for rows. ResultSet.lengthIsKnown()
can be called to determine whether an actual length is known.
Note that if progressive loading
is active, the length advertised by the
server may not be an accurate total row count for the data set. ResultSet.lengthIsProgressive()
can be called to determine
whether this is the case.
getLength
in class RecordList
public java.lang.String[] getProperty(java.lang.String property)
List.getProperty()
. Checks only loaded rows and will not trigger
a fetch.getProperty
in class RecordList
property
- name of the property to look forpublic int getRowCount()
getLength()
. See getRowCountStatus()
for more information.Grid row-range and row-count display
public java.lang.Integer[] getRowCountRange()
getRowCountStatus()
is "range" this method will return a
two element array containing the lower and upper bound for the rowCount. In all other cases it will return a two element
array where the first element is the result of getRowCount()
and
the second element is nullGrid row-range and row-count display
public RowCountStatus getRowCountStatus()
getRowCount()
reflects an accurate
row-count for this data set. An accurate row count may not currently be available if progressiveLoading
is active. See RowCountStatus
for further details.
Grid row-range and row-count display
public SortSpecifier[] getSort()
SortSpecifier
s.SortSpecifier
s currently applied to this ResultSetpublic java.util.Map getValueMap(java.lang.String idField, java.lang.String displayField)
{ item[idField] -> item[displayField] }
, for all items in the list. If more than
one item has the same idProperty
, the value for the later item in the list will clobber the value for the
earlier item. If this method is called when the cache is incomplete
, it will trigger fetches, and will return a valueMap reflecting only the currently loaded rows.
getValueMap
in class RecordList
idField
- Property to use as ID (data value) in the valueMapdisplayField
- Property to use as a display value in the valueMapallMatchingRowsCached()
public int indexOf(java.lang.Object obj)
If pos is specified, starts looking after that position.
Returns -1 if not found.
NOTE: ResultSet.indexOf() only inspects the current cache of records, so it is only appropriate for temporary presentation purposes. For example, it would not be appropriate to hold onto a record and attempt to use indexOf() to determine if it had been deleted.
obj
- object to look forpublic int indexOf(java.lang.Object obj, int pos)
indexOf(java.lang.Object)
public int indexOf(java.lang.Object obj, int pos, int endPos)
If pos is specified, starts looking after that position.
Returns -1 if not found.
NOTE: ResultSet.indexOf() only inspects the current cache of records, so it is only appropriate for temporary presentation purposes. For example, it would not be appropriate to hold onto a record and attempt to use indexOf() to determine if it had been deleted.
obj
- object to look forpos
- earliest index to considerendPos
- last index to considerpublic void invalidateCache()
Generally a ResultSet will observe and incorporate updates to the
DataSource that provides its records, but when this is not possible, invalidateCache()
allows manual cache
invalidation.
invalidateCache()
fires dataChanged()
, which may cause components using
this ResultSet to request new data for display, triggering server fetches.
public boolean lengthIsKnown()
When the ResultSet fetches data from the DataSource in
response to getRange()
or similar methods, DSResponse.totalRows
from the fetch lets the ResultSet know the full
dataset size.
Prior to the completion of the first fetch, (or after dropping cache
) the ResultSet will not know how many records are
available. At this time lengthIsKnown()
will return false, and a call to getLength()
will return an arbitrary, large value.
Note: If progressive loading
is active the reported DSResponse.totalRows
value may not accurately reflect the true dataset
size on the server. In this case lengthIsKnown()
returns true, but the reported length
of the ResultSet may change as additional rows are
retrieved from the server. The lengthIsProgressive()
method will indicate when the resultSet is in this state.
public boolean lengthIsProgressive()
getLength()
reflect the totalRows
reported by a DataSource with ProgressiveLoading
enabled? If true, this row count may not be an accurate reflection of the true size of the data set.
This method relies on the DSResponse.progressiveLoading
attribute having been set
accurately by the server. Note that if the user has scrolled to the end of a progressively loaded data set, or setFullLength()
has been explicitly called, this method will no longer
return true.
progressiveLoading:true
dsResponse.Progressive Loading
public boolean rangeIsLoaded(int startRow, int endRow)
startRow
- start position, inclusiveendRow
- end position, exclusivepublic void resort()
SortSpecifier
s.public boolean rowIsLoaded(int rowNum)
Unlike get(), will not trigger a server fetch.
rowNum
- row to checkpublic void setFullLength(int length)
This is an advanced feature. One use case for this method would be for a ResultSet populated with progressive loading
- if application code determines an accurate row count
for the current filter criteria it may be applied directly to the ResultSet via this method.
length
- total rows available from the serverpublic void setSort()
SortSpecifier
s. If the ResultSet is
already sorted and this method is called with an identical list of specifiers, this method will no-op. To cause data to
be resorted with the same set of specifiers, use resort()
.
To clear an existing sort, pass in explicit null or empty array.
public ResultSet sortByProperty(java.lang.String property, boolean up)
Sorting is performed on the client for a ResultSet that has a full cache for the current filter criteria. Otherwise, sorting is performed by the server, and changing the sort order will invalidate the cache.
NOTE: normalizers are not supported by ResultSets in "paged" mode, although valueMaps in the DataSource are respected by the SQLDataSource.
sortByProperty
in class RecordList
property
- name of the property to sort byup
- true == sort ascending, false == sort descendingpublic ResultSet sortByProperty(java.lang.String property, boolean up, Function normalizer)
public ResultSet sortByProperty(java.lang.String property, boolean up, Function normalizer, java.lang.Object context)
Sorting is performed on the client for a ResultSet that has a full cache for the current filter criteria. Otherwise, sorting is performed by the server, and changing the sort order will invalidate the cache.
NOTE: normalizers are not supported by ResultSets in "paged" mode, although valueMaps in the DataSource are respected by the SQLDataSource.
property
- name of the property to sort byup
- true == sort ascending, false == sort descendingnormalizer
- May be specified as a function, with signature normalize(item, propertyName, context)
, where
item
is a pointer to the item in the array, propertyName
is the
property by which the array is being sorted, and context
is the arbitrary context passed into
this method. Normalizer function should return the value normalized for sorting.context
- Callers may pass an arbitrary context into the sort method, which will then be made available
to the normalizer functionpublic boolean unsort()
sort specifiers
applied to this ResultSet, while
maintaining the current order of records. This feature is not supported for all lists. This method returns true if
supported. If a paged resultSet
has a partial cache, the
order of records in the local data must always match the order of records as provided by the DataSource
- otherwise the wrong set of records will be returned as new pages of data are
fetched (in response to a user scrolling a ListGrid, for example).
It's therefore not possible to unsort a paged resultSet with a partial cache and maintain the current order of any loaded records. If this method is called on a resultSet in this state, it will always no-op and return false.
If you need to force a partially loaded ResultSet to
discard it's current sort, and explicit call to setSort(null)
may be
used. This will drop the current sort specifiers and invalidateCache()
.
public boolean usingFilteredData()
client filtering
is enabled. Rows may have been loaded from
the server when a more restrictive criteria is applied such that filtering could be performed on the client side. This method returns false if data is not loaded yet.
getAllCachedRows()
public boolean willFetchData(Criteria newCriteria)
textMatchStyle
parameter determines whether a
change of text-match style will require a server fetch - for example if filter is being changed between an exact match
(from e.g: ListGrid.fetchData()
) and a substring match
(from e.g: ListGrid.filterData()
).ListGrid.fetchData()
or ListGrid.filterData()
would cause a server side fetch when passed
a certain set of criteria. Note that to predict correctly the decision that will be made by filter/fetch, you'll
need to pass the same TextMatchStyle
that will be used by the future filter/fetch.
Fetching manually (e.g. ListGrid.fetchData()
) will by
default use "exact" while filtering (e.g. ListGrid.filterData()
) will by default use "substring". If the component is configured for autofetch (i.e. ListGrid.autoFetchData
: true), that will use ListGrid.autoFetchTextMatchStyle
, which defaults
to "substring". If nothing/null is passed for the style, this method assumes you want the style from the last
filter/fetch.
To determine what TextMatchStyle
is being used, check the RPC Tab of
the Smart GWT Developer Console
and check the relevant DSRequest
.
newCriteria
- new criteria to test.public boolean willFetchData(Criteria newCriteria, TextMatchStyle textMatchStyle)
textMatchStyle
parameter determines whether a
change of text-match style will require a server fetch - for example if filter is being changed between an exact match
(from e.g: ListGrid.fetchData()
) and a substring match
(from e.g: ListGrid.filterData()
).ListGrid.fetchData()
or ListGrid.filterData()
would cause a server side fetch when passed
a certain set of criteria. Note that to predict correctly the decision that will be made by filter/fetch, you'll
need to pass the same TextMatchStyle
that will be used by the future filter/fetch.
Fetching manually (e.g. ListGrid.fetchData()
) will by
default use "exact" while filtering (e.g. ListGrid.filterData()
) will by default use "substring". If the component is configured for autofetch (i.e. ListGrid.autoFetchData
: true), that will use ListGrid.autoFetchTextMatchStyle
, which defaults
to "substring". If nothing/null is passed for the style, this method assumes you want the style from the last
filter/fetch.
To determine what TextMatchStyle
is being used, check the RPC Tab of
the Smart GWT Developer Console
and check the relevant DSRequest
.
newCriteria
- new criteria to test.textMatchStyle
- New text match style. If not passed, assumes textMatchStyle will not be modified.public static ResultSet asSGWTComponent(com.google.gwt.core.client.JavaScriptObject jsObj)
JavaScriptObject
. If
the supplied object is not a SmartClient ResultSet, a warning will be logged and null
returned; otherwise the SGWT ResultSet will be returned.jsObj
- SmartClient ResultSet whose wrapper is wantedpublic void ensureCreated() throws java.lang.IllegalStateException
isc.ResultSet.create()
function is
executed to create the SmartClient ResultSet object wrapped by this instance.
This method is required to be called for standalone usage of a ResultSet. In addition,
it can only be called after all initial configuration (dataSource
,
allRows
if being used, etc.) has been set.
java.lang.IllegalStateException
- if no dataSource has been setpublic java.util.Map getPaletteDefaults()
PaletteNode
. Use it when you need to
work with PaletteNodes indirectly, such when setting up
TileRecord
s that will be used in a
TilePalette
. See
the dev tools overview
for examples of how to
assemble and acquire a suitable defaults object when you are creating a PaletteNode
indirectlypublic void setInitialSort(SortSpecifier... sortSpecifiers)
setInitialData(Record[])
, this method may be used
to notify the ResultSet that the data is already sorted such that a call to RecordList.setSort(SortSpecifier...)
will
not require a new fetch unless additional data beyond the ends of the specified initialData are required.sortSpecifiers
- Initial sort specificationpublic int indexOf(Record record)
If pos is specified, starts looking after that position.
Returns -1 if not found.
NOTE: ResultSet.indexOf() only inspects the current cache of records, so it is only appropriate for temporary presentation purposes. For example, it would not be appropriate to hold onto a record and attempt to use indexOf() to determine if it had been deleted.
indexOf
in class RecordList
record
- object to look forpublic int indexOf(Record record, int pos, int endPos)
If pos is specified, starts looking after that position.
Returns -1 if not found.
NOTE: ResultSet.indexOf() only inspects the current cache of records, so it is only appropriate for temporary presentation purposes. For example, it would not be appropriate to hold onto a record and attempt to use indexOf() to determine if it had been deleted.
indexOf
in class RecordList
record
- object to look forpos
- earliest index to considerendPos
- last index to considerpublic Record get(int pos)
All List access methods of the ResultSet have the semantics described
in getRange()
.
get
in class RecordList
pos
- position of the element to getpublic Record[] getRange(int start, int end)
Calling getRange for records that have not yet loaded will trigger an asynchronous fetch. The
returned data will contain the loading marker
as a placeholder for records being fetched. If
any rows needed to be fetched, dataArrived()
will fire when they arrive.
getRange
in class RecordList
start
- start positionend
- end positionpublic RecordList getRangeAsRecordList(int start, int end)
start
- start positionend
- end positionpublic RecordList getAllVisibleRows()
loading markers
for
rows that are not yet loaded or in the process of loading, respectively.
This method will not trigger a fetch to load more records. getAllVisibileRows() will return
null if lengthIsKnown()
is false.
Records are returned in a new List but the Records within it are the same instances that the ResultSet is holding onto. Hence it's safe to add or remove records from the List without affecting the ResultSet but modifying the Records themselves is a direct modification of the client-side cache.
public RecordList getAllCachedRows()
getAllVisibleRows()
if the ResultSet is using client-side filtering to
display a subset of loaded rows (see the ResultSet overview
).
If usingFilteredData()
returns false, this is the same list as would be returned by
getAllVisibleRows()
.
This method will not trigger a fetch to load more records. getAllCachedRows() will return
null if lengthIsKnown()
is false.
Records are returned in a new List but the Records within it are the same instances that the ResultSet is holding onto. Hence it's safe to add or remove records from the List without affecting the ResultSet but modifying the Records themselves is a direct modification of the client-side cache.
public Record findByKey(java.lang.String keyValue)
'dataSource'
.keyValue
- primary key value to search forpublic void dataArrived(int startRow, int endRow)
addDataArrivedHandler(com.smartgwt.client.data.events.DataArrivedHandler)
instead. When
dataArrived()
fires, an immediate call to getRange()
with the startRow
and
endRow
passed as arguments will return a List with no loading markers
.
startRow
- starting index of rows that have just loadedendRow
- ending index of rows that have just loaded, non-inclusivepublic Record[] findAll(java.util.Map properties)
findAll
in class RecordList
properties
- set of properties and values to matchpublic Record[] findAll(java.lang.String propertyName, java.lang.String value)
findAll
in class RecordList
propertyName
- property to matchvalue
- value to compare against (if propertyName is a string)public Record[] findAll(java.lang.String propertyName, int value)
findAll
in class RecordList
propertyName
- property to matchvalue
- value to compare against (if propertyName is a string)public Record[] findAll(java.lang.String propertyName, java.lang.Long value)
Note: JavaScript has no long type, so the long value becomes a JavaScript Number, which has a lesser range than Java long. The range for integer numbers in Javascript is [-9007199254740992,9007199254740992] or [-Math.pow(2,53),Math.pow(2,53)].
findAll
in class RecordList
propertyName
- property to matchvalue
- value to compare against (if propertyName is a string)public Record[] findAll(java.lang.String propertyName, float value)
findAll
in class RecordList
propertyName
- property to matchvalue
- value to compare against (if propertyName is a string)public Record[] findAll(java.lang.String propertyName, boolean value)
findAll
in class RecordList
propertyName
- property to matchvalue
- value to compare against (if propertyName is a string)public Record[] findAll(java.lang.String propertyName, java.util.Date value)
findAll
in class RecordList
propertyName
- property to matchvalue
- value to compare against (if propertyName is a string)public Record[] findAll(AdvancedCriteria adCriteria)
findAll
in class RecordList
adCriteria
- AdvancedCriteria to use to filter resultspublic Record find(java.util.Map properties)
properties
- set of properties and values to matchpublic Record find(java.lang.String propertyName, java.lang.Object value)
RecordList.find(java.lang.String, java.lang.Object)
. Checks only loaded rows and will not trigger a fetch.find
in class RecordList
propertyName
- property to matchvalue
- value to compare against (if propertyName is a string)public int findIndex(java.util.Map properties)
RecordList.findIndex(java.util.Map)
. Checks only loaded rows and will not trigger a fetch.findIndex
in class RecordList
properties
- set of properties and values to
matchpublic int findIndex(java.lang.String propertyName, java.lang.String value)
RecordList.findIndex(java.util.Map)
. Checks only loaded rows and will not trigger a fetch.findIndex
in class RecordList
propertyName
- property to matchvalue
- value to compare againstpublic int findIndex(java.lang.String propertyName, int value)
RecordList.findIndex(java.util.Map)
. Checks only loaded rows and will not trigger a fetch.findIndex
in class RecordList
propertyName
- property to matchvalue
- value to compare againstpublic int findIndex(java.lang.String propertyName, java.lang.Long value)
RecordList.findIndex(java.util.Map)
. Checks only loaded rows and will not trigger a fetch.
Note: JavaScript has no long type, so the long value becomes a JavaScript Number, which has a lesser range than Java long. The range for integer numbers in Javascript is [-9007199254740992,9007199254740992] or [-Math.pow(2,53),Math.pow(2,53)].
findIndex
in class RecordList
propertyName
- property to matchvalue
- value to compare againstpublic int findIndex(java.lang.String propertyName, float value)
RecordList.findIndex(java.util.Map)
. Checks only loaded rows and will not trigger a fetch.findIndex
in class RecordList
propertyName
- property to matchvalue
- value to compare againstpublic int findIndex(java.lang.String propertyName, boolean value)
RecordList.findIndex(java.util.Map)
. Checks only loaded rows and will not trigger a fetch.findIndex
in class RecordList
propertyName
- property to matchvalue
- value to compare againstpublic int findIndex(java.lang.String propertyName, java.util.Date value)
RecordList.findIndex(java.util.Map)
. Checks only loaded rows and will not trigger a fetch.findIndex
in class RecordList
propertyName
- property to matchvalue
- value to compare againstpublic int findNextIndex(int startIndex, java.util.Map properties)
RecordList.findNextIndex(int, java.lang.String)
. Checks only loaded rows and will not trigger a fetch.findNextIndex
in class RecordList
startIndex
- first index to considerproperties
- set of properties and values to matchpublic int findNextIndex(int startIndex, java.lang.String propertyName, java.lang.String value, int endIndex)
RecordList.findNextIndex(int, java.lang.String)
. Checks only loaded rows and will not trigger a fetch.findNextIndex
in class RecordList
startIndex
- first index to considerpropertyName
- property to matchvalue
- value to compare against (if propertyName is a string)endIndex
- last index to considerpublic int findNextIndex(int startIndex, java.lang.String propertyName, int value, int endIndex)
RecordList.findNextIndex(int, java.lang.String)
. Checks only loaded rows and will not trigger a fetch.findNextIndex
in class RecordList
startIndex
- first index to considerpropertyName
- property to matchvalue
- value to compare against (if propertyName is a string)endIndex
- last index to considerpublic int findNextIndex(int startIndex, java.lang.String propertyName, java.lang.Long value, int endIndex)
RecordList.findNextIndex(int, java.lang.String)
. Checks only loaded rows and will not trigger a fetch.
Note: JavaScript has no long type, so the long value becomes a JavaScript Number, which has a lesser range than Java long. The range for integer numbers in Javascript is [-9007199254740992,9007199254740992] or [-Math.pow(2,53),Math.pow(2,53)].
findNextIndex
in class RecordList
startIndex
- first index to considerpropertyName
- property to matchvalue
- value to compare against (if propertyName is a string)endIndex
- last index to considerpublic int findNextIndex(int startIndex, java.lang.String propertyName, float value, int endIndex)
RecordList.findNextIndex(int, java.lang.String)
. Checks only loaded rows and will not trigger a fetch.findNextIndex
in class RecordList
startIndex
- first index to considerpropertyName
- property to matchvalue
- value to compare against (if propertyName is a string)endIndex
- last index to considerpublic int findNextIndex(int startIndex, java.lang.String propertyName, boolean value, int endIndex)
RecordList.findNextIndex(int, java.lang.String)
. Checks only loaded rows and will not trigger a fetch.findNextIndex
in class RecordList
startIndex
- first index to considerpropertyName
- property to matchvalue
- value to compare against (if propertyName is a string)endIndex
- last index to considerpublic int findNextIndex(int startIndex, java.lang.String propertyName, java.util.Date value, int endIndex)
RecordList.findNextIndex(int, java.lang.String)
. Checks only loaded rows and will not trigger a fetch.findNextIndex
in class RecordList
startIndex
- first index to considerpropertyName
- property to matchvalue
- value to compare against (if propertyName is a string)endIndex
- last index to considerpublic static boolean isResultSet(com.google.gwt.core.client.JavaScriptObject data)
public static Record getLoadingMarker()