com.viaoa.object

Class OAFinder<F extends OAObject,T extends OAObject>

java.lang.Object

com.viaoa.object.OAFinder<F,T>

Type Parameters:

F - type of hub or OAObject to use as the root (from)

T - type of hub for the to class (to).

examples: // from Router, find all UserLogin for a userId OAFinder f = new OAFinder(Router.P_UserLogins); String cpp = UserLoginPP.user().userId().pp; f.addLikeFilter(cpp, userId); UserLogin userLogin = f.findFirst(router); OAFinder f = new OAFinder(ProgramPP.locations().employees().pp) { @Override protected boolean isUsed(Employee emp) { return super.isUsed(emp); } @Override protected void onFound(Employee emp) { //todo: } }; // f.setMaxFound(50); f.addEqualFilter(EmployeePP.employeeAward().awardType().name(), "some name"); ArrayList al = f.find(program);

public class OAFinder<F extends OAObject,T extends OAObject>
extends Object

This is used to find all values from one OAObject/Hub to another OAObject/Hub, using a propertyPath. Support is included for Filters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OAFinder.CompareFilter
protected static class	OAFinder.DuplicateFilter

Constructor Summary

Constructors

Constructor and Description
OAFinder()
OAFinder(F fromObject, String propPath)
OAFinder(Hub<F> fromHub, String propPath)
OAFinder(Hub<F> fromHub, String propPath, boolean bUseAll)
OAFinder(String propPath)

Method Summary

Modifier and Type	Method and Description
protected ArrayList<T>	_find(Hub<F> hubRoot, F objectLastUsed) Given the propertyPath, find all of the objects from a Hub, starting after objectLastFound
void	addAndFilter() This will create an And with the existing filter and the next filter that is added.
void	addBetweenFilter(String pp, Object val1, Object val2)
void	addBetweenOrEqualFilter(String pp, Object val1, Object val2)
void	addEmptyFilter(String pp)
void	addEqualFilter(String pp, Object val)
void	addEqualFilter(String pp, Object matchValue, boolean bIgnoreCase)
void	addEqualFilter(String pp, Object matchValue, int decimalPlaces)
void	addFalseFilter(String pp)
void	addFilter(OAFilter filter)
void	addGreaterFilter(String pp, Object val)
void	addGreaterOrEqualFilter(String pp, Object val)
void	addLessFilter(String pp, Object val)
void	addLessOrEqualFilter(String pp, Object val)
void	addLikeFilter(String pp, Object val)
void	addNotEmptyFilter(String pp)
void	addNotLikeFilter(String pp, Object val)
void	addNotNullFilter(String pp)
void	addNullFilter(String pp)
void	addOrFilter() This will create an Or with the existing filter and the next filter that is added.
void	addOrFilter(OAFilter f1, OAFilter f2)
void	addQueryFilter(Class<F> c, String pp)
void	addQueryFilter(Class<F> c, String query, Object[] args)
void	addTrueFilter(String pp)
boolean	canFindFirst(F objectRoot) Returns true if a matching value is found.
void	clearFilters()
protected HubFilter	createHubFilter(String name) This will be called to create a filter that is in the propertyPaths.
ArrayList<T>	find()
ArrayList<T>	find(ArrayList<F> alRoot)
ArrayList<T>	find(ArrayList<F> alRoot, F objectLastUsed)
ArrayList<T>	find(F objectRoot) Given the propertyPath, find all of the objects from a root object.
ArrayList<T>	find(Hub<F> hubRoot) Given the propertyPath, find all of the objects from a Hub.
ArrayList<T>	find(Hub<F> hubRoot, F objectLastUsed)
protected void	find(Object obj, int pos)
ArrayList<T>	findDuplicates(F objectRoot, String pp) Returns all objects that have another object with a duplicate value for a property (path). Note: null values are not included.
T	findFirst()
T	findFirst(F objectRoot) Finds the first matching value.
T	findFirst(Hub<F> hub)
T	findLargest(F objectRoot, String pp)
T	findLargest(Hub<F> hub, String pp)
T	findLargest(String pp)
T	findLast()
T	findLast(F objectRoot)
T	findLast(Hub<F> hub)
T	findNext(Hub<F> hub, F objectLastUsed)
T	findSmallest(F objectRoot, String pp)
T	findSmallest(Hub<F> hub, String pp)
T	findSmallest(String pp)
boolean	getAllowRecursiveRoot() Flag to know if the root object/hub should allow for recursive duing the find.
OAFilter	getFilter()
int	getMaxFound()
OAPropertyPath	getPropertyPath()
int	getRootHubPos()
Object[]	getStackObjects() The objects that are in the current stack.
String[]	getStackPropertyNames() The property name of the objects that are in the current stack.
boolean	getStop()
boolean	getUseOnlyLoadedData() Flag (default=false) to only use data that is already in memory and not to load from server or datasource.
protected boolean	isUsed(T obj) Called for all objects that are found, and pass the filter.
protected void	onDataNotFound() Called during a find when data was not found.
protected void	onFound(T obj) Add the found object to the list that is returned by find.
void	setAllowRecursiveRoot(boolean b)
void	setCascade(OACascade cascade)
void	setEnabledStack(boolean b) This will have the internal stack updated when a find is being performed.
void	setFilter(OAFilter f)
void	setMaxFound(int x)
void	setRoot(F obj)
void	setRoot(Hub<F> hub)
protected void	setup(Class c)
void	setUseOnlyLoadedData(boolean b)
void	stop() This is used to stop the current find that is in process.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAFinder

public OAFinder()

OAFinder

public OAFinder(String propPath)

OAFinder

public OAFinder(F fromObject,
                String propPath)

OAFinder

public OAFinder(Hub<F> fromHub,
                String propPath)

OAFinder

public OAFinder(Hub<F> fromHub,
                String propPath,
                boolean bUseAll)

Method Detail

setAllowRecursiveRoot

public void setAllowRecursiveRoot(boolean b)

getAllowRecursiveRoot

public boolean getAllowRecursiveRoot()

Flag to know if the root object/hub should allow for recursive duing the find. Default is determined by the following. Default is false, unless hub is the root and it has a masterObject.

onFound

protected void onFound(T obj)

Add the found object to the list that is returned by find. This can be overwritten to get all of the objects as they are found.

See Also:

to be able to have the find stop searching.

onDataNotFound

protected void onDataNotFound()

Called during a find when data was not found. Use stop() to have the find aborted.

stop

public void stop()

This is used to stop the current find that is in process. This can be used when overwriting the onFound().

getStop

public boolean getStop()

setUseOnlyLoadedData

public void setUseOnlyLoadedData(boolean b)

getUseOnlyLoadedData

public boolean getUseOnlyLoadedData()

Flag (default=false) to only use data that is already in memory and not to load from server or datasource.

setMaxFound

public void setMaxFound(int x)

getMaxFound

public int getMaxFound()

find

public ArrayList<T> find()

setRoot

public void setRoot(F obj)

setRoot

public void setRoot(Hub<F> hub)

find

public ArrayList<T> find(Hub<F> hubRoot)

Given the propertyPath, find all of the objects from a Hub.

find

public ArrayList<T> find(ArrayList<F> alRoot)

find

public ArrayList<T> find(ArrayList<F> alRoot,
                         F objectLastUsed)

find

public ArrayList<T> find(Hub<F> hubRoot,
                         F objectLastUsed)

getRootHubPos

public int getRootHubPos()

_find

protected ArrayList<T> _find(Hub<F> hubRoot,
                             F objectLastUsed)

Given the propertyPath, find all of the objects from a Hub, starting after objectLastFound

clearFilters

public void clearFilters()

addFilter

public void addFilter(OAFilter filter)

getFilter

public OAFilter getFilter()

setFilter

public void setFilter(OAFilter f)

canFindFirst

public boolean canFindFirst(F objectRoot)

Returns true if a matching value is found.

findFirst

public T findFirst()

findFirst

public T findFirst(F objectRoot)

Finds the first matching value. If searching for a null, then this would return a null, so use the canFindFirst method instead.

findFirst

public T findFirst(Hub<F> hub)

findNext

public T findNext(Hub<F> hub,
                  F objectLastUsed)

findLast

public T findLast()

findLast

public T findLast(F objectRoot)

findLast

public T findLast(Hub<F> hub)

findLargest

public T findLargest(String pp)

findLargest

public T findLargest(F objectRoot,
                     String pp)

findLargest

public T findLargest(Hub<F> hub,
                     String pp)

findSmallest

public T findSmallest(String pp)

findSmallest

public T findSmallest(F objectRoot,
                      String pp)

findSmallest

public T findSmallest(Hub<F> hub,
                      String pp)

findDuplicates

public ArrayList<T> findDuplicates(F objectRoot,
                                   String pp)

Returns all objects that have another object with a duplicate value for a property (path).
Note: null values are not included.

find

public ArrayList<T> find(F objectRoot)

Given the propertyPath, find all of the objects from a root object.

Parameters:

objectRoot - starting object to begin navigating through the propertyPath.

getPropertyPath

public OAPropertyPath getPropertyPath()

setup

protected void setup(Class c)

find

protected void find(Object obj,
                    int pos)

createHubFilter

protected HubFilter createHubFilter(String name)

This will be called to create a filter that is in the propertyPaths.

Parameters:

name - name of the filter in the propertyPath

isUsed

protected boolean isUsed(T obj)

Called for all objects that are found, and pass the filter.

Returns:

true (default) to include in arrayList results, false to skip.

setEnabledStack

public void setEnabledStack(boolean b)

This will have the internal stack updated when a find is being performed.

Parameters:

b, - default is false

getStackObjects

public Object[] getStackObjects()

The objects that are in the current stack. This can be used when overwriting the onFound(..) to know the object path.

See Also:

to enable this information.

getStackPropertyNames

public String[] getStackPropertyNames()

The property name of the objects that are in the current stack.

See Also:

to enable this information.

addBetweenFilter

public void addBetweenFilter(String pp,
                             Object val1,
                             Object val2)

addBetweenOrEqualFilter

public void addBetweenOrEqualFilter(String pp,
                                    Object val1,
                                    Object val2)

addEmptyFilter

public void addEmptyFilter(String pp)

addNotEmptyFilter

public void addNotEmptyFilter(String pp)

addQueryFilter

public void addQueryFilter(Class<F> c,
                           String pp)

addQueryFilter

public void addQueryFilter(Class<F> c,
                           String query,
                           Object[] args)

addEqualFilter

public void addEqualFilter(String pp,
                           Object val)

addEqualFilter

public void addEqualFilter(String pp,
                           Object matchValue,
                           boolean bIgnoreCase)

addEqualFilter

public void addEqualFilter(String pp,
                           Object matchValue,
                           int decimalPlaces)

addTrueFilter

public void addTrueFilter(String pp)

addFalseFilter

public void addFalseFilter(String pp)

addNullFilter

public void addNullFilter(String pp)

addNotNullFilter

public void addNotNullFilter(String pp)

addGreaterFilter

public void addGreaterFilter(String pp,
                             Object val)

addGreaterOrEqualFilter

public void addGreaterOrEqualFilter(String pp,
                                    Object val)

addLessFilter

public void addLessFilter(String pp,
                          Object val)

addLessOrEqualFilter

public void addLessOrEqualFilter(String pp,
                                 Object val)

addLikeFilter

public void addLikeFilter(String pp,
                          Object val)

addNotLikeFilter

public void addNotLikeFilter(String pp,
                             Object val)

addOrFilter

public void addOrFilter(OAFilter f1,
                        OAFilter f2)

addOrFilter

public void addOrFilter()

This will create an Or with the existing filter and the next filter that is added.

addAndFilter

public void addAndFilter()

This will create an And with the existing filter and the next filter that is added.

setCascade

public void setCascade(OACascade cascade)