com.viaoa.object

Class OAObjectReflectDelegate

java.lang.Object

com.viaoa.object.OAObjectReflectDelegate

public class OAObjectReflectDelegate
extends Object

Constructor Summary

Constructors

Constructor and Description
OAObjectReflectDelegate()

Method Summary

Modifier and Type	Method and Description
static void	_copyInto(OAObject oaObj, OAObject newObject, String[] excludeProperties, OACopyCallback copyCallback, HashMap<Integer,Object> hmNew)
static OAObject	_createCopy(OAObject oaObj, String[] excludeProperties, OACopyCallback copyCallback, HashMap<Integer,Object> hmNew)
static boolean	areAllReferencesLoaded(OAObject obj, boolean bIncludeCalc)
static void	copyInto(OAObject oaObj, OAObject newObject, String[] excludeProperties, OACopyCallback copyCallback) Copies the properties and some of the links from a source object (this) to a new object.
static void	copyInto(OAObject oaObj, OAObject newObject, String[] excludeProperties, OACopyCallback copyCallback, HashMap<Integer,Object> hmNew)
static OAObject	createCopy(OAObject oaObj, String[] excludeProperties) Create a copy of an object, excluding selected properties.
static OAObject	createCopy(OAObject oaObj, String[] excludeProperties, OACopyCallback copyCallback)
static Object	createNewObject(Class clazz) Create a new instance of an object.
static Hub	findCommonHierarchyHub(OAObject obj1, OAObject obj2, int maxLevelsToCheck) Find the common Hub that two objects are descendants of.
protected static Hub	findCommonHierarchyHub(OAObject obj1, OAObject obj2, int currentLevel, int maxLevelsToCheck)
static int	getHierarchyLevelsToHub(Hub findHub, OAObject fromObj, int maxLevelsToCheck)
protected static int	getHierarchyLevelsToHub(Hub findHub, OAObject fromObj, int currentLevel, int maxLevelsToCheck)
static Class	getHubObjectClass(Method method)
static OAObject	getObject(Class clazz, Object key) DataSource independent method to retrieve an object.
static OAObject	getObject(Class clazz, Object key, OAObjectInfo oi)
static Object	getObjectToDisplay(Hub hubFrom, Object fromObject, Hub hubChild) get the "real" object that needs to be displayed, based on a parent/from Hub, and a from object (ex: row in table), and the hub that it originates from.
static boolean	getPrimitiveNull(OAObject oaObj, String propertyName)
static Object	getProperty(Hub hubLast, OAObject oaObj, String propPath)
static Object	getProperty(Hub hub, String propPath)
static Object	getProperty(OAObject oaObj, String propPath)
static OAObjectKey	getPropertyObjectKey(OAObject oaObj, String property) Used to retrieve a reference key without actually loading the object.
static String	getPropertyPathBetweenHubs(Hub hubParent, Hub hubChild) get the property path from a Parent hub to a child hub, that is all of type=One.
static String	getPropertyPathFromMaster(OAObject objParent, Hub hubChild)
static Object	getRawReference(OAObject oaObj, String name) This method is used to get the value of a relationship.
static byte[]	getReferenceBlob(OAObject oaObj, String propertyName)
static Hub	getReferenceHub(OAObject oaObj, String linkPropertyName, String sortOrder, boolean bSequence, Hub hubMatch) DataSource independent method to retrieve a reference property that is a Hub Collection.
static Object	getReferenceObject(OAObject oaObj, String linkPropertyName) DataSource independent method to retrieve a reference property.
static String[]	getUnloadedReferences(OAObject obj, boolean bIncludeCalc)
static String[]	getUnloadedReferences(OAObject obj, boolean bIncludeCalc, String exceptPropertyName)
static String[]	getUnloadedReferences(OAObject obj, boolean bIncludeCalc, String exceptPropertyName, boolean bIncludeLarge)
static boolean	hasReference(OAObject oaObj)
static boolean	hasReferenceObjectBeenLoaded(OAObject oaObj, String propertyName) Checks to see if the actual value for a property has been loaded.
static boolean	isReferenceHubLoaded(OAObject oaObj, String propertyName)
static boolean	isReferenceHubLoadedAndEmpty(OAObject oaObj, String propertyName)
static boolean	isReferenceHubLoadedAndNotEmpty(OAObject oaObj, String propertyName)
static boolean	isReferenceNullOrNotLoaded(OAObject oaObj, String propertyName)
static boolean	isReferenceNullOrNotLoadedOrEmptyHub(OAObject oaObj, String propertyName)
static boolean	isReferenceObjectLoadedAndNotEmpty(OAObject oaObj, String propertyName)
static boolean	isReferenceObjectNullOrEmpty(OAObject oaObj, String propertyName)
static void	loadAllReferences(Hub hub)
static void	loadAllReferences(Hub hub, boolean bIncludeCalc)
static int	loadAllReferences(Hub hub, int maxLevelsToLoad)
static int	loadAllReferences(Hub hub, int maxLevelsToLoad, int additionalOwnedLevelsToLoad)
static int	loadAllReferences(Hub hub, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc)
static int	loadAllReferences(Hub hub, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, int maxRefsToLoad)
static int	loadAllReferences(Hub hub, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, OACallback callback)
static int	loadAllReferences(Hub hub, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, OACallback callback, int maxRefsToLoad)
static int	loadAllReferences(Hub hub, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, OACascade cascade)
static int	loadAllReferences(Hub hub, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, OACascade cascade, int maxRefsToLoad)
static int	loadAllReferences(Hub hub, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, int maxRefsToLoad)
static int	loadAllReferences(Hub hub, int levelsLoaded, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, OACallback callback, OACascade cascade)
static int	loadAllReferences(Hub hub, int levelsLoaded, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, OACallback callback, OACascade cascade, int maxRefsToLoad)
static void	loadAllReferences(OAObject obj) Used to load all references to an object.
static void	loadAllReferences(OAObject obj, boolean bIncludeCalc)
static int	loadAllReferences(OAObject obj, boolean bOne, boolean bMany, boolean bIncludeCalc)
static int	loadAllReferences(OAObject obj, int maxLevelsToLoad)
static int	loadAllReferences(OAObject obj, int maxLevelsToLoad, int additionalOwnedLevelsToLoad)
static int	loadAllReferences(OAObject obj, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc)
static int	loadAllReferences(OAObject obj, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, int maxRefsToLoad)
static int	loadAllReferences(OAObject obj, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, int maxRefsToLoad, long maxEndTime)
static int	loadAllReferences(OAObject obj, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, OACallback callback)
static int	loadAllReferences(OAObject obj, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, OACallback callback, int maxRefsToLoad)
static int	loadAllReferences(OAObject obj, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, OACascade cascade)
static int	loadAllReferences(OAObject obj, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, OACascade cascade, int maxRefsToLoad)
static int	loadAllReferences(OAObject obj, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, int maxRefsToLoad)
static int	loadAllReferences(OAObject obj, int levelsLoaded, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, OACallback callback, OACascade cascade)
static int	loadAllReferences(OAObject obj, int levelsLoaded, int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, OACallback callback, OACascade cascade, int maxRefsToLoad)
static void	loadProperties(Hub hub, String... propertyPaths) Used to preload data, this will recursively load all references in the given Property Paths.
static void	loadProperties(OAObject oaObj, String... propertyPaths) Used to preload data, this will recursively load all references in the given Property Paths.
static void	loadReferences(OAObject obj, boolean bIncludeCalc, int max)
protected static void	removePrimitiveNull(OAObject oaObj, String propertyName)
protected static void	setPrimitiveNull(OAObject oaObj, String propertyName)
static void	setProperty(OAObject oaObj, String propName, Object value, String fmt)
static void	storeLinkValue(OAObject oaObj, String propertyName, Object value) used for "quick" storing/loading objects

Methods inherited from class java.lang.Object

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

Constructor Detail

OAObjectReflectDelegate

public OAObjectReflectDelegate()

Method Detail

createNewObject

public static Object createNewObject(Class clazz)

Create a new instance of an object. If OAClient.client exists, this will create the object on the server, where the server datasource can initialize object.

getProperty

public static Object getProperty(Hub hub,
                                 String propPath)

getProperty

public static Object getProperty(OAObject oaObj,
                                 String propPath)

See Also:

OAObject.getProperty(String)

getProperty

public static Object getProperty(Hub hubLast,
                                 OAObject oaObj,
                                 String propPath)

setProperty

public static void setProperty(OAObject oaObj,
                               String propName,
                               Object value,
                               String fmt)

See Also:

This can also be used to add Objects (or ObjectKeys) to a Hub. When the Hub is then retrieved, the value will be converted to OAObject subclasses.

storeLinkValue

public static void storeLinkValue(OAObject oaObj,
                                  String propertyName,
                                  Object value)

used for "quick" storing/loading objects

getPrimitiveNull

public static boolean getPrimitiveNull(OAObject oaObj,
                                       String propertyName)

setPrimitiveNull

protected static void setPrimitiveNull(OAObject oaObj,
                                       String propertyName)

removePrimitiveNull

protected static void removePrimitiveNull(OAObject oaObj,
                                          String propertyName)

getObject

public static OAObject getObject(Class clazz,
                                 Object key)

DataSource independent method to retrieve an object. Find the OAObject given a key value. This will look in the Cache, Server (if running as workstation) and the DataSource (if not running as workstation).

Parameters:

clazz - class of reference of to find.

key - can be the value of the key or an OAObjectKey

getObject

public static OAObject getObject(Class clazz,
                                 Object key,
                                 OAObjectInfo oi)

getReferenceHub

public static Hub getReferenceHub(OAObject oaObj,
                                  String linkPropertyName,
                                  String sortOrder,
                                  boolean bSequence,
                                  Hub hubMatch)

DataSource independent method to retrieve a reference property that is a Hub Collection.

Parameters:

linkPropertyName - name of property to retrieve. (case insensitive)

sortOrder -

bSequence - if true, then create a hub sequencer to manage the order of the objects in the hub.

getRawReference

public static Object getRawReference(OAObject oaObj,
                                     String name)

This method is used to get the value of a relationship. Calling it will not load objects. To load objects, call getReferenceHub(name) or getReferenceObject(name)

Returns:

one of the following: null, OAObjectKey, OAObject, Hub of OAObjects, Hub of OAObjectKeys

See Also:

to have the OAObject returned., to have a Hub of OAObjects returned.

hasReference

public static boolean hasReference(OAObject oaObj)

getUnloadedReferences

public static String[] getUnloadedReferences(OAObject obj,
                                             boolean bIncludeCalc)

getUnloadedReferences

public static String[] getUnloadedReferences(OAObject obj,
                                             boolean bIncludeCalc,
                                             String exceptPropertyName)

getUnloadedReferences

public static String[] getUnloadedReferences(OAObject obj,
                                             boolean bIncludeCalc,
                                             String exceptPropertyName,
                                             boolean bIncludeLarge)

loadAllReferences

public static void loadAllReferences(OAObject obj)

Used to load all references to an object.

loadAllReferences

public static void loadAllReferences(Hub hub)

loadAllReferences

public static void loadAllReferences(Hub hub,
                                     boolean bIncludeCalc)

loadAllReferences

public static void loadAllReferences(OAObject obj,
                                     boolean bIncludeCalc)

loadReferences

public static void loadReferences(OAObject obj,
                                  boolean bIncludeCalc,
                                  int max)

areAllReferencesLoaded

public static boolean areAllReferencesLoaded(OAObject obj,
                                             boolean bIncludeCalc)

loadAllReferences

public static int loadAllReferences(OAObject obj,
                                    boolean bOne,
                                    boolean bMany,
                                    boolean bIncludeCalc)

loadAllReferences

public static int loadAllReferences(OAObject obj,
                                    int maxLevelsToLoad)

loadAllReferences

public static int loadAllReferences(Hub hub,
                                    int maxLevelsToLoad)

loadAllReferences

public static int loadAllReferences(OAObject obj,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad)

loadAllReferences

public static int loadAllReferences(OAObject obj,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    int maxRefsToLoad)

loadAllReferences

public static int loadAllReferences(Hub hub,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad)

loadAllReferences

public static int loadAllReferences(Hub hub,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    int maxRefsToLoad)

loadAllReferences

public static int loadAllReferences(OAObject obj,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc)

loadAllReferences

public static int loadAllReferences(OAObject obj,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    int maxRefsToLoad)

loadAllReferences

public static int loadAllReferences(OAObject obj,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    int maxRefsToLoad,
                                    long maxEndTime)

loadAllReferences

public static int loadAllReferences(Hub hub,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc)

loadAllReferences

public static int loadAllReferences(Hub hub,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    int maxRefsToLoad)

loadAllReferences

public static int loadAllReferences(OAObject obj,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    OACallback callback)

loadAllReferences

public static int loadAllReferences(OAObject obj,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    OACallback callback,
                                    int maxRefsToLoad)

loadAllReferences

public static int loadAllReferences(Hub hub,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    OACallback callback)

loadAllReferences

public static int loadAllReferences(Hub hub,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    OACallback callback,
                                    int maxRefsToLoad)

loadAllReferences

public static int loadAllReferences(Hub hub,
                                    int levelsLoaded,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    OACallback callback,
                                    OACascade cascade)

loadAllReferences

public static int loadAllReferences(Hub hub,
                                    int levelsLoaded,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    OACallback callback,
                                    OACascade cascade,
                                    int maxRefsToLoad)

loadAllReferences

public static int loadAllReferences(Hub hub,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    OACascade cascade)

loadAllReferences

public static int loadAllReferences(Hub hub,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    OACascade cascade,
                                    int maxRefsToLoad)

loadAllReferences

public static int loadAllReferences(OAObject obj,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    OACascade cascade)

loadAllReferences

public static int loadAllReferences(OAObject obj,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    OACascade cascade,
                                    int maxRefsToLoad)

loadAllReferences

public static int loadAllReferences(OAObject obj,
                                    int levelsLoaded,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    OACallback callback,
                                    OACascade cascade)

loadAllReferences

public static int loadAllReferences(OAObject obj,
                                    int levelsLoaded,
                                    int maxLevelsToLoad,
                                    int additionalOwnedLevelsToLoad,
                                    boolean bIncludeCalc,
                                    OACallback callback,
                                    OACascade cascade,
                                    int maxRefsToLoad)

Parameters:

levelsLoaded - number of levels of references that have been loaded.

maxLevelsToLoad - max levels of references to recursively load.

additionalOwnedLevelsToLoad - additional levels of owned references to load

bIncludeCalc - include calculated links

callback - will be called before loading references. If the callback.updateObject returns false, then the current object references will not be loaded

cascade - used to impl visitor pattern

maxRefsToLoad - maximum recursive objects to call loadAllRefereces on.

getReferenceBlob

public static byte[] getReferenceBlob(OAObject oaObj,
                                      String propertyName)

getReferenceObject

public static Object getReferenceObject(OAObject oaObj,
                                        String linkPropertyName)

DataSource independent method to retrieve a reference property.

If reference object is not already loaded, then OADataSource will be used to retrieve object.

getPropertyObjectKey

public static OAObjectKey getPropertyObjectKey(OAObject oaObj,
                                               String property)

Used to retrieve a reference key without actually loading the object. Datasourcs stores the key value for references, that are then used to retrieve the object when requested using getObject(property). This method is a way to get the key, without loading the object.

Returns:

the OAObjectKey of a ONE reference. Does not call getMethod, but internally stored value. see isLoaded to see if object has been loaded and exists in memory. isLoaded will return false if the property has never been set, or loaded, or if the objectKey has been set and the object for the key is not in memory. This method will always return the objectKey for the reference. see getObject, which will loaded the object from memory or datasource.

hasReferenceObjectBeenLoaded

public static boolean hasReferenceObjectBeenLoaded(OAObject oaObj,
                                                   String propertyName)

Checks to see if the actual value for a property has been loaded. This will also check to see if a reference ObjectKey was loaded and the "real" object is in memory.

isReferenceObjectNullOrEmpty

public static boolean isReferenceObjectNullOrEmpty(OAObject oaObj,
                                                   String propertyName)

isReferenceObjectLoadedAndNotEmpty

public static boolean isReferenceObjectLoadedAndNotEmpty(OAObject oaObj,
                                                         String propertyName)

isReferenceNullOrNotLoaded

public static boolean isReferenceNullOrNotLoaded(OAObject oaObj,
                                                 String propertyName)

isReferenceNullOrNotLoadedOrEmptyHub

public static boolean isReferenceNullOrNotLoadedOrEmptyHub(OAObject oaObj,
                                                           String propertyName)

isReferenceHubLoaded

public static boolean isReferenceHubLoaded(OAObject oaObj,
                                           String propertyName)

isReferenceHubLoadedAndEmpty

public static boolean isReferenceHubLoadedAndEmpty(OAObject oaObj,
                                                   String propertyName)

isReferenceHubLoadedAndNotEmpty

public static boolean isReferenceHubLoadedAndNotEmpty(OAObject oaObj,
                                                      String propertyName)

loadProperties

public static void loadProperties(OAObject oaObj,
                                  String... propertyPaths)

Used to preload data, this will recursively load all references in the given Property Paths.

Parameters:

oaObj - root object to use.

propertyPaths - one or more propertyPaths, that can be loaded using a single visit to each property.

loadProperties

public static void loadProperties(Hub hub,
                                  String... propertyPaths)

Used to preload data, this will recursively load all references in the given Property Paths.

Parameters:

hub - root objects to use.

propertyPaths - one or more propertyPaths, that can be loaded using a single visit to each property.

createCopy

public static OAObject createCopy(OAObject oaObj,
                                  String[] excludeProperties)

Create a copy of an object, excluding selected properties.

Returns:

new copy of the object

createCopy

public static OAObject createCopy(OAObject oaObj,
                                  String[] excludeProperties,
                                  OACopyCallback copyCallback)

_createCopy

public static OAObject _createCopy(OAObject oaObj,
                                   String[] excludeProperties,
                                   OACopyCallback copyCallback,
                                   HashMap<Integer,Object> hmNew)

copyInto

public static void copyInto(OAObject oaObj,
                            OAObject newObject,
                            String[] excludeProperties,
                            OACopyCallback copyCallback)

Copies the properties and some of the links from a source object (this) to a new object. For links of type One, all of the links are used, the same ref object from the source object is used. For links of type Many, only the owned links are used, and clones of the objects are created in the Hub of the new object. OACopyCallback can be used to control what is copied.

copyInto

public static void copyInto(OAObject oaObj,
                            OAObject newObject,
                            String[] excludeProperties,
                            OACopyCallback copyCallback,
                            HashMap<Integer,Object> hmNew)

_copyInto

public static void _copyInto(OAObject oaObj,
                             OAObject newObject,
                             String[] excludeProperties,
                             OACopyCallback copyCallback,
                             HashMap<Integer,Object> hmNew)

getHubObjectClass

public static Class getHubObjectClass(Method method)

findCommonHierarchyHub

public static Hub findCommonHierarchyHub(OAObject obj1,
                                         OAObject obj2,
                                         int maxLevelsToCheck)

Find the common Hub that two objects are descendants of. param currentLevel current level of parents that have been checked

Parameters:

maxLevelsToCheck - total number of parents to check

findCommonHierarchyHub

protected static Hub findCommonHierarchyHub(OAObject obj1,
                                            OAObject obj2,
                                            int currentLevel,
                                            int maxLevelsToCheck)

getHierarchyLevelsToHub

public static int getHierarchyLevelsToHub(Hub findHub,
                                          OAObject fromObj,
                                          int maxLevelsToCheck)

getHierarchyLevelsToHub

protected static int getHierarchyLevelsToHub(Hub findHub,
                                             OAObject fromObj,
                                             int currentLevel,
                                             int maxLevelsToCheck)

getPropertyPathFromMaster

public static String getPropertyPathFromMaster(OAObject objParent,
                                               Hub hubChild)

getObjectToDisplay

public static Object getObjectToDisplay(Hub hubFrom,
                                        Object fromObject,
                                        Hub hubChild)

get the "real" object that needs to be displayed, based on a parent/from Hub, and a from object (ex: row in table), and the hub that it originates from.

Parameters:

hubFrom - ex: hubDept

fromObject - ex: dept

hubChild - ex: hubEmplyeeType, (enum of strings) and is linked to hubEmp

Returns:

hubEmployeeType.getAt(pos), where pos is dept.manager.employeeType

getPropertyPathBetweenHubs

public static String getPropertyPathBetweenHubs(Hub hubParent,
                                                Hub hubChild)

get the property path from a Parent hub to a child hub, that is all of type=One.

Parameters:

hubParent - parent hub that needs to have the path expanded from.

hubChild - child Hub that has a path