Package com.storedobject.core

Class ObjectForest<T extends StoredObject>

java.lang.Object

com.storedobject.core.ObjectForest<T>

All Implemented Interfaces:

Filtered<T>, FilterMethods<T>, ObjectLoader<T>, AutoCloseable

public class ObjectForest<T extends StoredObject>
extends Object
implements Filtered<T>, ObjectLoader<T>, AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectForest.LinkNode
static class	ObjectForest.LinkObject

Constructor Summary

Constructors

Constructor	Description
ObjectForest(boolean large, int linkType, Class<T> objectClass, boolean any)
ObjectForest(int linkType, Class<T> objectClass, boolean any, Function<Class<T>,ObjectList<T>> listSupplier)

Method Summary

Modifier and Type	Method	Description
void	applyFilterPredicate()	This method is called whenever a filter predicate is changed.
void	close()
void	filter(Predicate<? super T> filter)
void	filter(Predicate<? super T> filter, Comparator<? super T> comparator)
Comparator<? super T>	getComparator()
Predicate<? super T>	getFilter()
Predicate<StoredObjectUtility.Link<?>>	getLinkVisibility()
BiFunction<StoredObjectUtility.Link<?>,StoredObject,ObjectIterator<? extends StoredObject>>	getListLinks()
ObjectLoadFilter<T>	getLoadFilter()	Get the load filter.
final Class<T>	getObjectClass()	The class of the instances.
List<T>	getRoots()
<M extends StoredObject> boolean	hideLink(Class<M> masterClass, String linkName)
void	hideLinkLabels()
final boolean	isAllowAny()	Retrieve sub-classes?
void	load(int linkType, StoredObject master, String condition, String orderedBy, boolean any)	Load the links of the given "master" instance.
void	load(ObjectIterator<T> objects)	Load the given instances.
void	load(Iterable<Id> idList)	Load the instances created from the list of Ids.
void	load(String condition, String orderedBy, boolean any)	Load the instances.
void	load(Stream<T> objects)	Load the given instances.
void	order(Comparator<? super T> comparator)
void	refresh()
void	refresh(Object item)
void	refresh(Object item, boolean refreshChildren)
void	setLinkVisibility(Predicate<StoredObjectUtility.Link<?>> linkVisibility)
void	setListLinks(BiFunction<StoredObjectUtility.Link<?>,StoredObject,ObjectIterator<? extends StoredObject>> listLinks)
void	setLoadFilter(Predicate<T> loadFilter)	Set the load filter.
int	size()	Get the instances count.
int	size(int startingIndex, int endingIndex)
int	size(Object parent)
int	size(Object parent, int startingIndex, int endingIndex)
int	sizeAll()
int	sizeAll(Object parent)
Stream<T>	stream(int startingIndex, int endingIndex)
Stream<Object>	stream(Object parent, int startingIndex, int endingIndex)
Stream<T>	streamAll(int startingIndex, int endingIndex)
Stream<Object>	streamAll(Object parent, int startingIndex, int endingIndex)

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

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

Methods inherited from interface com.storedobject.core.ObjectLoader

applyFilter, canContain, clear, getAllowAny, getLinkType, getMaster, getOrderBy, 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

Constructor Details

ObjectForest

public ObjectForest(boolean large,
 int linkType,
 Class<T> objectClass,
 boolean any)

ObjectForest

public ObjectForest(int linkType,
 Class<T> objectClass,
 boolean any,
 Function<Class<T>,ObjectList<T>> listSupplier)

Method Details

hideLinkLabels

public void hideLinkLabels()

setLinkVisibility

public void setLinkVisibility(Predicate<StoredObjectUtility.Link<?>> linkVisibility)

getLinkVisibility

public Predicate<StoredObjectUtility.Link<?>> getLinkVisibility()

setListLinks

public void setListLinks(BiFunction<StoredObjectUtility.Link<?>,StoredObject,ObjectIterator<? extends StoredObject>> listLinks)

getListLinks

public BiFunction<StoredObjectUtility.Link<?>,StoredObject,ObjectIterator<? extends StoredObject>> getListLinks()

setLoadFilter

public void setLoadFilter(Predicate<T> loadFilter)

Description copied from interface: FilterMethods

Set the load filter. This will be applied whenever loading takes place.

Specified by:

setLoadFilter in interface FilterMethods<T extends StoredObject>

Parameters:

loadFilter - Load filter to be applied while loading.

applyFilterPredicate

public void applyFilterPredicate()

Description copied from interface: FilterMethods

This method is called whenever a filter predicate is changed. Methods with 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>

getLoadFilter

@Nonnull
public ObjectLoadFilter<T> getLoadFilter()

Description copied from interface: FilterMethods

Get the load filter.

Specified by:

getLoadFilter in interface FilterMethods<T extends StoredObject>

Returns:

Current load filter.

getRoots

public List<T> getRoots()

order

public void order(Comparator<? super T> comparator)

Specified by:

order in interface Filtered<T extends StoredObject>

filter

public void filter(Predicate<? super T> filter)

Specified by:

filter in interface Filtered<T extends StoredObject>

filter

public void filter(Predicate<? super T> filter,
 Comparator<? super T> comparator)

Specified by:

filter in interface Filtered<T extends StoredObject>

getFilter

public Predicate<? super T> getFilter()

Specified by:

getFilter in interface Filtered<T extends StoredObject>

getComparator

public Comparator<? super T> getComparator()

Specified by:

getComparator in interface Filtered<T extends StoredObject>

size

public int size()

Description copied from interface: ObjectLoader

Get the instances count.

Specified by:

size in interface Filtered<T extends StoredObject>

Specified by:

size in interface ObjectLoader<T extends StoredObject>

Returns:

Count.

size

public int size(Object parent)

size

public int size(int startingIndex,
 int endingIndex)

Specified by:

size in interface Filtered<T extends StoredObject>

size

public int size(Object parent,
 int startingIndex,
 int endingIndex)

sizeAll

public int sizeAll()

Specified by:

sizeAll in interface Filtered<T extends StoredObject>

sizeAll

public int sizeAll(Object parent)

stream

public Stream<T> stream(int startingIndex,
 int endingIndex)

Specified by:

stream in interface Filtered<T extends StoredObject>

stream

public Stream<Object> stream(Object parent,
 int startingIndex,
 int endingIndex)

streamAll

public Stream<T> streamAll(int startingIndex,
 int endingIndex)

Specified by:

streamAll in interface Filtered<T extends StoredObject>

streamAll

public Stream<Object> streamAll(Object parent,
 int startingIndex,
 int endingIndex)

load

public void load(String condition,
 String orderedBy,
 boolean any)

Description copied from interface: ObjectLoader

Load the instances. Current "load filter" if set will be applied. If "master" is already set, "links" of the "master" will be loaded.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

condition - Filtering condition to be applied.

orderedBy - "ORDER BY" clause to use while loading.

any - Whether instanced of the subclasses to be retrieved or not.

load

public void load(int linkType,
 StoredObject master,
 String condition,
 String orderedBy,
 boolean any)

Description copied from interface: ObjectLoader

Load the links of the given "master" instance. Current "load filter" if set will be applied.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

linkType - Link type.

master - Master instance.

condition - Filtering condition to be applied.

orderedBy - "ORDER BY" clause to use while loading.

any - Whether instanced of the subclasses to be retrieved or not.

load

public void load(Iterable<Id> idList)

Description copied from interface: ObjectLoader

Load the instances created from the list of Ids. 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>

Parameters:

idList - List of Ids from which objects to be loaded.

load

public void load(ObjectIterator<T> objects)

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>

Parameters:

objects - Objects to be loaded.

load

public void load(Stream<T> objects)

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>

Parameters:

objects - Objects to be loaded.

getObjectClass

public final 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.

isAllowAny

public final boolean isAllowAny()

Description copied from interface: ObjectLoader

Retrieve sub-classes?

Specified by:

isAllowAny in interface ObjectLoader<T extends StoredObject>

Returns:

Whether instanced of the subclasses to be retrieved or not.

close

public void close()

Specified by:

close in interface AutoCloseable

refresh

public void refresh()

refresh

public void refresh(Object item)

refresh

public void refresh(Object item,
 boolean refreshChildren)

hideLink

public <M extends StoredObject> boolean hideLink(Class<M> masterClass,
 String linkName)