com.viaoa.hub

Class HubDelegate

java.lang.Object

com.viaoa.hub.HubDelegate

public class HubDelegate
extends Object

Main delegate used for working with the Active Object for a Hub. All methods that have an "_" prefix should not be called directly, as there is a calling method that should be used, that performs additional functionality. If a method does not have the "_" prefix and is accessible, then it is ok to call it, but will most likely have a matching method name in the Hub class.

Author:

vincevia

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HubDelegate.HubCurrentStateEnum Current state of Hub, in case it's in the process of being updated, based on another event that changes a Hub that is somehow connected to this Hub.

Field Summary

Fields

Modifier and Type	Field and Description
static Boolean	FALSE
static Boolean	TRUE

Constructor Summary

Constructors

Constructor and Description
HubDelegate()

Method Summary

Modifier and Type	Method and Description
protected static <T> HubDelegate.HubCurrentStateEnum	_getCurrentState(Hub<T> thisHub, Hub<T> hubNew, ArrayList<T> alNew, Set<Hub> hmHub)
protected static void	_updateHubAddsAndRemoves(Hub thisHub, int iCascadeRule, OACascade cascade, boolean bIsSaving) 20181211 removed, use hub.getLinkHub(true) Returns this or any shared hub that uses the same active object and is linked to another Hub.
static Hub	getAnyAddHub(Hub hub) Returns this hub, or one of its shared Hubs, that has an addHub established.
static HubAutoMatch	getAutoMatch(Hub thisHub)
static HubAutoSequence	getAutoSequence(Hub thisHub)
static boolean	getChanged(Hub thisHub, int iCascadeRule, OACascade cascade)
static Hub	getControllingHub(Hub thisHub) created 20110904 Find the hub that controls whether or not this hub is valid.
static <T> HubDelegate.HubCurrentStateEnum	getCurrentState(Hub<T> thisHub, Hub<T> hubNew, ArrayList<T> alNew) Check to see if a Hub is correctly linked, or if it is in mid-flight of being changed.
static int	getLoadedSize(Hub thisHub)
static Class	getMasterClass(Hub hub) Returns the Class of OAObject that owns this Hub.
static OAObject	getMasterObject(Hub hub) Returns the OAObject that owns this Hub
protected static Object	getProperty(Hub thisHub, String name)
protected static String	getPropertyPathforClasses(Hub hub, Class[] classes)
protected static Object	getRealObject(Hub hub, Object object)
static int	getSize(Hub thisHub)
static boolean	isValid(Hub thisHub) If this hub has a master Hub or link Hub and that Hub does not have an active Object set, then this Hub is invalid.
protected static void	removeProperty(Hub thisHub, String name)
static void	resequence(Hub thisHub)
static void	setAutoMatch(Hub thisHub, String property, Hub hubMaster, boolean bServerSideOnly) Makes sure that for each object in a hubMaster, there exists an object in this hub where property is equal to the hubMaster object.
static void	setAutoMatch(Hub thisHub, String property, Hub hubMaster, boolean bServerSideOnly, OAObject objStop, String stopProperty)
static void	setAutoSequence(Hub thisHub, String property, int startNumber, boolean bKeepSeq) Used to update a property in each object to equal/store the position within this Hub.
static void	setObjectClass(Hub thisHub, Class objClass) Set the Class of objects that this Hub will contain.
protected static void	setProperty(Hub thisHub, String name, Object obj)
static void	setReferenceable(Hub hub, boolean bReferenceable)
static void	setUniqueProperty(Hub thisHub, String propertyName)
static boolean	verifyUniqueProperty(Hub thisHub, Object object) Verifies that the property in obj is unique for all objects in this Hub (not in all of system).

Methods inherited from class java.lang.Object

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

Field Detail

TRUE

public static final Boolean TRUE

FALSE

public static final Boolean FALSE

Constructor Detail

HubDelegate

public HubDelegate()

Method Detail

getChanged

public static boolean getChanged(Hub thisHub,
                                 int iCascadeRule,
                                 OACascade cascade)

verifyUniqueProperty

public static boolean verifyUniqueProperty(Hub thisHub,
                                           Object object)

Verifies that the property in obj is unique for all objects in this Hub (not in all of system).
Note: if OAObject and isLoading, then true is always returned.
Note: if property value is a null or a blank String, then it is not checked.

Returns:

true if object is valid, false if another object already uses same unique property value.

getRealObject

protected static Object getRealObject(Hub hub,
                                      Object object)

getPropertyPathforClasses

protected static String getPropertyPathforClasses(Hub hub,
                                                  Class[] classes)

getMasterObject

public static OAObject getMasterObject(Hub hub)

Returns the OAObject that owns this Hub

See Also:

to get the sharedHub that has a DataMaster

getMasterClass

public static Class getMasterClass(Hub hub)

Returns the Class of OAObject that owns this Hub.

setObjectClass

public static void setObjectClass(Hub thisHub,
                                  Class objClass)

Set the Class of objects that this Hub will contain.

Note: you can not reset the Object class if there are any objects in it.

Parameters:

objClass - Class for the object being stored

isValid

public static boolean isValid(Hub thisHub)

If this hub has a master Hub or link Hub and that Hub does not have an active Object set, then this Hub is invalid.

getCurrentState

public static <T> HubDelegate.HubCurrentStateEnum getCurrentState(Hub<T> thisHub,
                                                                  Hub<T> hubNew,
                                                                  ArrayList<T> alNew)

Check to see if a Hub is correctly linked, or if it is in mid-flight of being changed.

Example: when an event affects multiple listeners, that affect updating detail hubs, hubMergers, etc.

This will check that a Hub is currently pointing (shared) with the correct master object. Used when Hubs are shared, master/detail, hubMerger, hubCopy, hubFilter, hubCombined.

Parameters:

thisHub -

hubNew - if not null and the Hub is not InSync, then hubNew will be shared or populated with the correct current hub.

arrayList - same as hubNew, but using an arrayList

Returns:

level of status.

_getCurrentState

protected static <T> HubDelegate.HubCurrentStateEnum _getCurrentState(Hub<T> thisHub,
                                                                      Hub<T> hubNew,
                                                                      ArrayList<T> alNew,
                                                                      Set<Hub> hmHub)

getControllingHub

public static Hub getControllingHub(Hub thisHub)

created 20110904 Find the hub that controls whether or not this hub is valid. So that it can also be listened to, so that hub isValid can be recalculated

Returns:

controlling hub, or param hub if there is no controlling hub

getAnyAddHub

public static Hub getAnyAddHub(Hub hub)

Returns this hub, or one of its shared Hubs, that has an addHub established.

_updateHubAddsAndRemoves

protected static void _updateHubAddsAndRemoves(Hub thisHub,
                                               int iCascadeRule,
                                               OACascade cascade,
                                               boolean bIsSaving)

20181211 removed, use hub.getLinkHub(true) Returns this or any shared hub that uses the same active object and is linked to another Hub. public static Hub getAnyLinkHub(final Hub thisHub) { if (thisHub.getLinkHub() != null) return thisHub; // 20120716 OAFilter filter = new OAFilter() {

setUniqueProperty

public static void setUniqueProperty(Hub thisHub,
                                     String propertyName)

setAutoSequence

public static void setAutoSequence(Hub thisHub,
                                   String property,
                                   int startNumber,
                                   boolean bKeepSeq)

Used to update a property in each object to equal/store the position within this Hub.

Parameters:

property - is neme of property to update.

startNumber - is number to begin numbering at. Default is 0, which will match the Hub position.

bKeepSeq, - if false then seq numbers are not updated when an object is removed

getAutoSequence

public static HubAutoSequence getAutoSequence(Hub thisHub)

resequence

public static void resequence(Hub thisHub)

setAutoMatch

public static void setAutoMatch(Hub thisHub,
                                String property,
                                Hub hubMaster,
                                boolean bServerSideOnly)

Makes sure that for each object in a hubMaster, there exists an object in this hub where property is equal to the hubMaster object.

Parameters:

hubMaster - hub with list of object

property - Property in this hubs objects that match object type in hubMaster

setAutoMatch

public static void setAutoMatch(Hub thisHub,
                                String property,
                                Hub hubMaster,
                                boolean bServerSideOnly,
                                OAObject objStop,
                                String stopProperty)

getAutoMatch

public static HubAutoMatch getAutoMatch(Hub thisHub)

getSize

public static int getSize(Hub thisHub)

getLoadedSize

public static int getLoadedSize(Hub thisHub)

setProperty

protected static void setProperty(Hub thisHub,
                                  String name,
                                  Object obj)

getProperty

protected static Object getProperty(Hub thisHub,
                                    String name)

removeProperty

protected static void removeProperty(Hub thisHub,
                                     String name)

setReferenceable

public static void setReferenceable(Hub hub,
                                    boolean bReferenceable)