Package com.storedobject.ui.util

Class ObjectListLoader<T extends StoredObject>

java.lang.Object

com.storedobject.ui.util.ObjectListLoader<T>

All Implemented Interfaces:

FilterMethods<T>, ObjectLoader<T>, ObjectLoader<T>

public class ObjectListLoader<T extends StoredObject>
extends Object
implements ObjectLoader<T>

Constructor Summary

Constructors

Constructor	Description
ObjectListLoader(Class<T> objectClass, Consumer<T> loadConsumer, Runnable cleared, Runnable loaded)
ObjectListLoader(Class<T> objectClass, Consumer<T> loadConsumer, Runnable cleared, Runnable loaded, boolean any)
ObjectListLoader(Class<T> objectClass, Consumer<T> loadConsumer, Runnable cleared, Runnable loaded, boolean inMemory, boolean any)

Method Summary

Modifier and Type	Method	Description
void	applyFilter()	This method is called whenever a filter condition is changed.
void	applyFilterPredicate()	This method is called whenever a filter predicate is changed.
void	clear()	Clear - remove all entries.
String	getEffectiveCondition(String condition)	Get the "effective" filter condition that must be applied for loading.
ObjectList<T>	getList()
ObjectLoadFilter<T>	getLoadFilter()	Get the load filter.
Class<T>	getObjectClass()	The class of the instances.
void	load(ObjectIterator<T> objectIterator)	Load the given instances.
final int	size()	Get the instances count.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.core.FilterMethods

getFilterCondition, setFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setLoadFilter, setLoadFilter, setViewFilter, setViewFilter

Methods inherited from interface com.storedobject.core.ObjectLoader

canContain, getAllowAny, getLinkType, getMaster, getOrderBy, isAllowAny, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, reload, setLinkType, setLinkType, setMaster, setMaster, setOrderBy, setOrderBy

Methods inherited from interface com.storedobject.ui.ObjectLoader

addDataLoadedListener, clear, get, getCacheLevel, getDelegatedLoader, getFixedFilter, getObjectCount, indexOf, setExtraFilter, setExtraFilter, setFilter, setFilter, setFixedFilter, setFixedFilter, setFixedFilter, setFixedFilter, streamAll, streamFiltered

Constructor Details

ObjectListLoader

public ObjectListLoader(Class<T> objectClass,
 Consumer<T> loadConsumer,
 Runnable cleared,
 Runnable loaded)

ObjectListLoader

public ObjectListLoader(Class<T> objectClass,
 Consumer<T> loadConsumer,
 Runnable cleared,
 Runnable loaded,
 boolean any)

ObjectListLoader

public ObjectListLoader(Class<T> objectClass,
 Consumer<T> loadConsumer,
 Runnable cleared,
 Runnable loaded,
 boolean inMemory,
 boolean any)

Method Details

getObjectClass

public Class<T> getObjectClass()

Description copied from interface: ObjectLoader

The class of the instances.

Specified by:

getObjectClass in interface ObjectLoader<T extends StoredObject>

Returns:

The class of the instances to load.

getList

public ObjectList<T> getList()

size

public final int size()

Description copied from interface: ObjectLoader

Get the instances count.

Specified by:

size in interface ObjectLoader<T extends StoredObject>

Specified by:

size in interface ObjectLoader<T extends StoredObject>

Returns:

Count.

load

public void load(ObjectIterator<T> objectIterator)

Description copied from interface: ObjectLoader

Load the given instances. Current "load filter" if set will be applied. However, ObjectLoader.getOrderBy() result will be ignored. Also, the value returned by ObjectLoader.getAllowAny() will determine whether instanced of the subclasses to be restricted or not.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

objectIterator - Objects to be loaded.

clear

public void clear()

Description copied from interface: ObjectLoader

Clear - remove all entries.

Specified by:

clear in interface ObjectLoader<T extends StoredObject>

getLoadFilter

@Nonnull
public ObjectLoadFilter<T> getLoadFilter()

Description copied from interface: FilterMethods

Get the load filter.

Specified by:

getLoadFilter in interface FilterMethods<T extends StoredObject>

Specified by:

getLoadFilter in interface ObjectLoader<T extends StoredObject>

Returns:

Current load filter.

applyFilterPredicate

public void applyFilterPredicate()

Description copied from interface: FilterMethods

This method is called whenever a filter predicate is changed. Methods with a default implementation already invoke this method. If any of those methods are overridden, make sure that it invokes this method so that logic to handle filter changes can be coded here.

Note: This method is used to show the filtered result of the existing entries

Specified by:

applyFilterPredicate in interface FilterMethods<T extends StoredObject>

Specified by:

applyFilterPredicate in interface ObjectLoader<T extends StoredObject>

applyFilter

public void applyFilter()

Description copied from interface: FilterMethods

This method is called whenever a filter condition is changed. Methods with a default implementation already invoke this method. If any of those methods are overridden, make sure that it invokes this method so that logic to handle filter changes can be coded here.

Specified by:

applyFilter in interface FilterMethods<T extends StoredObject>

Specified by:

applyFilter in interface ObjectLoader<T extends StoredObject>

getEffectiveCondition

public String getEffectiveCondition(String condition)

Description copied from interface: FilterMethods

Get the "effective" filter condition that must be applied for loading. The result from FilterMethods.getFilterCondition() will be passed as a parameter to this method to get a modified "condition" if required.

Specified by:

getEffectiveCondition in interface FilterMethods<T extends StoredObject>

Specified by:

getEffectiveCondition in interface ObjectLoader<T extends StoredObject>

Parameters:

condition - Condition obtained from FilterMethods.getFilterCondition().

Returns:

Modified condition or the same if no modification required.