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

Class BaseSearchDataProvider<C extends Serializable,T extends Serializable>

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<C,T>

All Implemented Interfaces:

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

Direct Known Subclasses:

ContainerListDataProvider, MultivalueContainerListDataProvider, ObjectDataProvider, RepositoryObjectDataProvider, SelectableBeanDataProvider

public abstract class BaseSearchDataProvider<C extends Serializable,T extends Serializable>
extends BaseSortableDataProvider<T>
implements IterativeExportSupport<T>

Author:

lazyman

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
BaseSearchDataProvider(org.apache.wicket.Component component, org.apache.wicket.model.IModel<Search<C>> search)
BaseSearchDataProvider(org.apache.wicket.Component component, org.apache.wicket.model.IModel<Search<C>> search, boolean useCache)
BaseSearchDataProvider(org.apache.wicket.Component component, org.apache.wicket.model.IModel<Search<C>> search, boolean useCache, boolean useDefaultSortingField)

Method Summary

Modifier and Type	Method	Description
void	addQueryVariables(String name, Object value)
void	detach()
void	exportIterative(ObjectHandler<T> handler, Task task, OperationResult result)	Default implementation throws UnsupportedOperationException.
protected CompiledObjectCollectionView	getCompiledObjectCollectionView()
protected ObjectQuery	getCustomizeContentQuery()
ObjectQuery	getQuery()
protected org.apache.wicket.model.IModel<Search<C>>	getSearchModel()
Class<C>	getType()
protected VariablesMap	getVariables()
void	setCompiledObjectCollectionView(CompiledObjectCollectionView objectCollectionView)
protected void	setupUserFriendlyMessage(OperationResult result, Throwable ex)
long	size()
boolean	supportsIterativeExport()	Returns false by default.

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

addCachedSize, checkOrderingSettings, clearCache, createObjectOrderings, createPaging, getAuditService, getAvailableData, getCachedSize, getDefaultOptionsBuilder, getDefaultSortOrder, getDefaultSortParam, getDistinctRelatedOptions, getDistinctRelatedOptionsBuilder, getModelInteractionService, getModelService, getOperationOptionsBuilder, getOperationOptionsBuilder, getPageBase, getPrismContext, getRelationRegistry, getSchemaService, getTaskManager, internalIterator, internalSize, 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

Constructor Details

BaseSearchDataProvider

public BaseSearchDataProvider(org.apache.wicket.Component component,
 org.apache.wicket.model.IModel<Search<C>> search)

BaseSearchDataProvider

public BaseSearchDataProvider(org.apache.wicket.Component component,
 org.apache.wicket.model.IModel<Search<C>> search,
 boolean useCache)

BaseSearchDataProvider

public BaseSearchDataProvider(org.apache.wicket.Component component,
 org.apache.wicket.model.IModel<Search<C>> search,
 boolean useCache,
 boolean useDefaultSortingField)

Method Details

getSearchModel

protected org.apache.wicket.model.IModel<Search<C>> getSearchModel()

getQuery

public ObjectQuery getQuery()

Overrides:

getQuery in class BaseSortableDataProvider<T extends Serializable>

getVariables

protected VariablesMap getVariables()

getCustomizeContentQuery

protected ObjectQuery getCustomizeContentQuery()

getType

public Class<C> getType()

size

public long size()

Specified by:

size in interface org.apache.wicket.markup.repeater.data.IDataProvider<C extends Serializable>

Overrides:

size in class BaseSortableDataProvider<T extends Serializable>

addQueryVariables

public void addQueryVariables(String name,
 Object value)

getCompiledObjectCollectionView

protected CompiledObjectCollectionView getCompiledObjectCollectionView()

setCompiledObjectCollectionView

public void setCompiledObjectCollectionView(CompiledObjectCollectionView objectCollectionView)

setupUserFriendlyMessage

protected void setupUserFriendlyMessage(OperationResult result,
 Throwable ex)

detach

public void detach()

Specified by:

detach in interface org.apache.wicket.markup.repeater.data.IDataProvider<C extends Serializable>

Specified by:

detach in interface org.apache.wicket.model.IDetachable

Overrides:

detach in class BaseSortableDataProvider<T extends Serializable>

exportIterative

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

Default implementation throws UnsupportedOperationException. Subclasses should override this method to support streaming CSV export.

Specified by:

exportIterative in interface IterativeExportSupport<C extends Serializable>

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

supportsIterativeExport

public boolean supportsIterativeExport()

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

Specified by:

supportsIterativeExport in interface IterativeExportSupport<C extends Serializable>