Package com.evolveum.midpoint.gui.impl.component.data.provider

Class SelectableBeanContainerDataProvider<C extends Containerable>

java.lang.Object

org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider<T,String>

com.evolveum.midpoint.gui.impl.component.data.provider.BaseSortableDataProvider<T>

com.evolveum.midpoint.gui.impl.component.data.provider.BaseSearchDataProvider<T,SelectableBean<T>>

com.evolveum.midpoint.gui.impl.component.data.provider.SelectableBeanDataProvider<C>

com.evolveum.midpoint.gui.impl.component.data.provider.SelectableBeanContainerDataProvider<C>

All Implemented Interfaces:

ISelectableDataProvider<SelectableBean<C>>, IterativeExportSupport<SelectableBean<C>>, Serializable, org.apache.wicket.extensions.markup.html.repeater.data.sort.ISortStateLocator<String>, org.apache.wicket.extensions.markup.html.repeater.data.table.ISortableDataProvider<SelectableBean<C>,String>, org.apache.wicket.markup.repeater.data.IDataProvider<SelectableBean<C>>, org.apache.wicket.model.IDetachable, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

ProcessedObjectsProvider, RelatedObjectsProvider

public class SelectableBeanContainerDataProvider<C extends Containerable>
extends SelectableBeanDataProvider<C>

Author:

lazyman, semancik

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.evolveum.midpoint.gui.impl.component.data.provider.BaseSortableDataProvider

BaseSortableDataProvider.CachedSize

Constructor Summary

Constructors

Constructor	Description
SelectableBeanContainerDataProvider(org.apache.wicket.Component component, @NotNull org.apache.wicket.model.IModel<Search<C>> search, Set<C> selected, boolean useDefaultSortingField)

Method Summary

Modifier and Type	Method	Description
protected void	addCachedSize(Map<Serializable,BaseSortableDataProvider.CachedSize> cache, BaseSortableDataProvider.CachedSize newSize)
protected boolean	checkOrderingSettings()
protected Integer	countObjects(Class<C> type, ObjectQuery query, Collection<SelectorOptions<GetOperationOptions>> currentOptions, Task task, OperationResult result)
void	exportIterative(ObjectHandler<SelectableBean<C>> handler, Task task, OperationResult result)	Streaming export using JDBC cursor-based streaming.
protected BaseSortableDataProvider.CachedSize	getCachedSize(Map<Serializable,BaseSortableDataProvider.CachedSize> cache)
protected boolean	match(C selectedValue, C foundValue)
protected List<C>	searchObjects(Class<C> type, ObjectQuery query, Collection<SelectorOptions<GetOperationOptions>> options, Task task, OperationResult result)
protected void	searchObjectsIterative(Class<C> type, ObjectQuery query, ObjectHandler<C> handler, Collection<SelectorOptions<GetOperationOptions>> options, Task task, OperationResult result)	Override this method to use a different iterative search implementation.
boolean	supportsIterativeExport()	Returns false by default.

Methods inherited from class com.evolveum.midpoint.gui.impl.component.data.provider.SelectableBeanDataProvider

additionalMatching, clearCache, clearSelectedObjects, createCountResult, createCountTask, createDataObjectWrapper, createDataObjectWrapperForError, createDataObjectWrappers, detach, getOptions, getResult, getSearchOptions, getSelected, internalIterator, internalSize, isEmptyListOnNullQuery, isExport, isUseObjectCounting, postProcessOptions, preprocessSelectedDataInternal, setCompiledObjectCollectionView, setDefaultCountIfNull, setEmptyListOnNullQuery, setExport, setForPreview, setOptions

Methods inherited from class com.evolveum.midpoint.gui.impl.component.data.provider.BaseSearchDataProvider

addQueryVariables, getCompiledObjectCollectionView, getCustomizeContentQuery, getQuery, getSearchModel, getType, getVariables, setupUserFriendlyMessage, size

Methods inherited from class com.evolveum.midpoint.gui.impl.component.data.provider.BaseSortableDataProvider

createObjectOrderings, createPaging, getAuditService, getAvailableData, getDefaultOptionsBuilder, getDefaultSortOrder, getDefaultSortParam, getDistinctRelatedOptions, getDistinctRelatedOptionsBuilder, getModelInteractionService, getModelService, getOperationOptionsBuilder, getOperationOptionsBuilder, getPageBase, getPrismContext, getRelationRegistry, getSchemaService, getTaskManager, isDistinct, isOrderingDisabled, isSizeAvailableModel, isUseCache, iterator, model, setExportSize, setQuery

Methods inherited from class org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider

getSort, getSortState, setSort, setSort

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.wicket.markup.repeater.data.IDataProvider

iterator, model, size

Methods inherited from interface com.evolveum.midpoint.gui.api.component.data.provider.ISelectableDataProvider

setQuery

Methods inherited from interface org.apache.wicket.extensions.markup.html.repeater.data.sort.ISortStateLocator

getSortState

Constructor Details

SelectableBeanContainerDataProvider

public SelectableBeanContainerDataProvider(org.apache.wicket.Component component,
 @NotNull
 @NotNull org.apache.wicket.model.IModel<Search<C>> search,
 Set<C> selected,
 boolean useDefaultSortingField)

Method Details

checkOrderingSettings

protected boolean checkOrderingSettings()

Overrides:

checkOrderingSettings in class BaseSortableDataProvider<SelectableBean<C extends Containerable>>

searchObjects

protected List<C> searchObjects(Class<C> type,
 ObjectQuery query,
 Collection<SelectorOptions<GetOperationOptions>> options,
 Task task,
 OperationResult result)
                         throws CommonException

Specified by:

searchObjects in class SelectableBeanDataProvider<C extends Containerable>

Throws:

CommonException

countObjects

protected Integer countObjects(Class<C> type,
 ObjectQuery query,
 Collection<SelectorOptions<GetOperationOptions>> currentOptions,
 Task task,
 OperationResult result)
                        throws CommonException

Specified by:

countObjects in class SelectableBeanDataProvider<C extends Containerable>

Throws:

CommonException

getCachedSize

protected BaseSortableDataProvider.CachedSize getCachedSize(Map<Serializable,BaseSortableDataProvider.CachedSize> cache)

Overrides:

getCachedSize in class BaseSortableDataProvider<SelectableBean<C extends Containerable>>

addCachedSize

protected void addCachedSize(Map<Serializable,BaseSortableDataProvider.CachedSize> cache,
 BaseSortableDataProvider.CachedSize newSize)

Overrides:

addCachedSize in class BaseSortableDataProvider<SelectableBean<C extends Containerable>>

match

protected boolean match(C selectedValue,
 C foundValue)

Specified by:

match in class SelectableBeanDataProvider<C extends Containerable>

supportsIterativeExport

public boolean supportsIterativeExport()

Description copied from class: BaseSearchDataProvider

Returns false by default. Subclasses that implement exportIterative() should override this to return true.

Specified by:

supportsIterativeExport in interface IterativeExportSupport<C extends Containerable>

Overrides:

supportsIterativeExport in class BaseSearchDataProvider<C extends Containerable,SelectableBean<C extends Containerable>>

exportIterative

public void exportIterative(ObjectHandler<SelectableBean<C>> handler,
 Task task,
 OperationResult result)
                     throws CommonException

Streaming export using JDBC cursor-based streaming. This method does not load all data into memory - uses true JDBC streaming. Streaming is enabled by setting iterationPageSize to -1.

Specified by:

exportIterative in interface IterativeExportSupport<C extends Containerable>

Overrides:

exportIterative in class BaseSearchDataProvider<C extends Containerable,SelectableBean<C extends Containerable>>

Parameters:

handler - Handler to process each item. Returns true to continue, false to stop.

task - Task for the operation

result - Operation result

Throws:

CommonException - if an error occurs during the search

searchObjectsIterative

protected void searchObjectsIterative(Class<C> type,
 ObjectQuery query,
 ObjectHandler<C> handler,
 Collection<SelectorOptions<GetOperationOptions>> options,
 Task task,
 OperationResult result)
                               throws CommonException

Override this method to use a different iterative search implementation. Default implementation uses ModelService.searchContainersIterative().

Throws:

CommonException