com.viaoa.hub

Class HubMerger<F extends OAObject,T extends OAObject>

java.lang.Object

com.viaoa.hub.HubMerger<F,T>

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

Used to combine objects from a property path of a root Hub into a single Hub. As any changes are made to any objects included in the property path, the Hub will automatically be updated. Property path can include either type of reference: One or Many.

Examples:

 new HubMerger(hubSalesmen, hubOrders, "customers.orders");

 new HubMerger(hubItem, hubForm, "formItem.formSection.formRow.form");

 new HubMerger(hubForm, hubItem, "formRows.formSections.formItems.item");
 

created 2004/08/20, rewritten 20080804, added recursive links 20120527

See Also:

for more information about property paths

Field Summary

Fields

Modifier and Type	Field and Description
static AtomicInteger	aiHubListenerCount
static boolean	bVERIFY
boolean	DEBUG
int	TotalHubListeners

Constructor Summary

Constructors

Constructor and Description
HubMerger(F obj, Hub<T> hubCombinedObjects, String propertyPath)
HubMerger(Hub<F> hubRoot, Hub<T> hubCombinedObjects, String propertyPath)
HubMerger(Hub<F> hubRoot, Hub<T> hubCombinedObjects, String propertyPath, boolean bUseAll)
HubMerger(Hub<F> hubRoot, Hub<T> hubCombinedObjects, String propertyPath, boolean bShareActiveObject, boolean bUseAll)
HubMerger(Hub<F> hubRoot, Hub<T> hubCombinedObjects, String propertyPath, boolean bShareActiveObject, boolean bUseAll, boolean bIncludeRootHub)
HubMerger(Hub<F> hubRoot, Hub<T> hubCombinedObjects, String propertyPath, boolean bShareActiveObject, String selectOrder, boolean bUseAll)
HubMerger(Hub<F> hubRoot, Hub<T> hubCombinedObjects, String propertyPath, boolean bShareActiveObject, String selectOrder, boolean bUseAll, boolean bIncludeRootHub, boolean bUseBackgroundThread) Main constructor that includes all of the config params Used to create an new hubMerger that will automatically update a Hub with all of the objects from a property path from a root Hub.

Method Summary

Modifier and Type	Method and Description
protected void	afterAddRealHub(HubEvent<T> e) This can be overwritten to get the add event from the parent, instead of getting the add event from the combinedHub.
protected void	afterInsertRealHub(HubEvent<T> e) This can be overwritten to get the insert event from the parent, instead of getting the insert event from the combinedHub.
protected void	afterMoveRealHub(HubEvent<T> e) This can be overwritten to get the move event from the parent, instead of getting the move event from the combinedHub.
protected void	afterRemoveAllRealHub(HubEvent<T> e)
protected void	afterRemoveRealHub(HubEvent<T> e)
protected void	beforeAddRealHub(HubEvent<T> e) This can be overwritten to get the add event from the parent, instead of getting the add event from the combinedHub.
protected void	beforeInsertRealHub(HubEvent<T> e) This can be overwritten to get the insert event from the parent, instead of getting the insert event from the combinedHub.
protected void	beforeRemoveAllRealHub(HubEvent<T> e)
protected void	beforeRemoveRealHub(HubEvent<T> e) This can be overwritten to get the remove event from the parent, instead of getting the remove event from the combinedHub. Since remove will also set the masterObject property to null, this can be used before it is set to null.
void	close()
protected void	createNodes()
protected void	finalize()
Hub	getCombinedHub()
String	getDescription()
boolean	getEnabled()
protected static ExecutorService	getExecutorService()
int	getObjectCount() Number of objects that are used in this merger.
String	getPath()
boolean	getRefreshOnActiveObjectChange()
Hub	getRootHub()
OASiblingHelper	getSiblingHelper()
boolean	getUseAll()
boolean	getUseBackgroundThread()
boolean	isLoadingCombinedHub()
protected void	onAddToCombined(com.viaoa.hub.HubMerger.Data data, OAObject obj)
protected void	onNewListRealHub(HubEvent<T> e) This can be overwritten to get the add event from the parent, instead of getting the add event from the combinedHub.
protected void	onRemoveFromCombined(com.viaoa.hub.HubMerger.Data data, OAObject obj)
void	setDescription(String desc)
void	setEnabled(boolean b)
void	setRefreshOnActiveObjectChange(boolean b)
void	setServerSideOnly(boolean b) This needs to be set to true if it is only created on the server, but client applications will be using the same Hub that is filtered.
void	setUseBackgroundThread(boolean b)
void	verify() Note: if multiple threads are making changes that affect the node data, then errors could show up.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public boolean DEBUG

bVERIFY

public static final boolean bVERIFY

See Also:

Constant Field Values

TotalHubListeners

public int TotalHubListeners

aiHubListenerCount

public static AtomicInteger aiHubListenerCount

Constructor Detail

HubMerger

public HubMerger(Hub<F> hubRoot,
                 Hub<T> hubCombinedObjects,
                 String propertyPath)

HubMerger

public HubMerger(Hub<F> hubRoot,
                 Hub<T> hubCombinedObjects,
                 String propertyPath,
                 boolean bUseAll)

HubMerger

public HubMerger(Hub<F> hubRoot,
                 Hub<T> hubCombinedObjects,
                 String propertyPath,
                 boolean bShareActiveObject,
                 boolean bUseAll)

HubMerger

public HubMerger(Hub<F> hubRoot,
                 Hub<T> hubCombinedObjects,
                 String propertyPath,
                 boolean bShareActiveObject,
                 String selectOrder,
                 boolean bUseAll)

HubMerger

public HubMerger(Hub<F> hubRoot,
                 Hub<T> hubCombinedObjects,
                 String propertyPath,
                 boolean bShareActiveObject,
                 String selectOrder,
                 boolean bUseAll,
                 boolean bIncludeRootHub,
                 boolean bUseBackgroundThread)

Main constructor that includes all of the config params Used to create an new hubMerger that will automatically update a Hub with all of the objects from a property path from a root Hub.

Parameters:

hubRoot - root Hub. The active object of this Hub will be used to get all objects in the propertyPath.

hubCombinedObjects - will have all of the objects from the active object of the hubRoot, using propertyPath. If hubCombinedObjects.getObjectClass() is null, then it will be assigned the correct class.

propertyPath - property path from the class of rootHub to the class of combinedHub.

bShareActiveObject - if true then the Active Object from found hub will be shared.

bUseAll - if true, then each object in hubRoot will be used. If false, then only the Active Object is used.

bIncludeRootHub - if the objects in the rootHub should also be included.

HubMerger

public HubMerger(Hub<F> hubRoot,
                 Hub<T> hubCombinedObjects,
                 String propertyPath,
                 boolean bShareActiveObject,
                 boolean bUseAll,
                 boolean bIncludeRootHub)

HubMerger

public HubMerger(F obj,
                 Hub<T> hubCombinedObjects,
                 String propertyPath)

Method Detail

setUseBackgroundThread

public void setUseBackgroundThread(boolean b)

getUseBackgroundThread

public boolean getUseBackgroundThread()

getObjectCount

public int getObjectCount()

Number of objects that are used in this merger.

setServerSideOnly

public void setServerSideOnly(boolean b)

This needs to be set to true if it is only created on the server, but client applications will be using the same Hub that is filtered. This is so that changes on the hub will be published to the clients, even if initiated on an OAClientThread.

getSiblingHelper

public OASiblingHelper getSiblingHelper()

getRootHub

public Hub getRootHub()

getCombinedHub

public Hub getCombinedHub()

setEnabled

public void setEnabled(boolean b)

getEnabled

public boolean getEnabled()

getPath

public String getPath()

setDescription

public void setDescription(String desc)

getDescription

public String getDescription()

verify

public void verify()

Note: if multiple threads are making changes that affect the node data, then errors could show up.

beforeRemoveRealHub

protected void beforeRemoveRealHub(HubEvent<T> e)

This can be overwritten to get the remove event from the parent, instead of getting the remove event from the combinedHub.
Since remove will also set the masterObject property to null, this can be used before it is set to null.

Parameters:

e -

afterRemoveRealHub

protected void afterRemoveRealHub(HubEvent<T> e)

beforeRemoveAllRealHub

protected void beforeRemoveAllRealHub(HubEvent<T> e)

afterRemoveAllRealHub

protected void afterRemoveAllRealHub(HubEvent<T> e)

afterMoveRealHub

protected void afterMoveRealHub(HubEvent<T> e)

This can be overwritten to get the move event from the parent, instead of getting the move event from the combinedHub.

beforeInsertRealHub

protected void beforeInsertRealHub(HubEvent<T> e)

This can be overwritten to get the insert event from the parent, instead of getting the insert event from the combinedHub.

afterInsertRealHub

protected void afterInsertRealHub(HubEvent<T> e)

This can be overwritten to get the insert event from the parent, instead of getting the insert event from the combinedHub.

beforeAddRealHub

protected void beforeAddRealHub(HubEvent<T> e)

This can be overwritten to get the add event from the parent, instead of getting the add event from the combinedHub.

afterAddRealHub

protected void afterAddRealHub(HubEvent<T> e)

This can be overwritten to get the add event from the parent, instead of getting the add event from the combinedHub.

onNewListRealHub

protected void onNewListRealHub(HubEvent<T> e)

This can be overwritten to get the add event from the parent, instead of getting the add event from the combinedHub.

createNodes

protected void createNodes()

close

public void close()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

onAddToCombined

protected void onAddToCombined(com.viaoa.hub.HubMerger.Data data,
                               OAObject obj)

onRemoveFromCombined

protected void onRemoveFromCombined(com.viaoa.hub.HubMerger.Data data,
                                    OAObject obj)

getUseAll

public boolean getUseAll()

getRefreshOnActiveObjectChange

public boolean getRefreshOnActiveObjectChange()

setRefreshOnActiveObjectChange

public void setRefreshOnActiveObjectChange(boolean b)

getExecutorService

protected static ExecutorService getExecutorService()

isLoadingCombinedHub

public boolean isLoadingCombinedHub()