Hub (com.viaoa:oa-core 3.7.12 API)

java.lang.Object
- com.viaoa.hub.Hub<TYPE>

All Implemented Interfaces:

Serializable, Cloneable, Comparable<TYPE>, Iterable<TYPE>, Collection<TYPE>, List<TYPE>

Direct Known Subclasses:

DetailHub, FilteredHub, LinkedHub, MergedHub, SharedHub
```
public class Hub<TYPE>
extends Object
implements Serializable, List<TYPE>, Cloneable, Comparable<TYPE>, Iterable<TYPE>
```
Observable Collection Class that has similar methods as both ArrayList and HashMap. When used with OAObject, the Hub sends all events for the objects that it contains.
Observable means that will notify listeners whenever an event happens. Hub has methods to register listeners and for sending Events.
Searching
Hub has methods to find any object based on a property path and search value.
Sorting
Hub has methods for sorting/ordering of objects within the collection. The collection is kept sorted as objects are added, inserted, or changed. A property path can be used or a customized comparator can be used.
Manages OAObjects
Hub is used by OAObject for sending events and for managing event listeners.
Works directly with OADataSource
The Hub Class has methods to directly select objects from a DataSource/database using an OASelect. Hubs are also set up to only pre-fetch a certain number of objects at a time, so that response is faster. Methods to get a total count of objects and to load all objects are also included.
Recursive Hubs
A Hub that is recursive is where each object has children objects of the same class. Each object has a method to get its "parent". A "Root Hub" is the top Hub where all of the objects in it do not have a parent (value is null). Hub and OAObject will automatically put objects in the correct Hub based on the value of the parent. If another Object owns the Hub, then all children under it will have a reference to the owner object.
Hub Filtering
A Hub can be created that filters objects from another Hub. see HubFilter for more information.
XML Support
Hub has methods to work directly with OAXMLReader/Writer to read/write XML.
Serialization
Works with OAObject to handle serialization of objects to/from a stream.
Inside the Hub are the following objects:
- Data - a Vector and Hashtable that are used to store the objects. This can be shared/used by other Hubs.
- Unique - information that is unique to a single Hub. ie: the registered event listeners.
- Active - keeps track of the object within the Hub that has the current focus. This can be shared/used by other Hubs.
- Master - Hub/Object that this Hub belongs with. Example: a Hub of Employee objects that belongs to a Department object.
Navigational features
The Hub Collection has methods that allow it to be navigated. This is primarily used when using Hubs with GUI components, where the Hub acts as the Model in MVC (Model/View/Controller) that is commonly used for building GUI applications.
Hubs have an Active Object, which is a reference to the object in the Hub that currently has the focus. Navigational methods in the Hub can be used to change the active object.

Configuring Hubs to work together (the Wiring)
Hubs can be configured to form relationships and automatically work together.
This includes:
- Creating Master/Detail relationships. see DetailHub
- Hubs that Share the same data. see SharedHub
- Linking/Connecting Hubs together. see HubLink
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected HubData`	`data` Internal object used to store objects in Vector and Hashtable.
`protected com.viaoa.hub.HubDataActive`	`dataa` Internal object used store active object, bof flag, eof flag.
`protected com.viaoa.hub.HubDataMaster`	`datam` Internal object used store master object and Hub.
`protected com.viaoa.hub.HubDataUnique`	`datau` Internal object used unique information about this Hub.
`boolean`	`DEBUG`

Constructor Summary

Constructors
Constructor and Description
`Hub()` No argument constructor for creating a new Hub.
`Hub(Class<TYPE> objClass)` Create a hub that will contain objects for a particular Class.
`Hub(Class<TYPE> objClass, int vecSize)` Create a hub that will contain a Class of objects.
`Hub(Class<TYPE> objClass, int vecSize, int incrementSize)`
`Hub(Class clazz, OAObject masterObject)`
`Hub(Class clazz, OAObject masterObject, OALinkInfo linkInfo, boolean bCreateSelect)` Create a hub that will contain a Class of objects, and the Master object for this hub is known.
`Hub(Hub masterHub)` Create a shared hub, this is same as calling hub.getSharedHub().
`Hub(OAObject obj)` Create a new hub with a single object, and make it AO

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Hub<TYPE> hub)`
`void`	`add(int index, TYPE element)`
`void`	`add(List<TYPE> list)`
`boolean`	`add(TYPE obj)` Add an Object to end of collection.
`boolean`	`addAll(Collection<? extends TYPE> c)`
`boolean`	`addAll(int index, Collection<? extends TYPE> c)`
`void`	`addElement(TYPE obj)` Helper method that mimics Vector.addElement(), it calls Hub.add(obj, false)
`void`	`addHubListener(HubListener<TYPE> hl)` Add a Listener to this Hub.
`void`	`addHubListener(HubListener<TYPE> hl, boolean bActiveObjectOnly)`
`void`	`addHubListener(HubListener<TYPE> hl, String property)` Add a Listener to this hub specifying a specific property name.
`void`	`addHubListener(HubListener<TYPE> hl, String property, boolean bActiveObjectOnly)`
`void`	`addHubListener(HubListener<TYPE> hl, String property, String dependentPropertyPath)`
`void`	`addHubListener(HubListener<TYPE> hl, String property, String[] dependentPropertyPaths)`
`void`	`addHubListener(HubListener<TYPE> hl, String property, String[] dependentPropertyPaths, boolean bActiveObjectOnly)`
`void`	`addHubListener(HubListener<TYPE> hl, String property, String[] dependentPropertyPaths, boolean bActiveObjectOnly, boolean bUseBackgroundThread)`
`void`	`addHubListener(HubListener<TYPE> hl, String property, String dependentPropertyPath, boolean bActiveObjectOnly)`
`void`	`addListener(HubListener<TYPE> hl)`
`void`	`addTriggerListener(HubListener<TYPE> hl, String property, String propertyPath)` add a trigger to this hub that will send a property change event.
`void`	`addTriggerListener(HubListener<TYPE> hl, String property, String propertyPath, boolean useBackgroundThread)`
`boolean`	`canAdd()`
`boolean`	`canAdd(Object obj)`
`void`	`cancelSelect()` Cancel the reading of anymore records from OADataSource.
`void`	`cancelSort()` Removes/disconnects HubSorter (if any) that is keeping objects in a sorted order.
`void`	`clear()` Removes all objects from this Hub.
`Object`	`clone()` Creates a new Hub with the same objects that are in this Hub.
`int`	`compareTo(Object obj)`
`boolean`	`contains(Object obj)` Returns true if object exists in Hub.
`boolean`	`containsAll(Collection<?> c)`
`void`	`copyInto(Hub h)` Copy all objects in this hub to Hub h.
`void`	`copyInto(TYPE[] anArray)` Copy objects into an array.
`Hub<TYPE>`	`createFilteredHub(OAFilter filter, String... dependentPropertyPaths)`
`Hub<TYPE>`	`createShared()`
`Hub<TYPE>`	`createSharedHub()` Navigational method used to create a shared version of another Hub, so that this Hub will use the same objects as the shared hub.
`Hub<TYPE>`	`createSharedHub(boolean bShareAO)` Create a shared version of another Hub, so that this Hub will use the same objects as the shared hub.
`void`	`deleteAll()` Delete all objects in this hub.
`TYPE`	`elementAt(int pos)` Returns object at a particular position within the Hub.
`void`	`ensureCapacity(int size)` This will set the new capacity for the Hub.
`protected void`	`finalize()` Finalize method.
`TYPE`	`find(String propertyPath, Object findValue)` Finds first object that has a property that matches a value.
`TYPE`	`find(String propertyPath, Object findValue, boolean bSetAO)`
`TYPE`	`find(TYPE fromObject, String propertyPath, Object findValue)`
`TYPE`	`find(TYPE fromObject, String propertyPath, Object findValue, boolean bSetAO)`
`TYPE`	`findNext(TYPE fromObject, String propertyPath, Object findValue)`
`TYPE`	`findNext(TYPE fromObject, String propertyPath, Object findValue, boolean bSetAO)`
`TYPE`	`get(int index)`
`TYPE`	`getActiveObject()` Navigational method used to retrieve the current active object, or null if not set.
`Hub`	`getAddHub()` Returns the Hub that this Hub's active objects are added to.
`boolean`	`getAllowAdd()`
`boolean`	`getAllowAdd(int checkType, TYPE obj)` Uses OAObjectCallbackDelegate
`boolean`	`getAllowAdd(Object obj)`
`boolean`	`getAllowRemove(int checkType, TYPE obj)`
`boolean`	`getAllowRemoveAll(boolean bCheckObjectCallback, int checkType)`
`TYPE`	`getAO()`
`TYPE`	`getAt(int pos)`
`String`	`getCanAddMessage(OAObject obj)`
`boolean`	`getChanged(int cascadeRule)` Returns true if the hub has changed (objects were added/inserted/removed/replaced, or any object has been changed).
`int`	`getCurrentSize()` Number of Objects currently loaded in the collection.
`int`	`getDefaultPos()` Navigational method used to get the default position to set when a new list is generated.
`Hub`	`getDetailHub(Class clazz)` Used to create Master/Detail relationships.
`Hub`	`getDetailHub(Class[] classes)` Used to create Master/Detail relationships.
`Hub`	`getDetailHub(Class clazz, boolean bShareActive)` Used to create Master/Detail relationships.
`Hub`	`getDetailHub(Class clazz, boolean bShareActive, String selectOrder)` Used to create Master/Detail relationships.
`Hub`	`getDetailHub(Class clazz, String selectOrder)` Used to create Master/Detail relationships.
`Hub`	`getDetailHub(String path)` Used to create Master/Detail relationships.
`Hub`	`getDetailHub(String path, boolean bShareActive)` Used to create Master/Detail relationships.
`Hub`	`getDetailHub(String path, boolean bShareActive, String selectOrder)` Used to create Master/Detail relationships.
`Hub`	`getDetailHub(String path, Class objectClass)` Used to create Master/Detail relationships.
`Hub`	`getDetailHub(String path, Class objectClass, boolean bShareActive)` Used to create Master/Detail relationships.
`Hub`	`getDetailHub(String path, String selectOrder)` Used to create Master/Detail relationships.
`boolean`	`getEnabled()` Flag to know if add/remove are enabled
`TYPE`	`getLast()`
`Hub`	`getLinkHub(boolean bSearchOtherHubs)` Find the linkHub for this hub or any of this hub's shared hubs that have a linkHub.
`String`	`getLinkPath(boolean bSearchOtherHubs)`
`int`	`getLoadedSize()` Waits until all data is loaded before returning the size.
`Class`	`getMasterClass()`
`Hub`	`getMasterHub()` Used to create Master/Detail relationships.
`OAObject`	`getMasterObject()`
`boolean`	`getNullOnRemove()` Flag used to have the active object set to null when active object is removed from Hub.
`OAObjectInfo`	`getOAObjectInfo()`
`static OAObjectInfo`	`getOAObjectInfo(Class c)`
`TYPE`	`getObject(Object key)` Used to mimic Hashtable.get(key).
`TYPE`	`getObjectAt(int pos)` Get an object at a particular position, relative to 0
`Class<TYPE>`	`getObjectClass()` Returns the Class of the objects that are being stored in this Hub.
`int`	`getPos()` Navigational method used to set the active object to the object at specific position.
`int`	`getPos(Object object)` Returns the position of an object within the Hub.
`int`	`getPos(Object object, boolean bAdjustMaster)`
`Object`	`getProperty(String name)` Retrieve object from name/value pair.
`Hub`	`getRealHub()` If this is a shared Hub, returns the Hub that this is shared from, else will return this Hub.
`boolean`	`getRefresh()` Flag that determines if objects are refreshed from datasource when they become the active object (not yet implemented).
`Hub`	`getRootHub()` If this is a recursive hub with an owner, then the root hub will be returned, else null.
`OASelect`	`getSelect()` Returns the OASelect object currently used by select().
`OASelect`	`getSelect(boolean bCreateIfNull)`
`String`	`getSelectOrder(Hub thisHub)` Sort Order clause to use for select.
`String`	`getSelectWhere()`
`Hub<TYPE>`	`getSharedHub()` Returns the Hub that this Hub is sharing objects with.
`int`	`getSize()` Number of objects currently in collection.
`boolean`	`getVerifyRemove(int checkType, TYPE obj)`
`boolean`	`hasDetailHubs()` Returns true if this Hub has any detail hubs created.
`int`	`indexOf(Object obj)` Finds the position of an object in this hub.
`boolean`	`insert(TYPE obj, int pos)` Insert an Object at a position.
`boolean`	`isDeletingAll()` Used to know if all of the objects in this Hub being deleted.
`boolean`	`isEmpty()`
`boolean`	`isLoading()`
`boolean`	`isMoreData()`
`boolean`	`isOAObject()` Returns true if this Hub's objects are a subclass of OAObject
`boolean`	`isOwned()` Returns true if this hub of objects is owned by a master object.
`boolean`	`isServer()`
`boolean`	`isSorted()` Returns true if this Hub has a sorter that is keeping it sorted.
`boolean`	`isValid()`
`Iterator<TYPE>`	`iterator()`
`int`	`lastIndexOf(Object o)`
`ListIterator<TYPE>`	`listIterator()`
`ListIterator<TYPE>`	`listIterator(int index)`
`void`	`loadAllData()`
`void`	`move(int posFrom, int posTo)` Swap the position of two different objects within the hub.
`void`	`onAdd(HubOnEventInterface onEvent)`
`void`	`onBeforeRefresh(HubOnEventInterface onEvent)`
`void`	`onChangeAO(HubOnEventInterface onEvent)`
`void`	`onNewList(HubOnEventInterface onEvent)`
`void`	`onPropertyChange(HubOnEventInterface onEvent)`
`void`	`onPropertyChange(HubOnEventInterface onEvent, String propName)`
`void`	`onRemove(HubOnEventInterface onEvent)`
`protected Object`	`readResolve()` Used by serialization when reading objects from stream.
`void`	`refresh()` Refresh this hub by reselecting from DataSource.
`TYPE`	`remove(int pos)` This will remove the object at a position from this collection and send a remove event to all HubListeners.
`boolean`	`remove(Object obj)` This will remove an object from this collection and send a remove event to all HubListeners.
`void`	`removeAll()` Removes all objects from this Hub.
`boolean`	`removeAll(Collection<?> c)`
`TYPE`	`removeAt(int pos)`
`boolean`	`removeDetailHub(Hub hub)` Used to remove Master/Detail relationships.
`void`	`removeHubListener(HubListener<TYPE> hl)` Remove a Listener to this Hub.
`void`	`removeLinkHub()` Remove the link that this Hub has with another Hub.
`void`	`removeListener(HubListener<TYPE> hl)`
`void`	`removeProperty(String name)` Remove name/value pair.
`void`	`replace(int pos, TYPE obj)`
`void`	`resequence()`
`void`	`resetAO()` Navigational method that resets the current active object.
`void`	`resizeToFit()` This will set the new capacity for the Hub to the current size.
`void`	`resort()` Re-sort using last parameters from last sort or select.
`boolean`	`retainAll(Collection<?> c)`
`void`	`saveAll()` Save all objects in this hub.
`void`	`saveAll(int iCascadeRule)`
`void`	`select()` Used for retrieving all objects from OADataSource.
`void`	`select(OAObject whereObject, String orderByClause)` Select all objects from OADataSource that have a reference to parameter "object".
`void`	`select(OASelect select)` Used to populate Hub with objects returned from a OADataSource select.
`void`	`select(String whereClause)` Used for generating query to retrieve objects from OADataSource.
`void`	`select(String whereClause, Object[] params)`
`void`	`select(String whereClause, Object[] whereParams, String orderBy)`
`void`	`select(String whereClause, Object[] whereParams, String orderBy, OAFilter filter)` Used for generating query to retrieve objects from OADataSource.
`void`	`select(String whereClause, Object whereParam, String orderBy)`
`void`	`select(String whereClause, Object whereParam, String orderBy, OAFilter filter)`
`void`	`select(String whereClause, String orderBy)` Used for generating query to retrieve objects from OADataSource.
`void`	`select(String whereClause, String orderBy, OAFilter filter)`
`void`	`selectPassthru(String whereClause, String orderClause)` Send the query to OADataSource.selectPassthru.
`void`	`sendRefresh()` notifies clients that hub has changed, and should be retrieved from server.
`TYPE`	`set(int index, TYPE element)`
`TYPE`	`setActiveObject(int pos)` Navigational method that will set the position of the active object.
`void`	`setActiveObject(Object object)` Navigational method to set the active object.
`void`	`setAddHub(Hub addHub)` Hub used to add active object to whenever this active object is changed in this Hub.
`Object`	`setAO(int pos)`
`void`	`setAO(Object object)` Navigational method that sets the current active object.
`void`	`setAutoMatch(Hub hubMaster)` Makes sure that for each object in a hubMaster, there exists an object in this hub.
`void`	`setAutoMatch(Hub hubMaster, boolean bServerSideonly)`
`void`	`setAutoMatch(String property, Hub hubMaster)` Makes sure that for each object in a hubMaster, there exists an object in this hub where property is equal to the hubMaster object.
`void`	`setAutoMatch(String property, Hub hubMaster, boolean bServerSideOnly)`
`void`	`setAutoMatch(String property, Hub hubMaster, boolean bServerSideOnly, OAObject objStop, String stopProperty)`
`void`	`setAutoSequence(String property)` Used to update a property in each object to equal/store the position within this Hub.
`void`	`setAutoSequence(String property, int startNumber)` Used to update a property in each object to equal/store the position within this Hub.
`void`	`setAutoSequence(String property, int startNumber, boolean bKeepSeq)` Used to update a property in each object to equal/store the position within this Hub.
`void`	`setChanged(boolean b)` Flag to know if hub has been changed.
`void`	`setDefaultPos(int pos)` Navigational method that sets the defalut position of active object when a new list is set.
`void`	`setEnabled(boolean b)`
`void`	`setLink(Hub hub)`
`void`	`setLinkHub(Hub linkHub)` Have this Hub linked to another Hub.
`void`	`setLinkHub(Hub linkHub, boolean bAutoCreate)`
`void`	`setLinkHub(Hub linkHub, boolean bAutoCreate, boolean bAutoCreateAllowDups)` Used to automatically create a new Object in link Hub whenever the active object in this Hub is changed.
`void`	`setLinkHub(Hub linkHub, String property)` Sets up this Hub so that it will automatically work with a property of the same Class in another (link) Hub.
`void`	`setLinkHub(Hub linkHub, String property, boolean bAutoCreate)`
`void`	`setLinkHub(Hub linkHub, String property, boolean bAutoCreate, boolean bAutoCreateAllowDups)` Used to automatically create a new Object in link Hub whenever the active object in this Hub is changed.
`void`	`setLinkHub(String fromProperty, Hub linkHub, String toProperty)` Link/Connect a property in this hub to a property in another hub.
`protected void`	`setLinkHub(String propertyFrom, Hub linkHub, String propertyTo, boolean linkPosFlag)`
`void`	`setLinkHubOnPos(Hub linkHub, String property)` Set the property in a Hub to the position of the active object in this Hub.
`void`	`setLoading(boolean b)`
`void`	`setMasterHub(Hub masterHub)` Used to create Master/Detail relationships.
`void`	`setMasterHub(Hub masterHub, boolean bShared)` Used to create Master/Detail relationships.
`void`	`setMasterHub(Hub masterHub, Class clazz, String path, boolean bShared, String selectOrder)` Used to create Master/Detail relationships.
`void`	`setMasterHub(Hub masterHub, String path)` Used to create Master/Detail relationships.
`void`	`setMasterHub(Hub masterHub, String path, boolean bShared)` Used to create Master/Detail relationships.
`void`	`setNullOnRemove(boolean b)` Flag used to have the active object set to null when active object is removed from Hub (default=false).
`TYPE`	`setPos(int pos)` Navigational method used to set the active object to the object at specific position.
`void`	`setProperty(String name, Object obj)` Misc name/values pairs stored in this Hub.
`void`	`setRefresh(boolean b)` Flag to have Object's data refreshed from datasource whenever it is the active object (not implemented).
`void`	`setRootHub()`
`void`	`setSelectOrder(String s)` Sort Order clause to use for select.
`void`	`setSelectWhere(String s)` WHERE clause to use for select.
`void`	`setSelectWhereHub(Hub fromHub, String ppFromHub)`
`void`	`setSharedHub(Hub<TYPE> masterHub)` Create a shared version of another Hub, so that this Hub will use the same objects as the shared hub.
`void`	`setSharedHub(Hub<TYPE> masterHub, boolean bShareAO)` Create a shared version of another Hub, so that this Hub will use the same objects as the shared hub.
`void`	`setUniqueProperty(String propertyName)` This is a property that is unique within this Hub, not other Objects in this Hub can have the same value.
`int`	`size()`
`void`	`sort()` Re-sort using parameters from last sort or select.
`void`	`sort(Comparator comp)` Reorder objects in Hub using a custom Comparator.
`void`	`sort(String... propertyPaths)` Reorder objects in this Hub, sorted by the value(s) from propertyPath(s).
`void`	`sort(String propertyPaths, boolean bAscending)` Sorts objects by propertyPath and calls hubAfterSort() method from listeners.
`void`	`sort(String propertyPaths, boolean bAscending, Comparator comp)` Reorder objects in this Hub, sorted by the value(s) from propertyPath(s).
`Stream<TYPE>`	`stream()`
`List<TYPE>`	`subList(int fromIndex, int toIndex)`
`void`	`swap(int pos1, int pos2)` Swap the positon of two different objects within the hub.
`TYPE[]`	`toArray()` Copy and return an array objects.
`<TYPE> TYPE[]`	`toArray(TYPE[] anArray)`
`List<TYPE>`	`toList()`
`String`	`toString()` Returns default toString(), plus name of Object Class of the objects that are in the collection.
`void`	`updateLinkProperty(Object obj, Object value)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List
equals, hashCode, replaceAll, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - data
```
protected volatile HubData data
```
    Internal object used to store objects in Vector and Hashtable.
  - datau
```
protected com.viaoa.hub.HubDataUnique datau
```
    Internal object used unique information about this Hub.
  - dataa
```
protected volatile com.viaoa.hub.HubDataActive dataa
```
    Internal object used store active object, bof flag, eof flag.
  - datam
```
protected com.viaoa.hub.HubDataMaster datam
```
    Internal object used store master object and Hub.
  - DEBUG
```
public transient boolean DEBUG
```
- Constructor Detail
  - Hub
```
public Hub()
```
    No argument constructor for creating a new Hub. Note: you must call Hub.setObjectClass(objClass) before adding objects.
  - Hub
```
public Hub(OAObject obj)
```
    Create a new hub with a single object, and make it AO
  - Hub
```
public Hub(Class<TYPE> objClass)
```
    Create a hub that will contain objects for a particular Class. Objects that are added must be from this Class or subclass of this Class.
    Example: Hub h = new Hub(Employee.class)
    
    Parameters:
    
    objClass - Class for the object being stored
  - Hub
```
public Hub(Class<TYPE> objClass,
           int vecSize)
```
    Create a hub that will contain a Class of objects. Objects that are added must be from this Class or subclass of this Class.
    
    Parameters:
    
    objClass - Class for the object being stored
    
    vecSize - initial size of vector
  - Hub
```
public Hub(Class<TYPE> objClass,
           int vecSize,
           int incrementSize)
```
  - Hub
```
public Hub(Hub masterHub)
```
    Create a shared hub, this is same as calling hub.getSharedHub().
    
    See Also:
    
    createSharedHub()
  - Hub
```
public Hub(Class clazz,
           OAObject masterObject,
           OALinkInfo linkInfo,
           boolean bCreateSelect)
```
    Create a hub that will contain a Class of objects, and the Master object for this hub is known. This is only used by OAObject.getHub() to create a Hub that is owned by a object.
    example: Hub(Employee.class, dept) to set up a hub of employees for a specific department
    if a dataSource exists for this hub's objects, then select() will be called whenever the objects are referenced or by calling executeSelect() directly.
    
    Parameters:
    
    linkInfo - from hub class to master object
  - Hub
```
public Hub(Class clazz,
           OAObject masterObject)
```
- Method Detail
  - ensureCapacity
```
public void ensureCapacity(int size)
```
    This will set the new capacity for the Hub.
  - resizeToFit
```
public void resizeToFit()
```
    This will set the new capacity for the Hub to the current size.
  - readResolve
```
protected Object readResolve()
                      throws ObjectStreamException
```
    Used by serialization when reading objects from stream.
    
    Throws:
    
    ObjectStreamException
  - setProperty
```
public void setProperty(String name,
                        Object obj)
```
    Misc name/values pairs stored in this Hub.
    Used for storing additional info for hub. The property will be saved with hub on serialization.
    
    Parameters:
    
    name - of property (case insensitive)
    
    obj - value to store
    
    See Also:
    
    getProperty(java.lang.String), removeProperty(java.lang.String)
  - getProperty
```
public Object getProperty(String name)
```
    Retrieve object from name/value pair.
    
    Parameters:
    
    name - of property to get. (case insensitive) see #putProperty(String, Object)
    
    See Also:
    
    removeProperty(java.lang.String)
  - removeProperty
```
public void removeProperty(String name)
```
    Remove name/value pair.
    
    Parameters:
    
    name - of property to get. (case insensitive) see #putProperty(String, Object) see #getProperty
  - toString
```
public String toString()
```
    Returns default toString(), plus name of Object Class of the objects that are in the collection.
    
    Overrides:
    
    toString in class Object
  - setRefresh
```
public void setRefresh(boolean b)
```
    Flag to have Object's data refreshed from datasource whenever it is the active object (not implemented).
    Note: *** not yet implemented ***
    
    See Also:
    
    getRefresh()
  - getRefresh
```
public boolean getRefresh()
```
    Flag that determines if objects are refreshed from datasource when they become the active object (not yet implemented).
    Note: *** not yet implemented ***
    
    See Also:
    
    getRefresh()
  - getChanged
```
public boolean getChanged(int cascadeRule)
```
    Returns true if the hub has changed (objects were added/inserted/removed/replaced, or any object has been changed).
    
    Parameters:
    
    cascadeRule - is the rule from OAObject
  - setChanged
```
public void setChanged(boolean b)
```
    Flag to know if hub has been changed. This only affects changes that occurred by adds/inserts/removes/replaces and not changes to the Objects
  - copyInto
```
public void copyInto(TYPE[] anArray)
```
    Copy objects into an array.
    
    See Also:
    
    Vector.copyInto(java.lang.Object[])
  - toArray
```
public TYPE[] toArray()
```
    Copy and return an array objects.
    
    Specified by:
    
    toArray in interface Collection<TYPE>
    
    Specified by:
    
    toArray in interface List<TYPE>
    
    See Also:
    
    Vector.copyInto(java.lang.Object[])
  - toArray
```
public <TYPE> TYPE[] toArray(TYPE[] anArray)
```
    Specified by:
    
    toArray in interface Collection<TYPE>
    
    Specified by:
    
    toArray in interface List<TYPE>
  - toList
```
public List<TYPE> toList()
```
  - copyInto
```
public void copyInto(Hub h)
```
    Copy all objects in this hub to Hub h.
  - isOAObject
```
public boolean isOAObject()
```
    Returns true if this Hub's objects are a subclass of OAObject
  - getObjectClass
```
public Class<TYPE> getObjectClass()
```
    Returns the Class of the objects that are being stored in this Hub.
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Finalize method.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - isMoreData
```
public boolean isMoreData()
```
    Returns:
    
    true if more data is to be loaded from OASelect.
  - loadAllData
```
public void loadAllData()
```
  - getCurrentSize
```
public int getCurrentSize()
```
    Number of Objects currently loaded in the collection.
    Note: this is used to get the number of objects that are currently in the Hub. If a select needs to be executed for this hub, it will not be done when calling this method.
  - getSize
```
public int getSize()
```
    Number of objects currently in collection. If a select needs to be executed, it will be done and the total number from the select will be returned.
    Note: for database objects where all of the records have not been loaded, OASelect.count() will be returned. Otherwise, the returned number will be the number of objects currently in hub.
    
    See Also:
    
    for the amount that is physcially loaded
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<TYPE>
    
    Specified by:
    
    size in interface List<TYPE>
  - getLoadedSize
```
public int getLoadedSize()
```
    Waits until all data is loaded before returning the size.
  - saveAll
```
public void saveAll()
```
    Save all objects in this hub. If objects are OAObjects, then each object save is called.
    Note: this will abort if any of the objects throws an exception
    
    See Also:
    
    OAObject.save()
  - saveAll
```
public void saveAll(int iCascadeRule)
```
  - deleteAll
```
public void deleteAll()
```
    Delete all objects in this hub. If objects are OAObjects, then each object delete method is called. Another option is to remove or removeAll/clear the Hub and then have the objects deleted when it master/owner object is saved.
    Note: this does not abort if any of the objects cant be deleted.
    
    See Also:
    
    OAObject.delete(), which will delete the objects during a save of parent object (based on cascade rules), which will delete the objects during a save of parent object (based on cascade rules)
  - isDeletingAll
```
public boolean isDeletingAll()
```
    Used to know if all of the objects in this Hub being deleted.
    
    Returns:
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Creates a new Hub with the same objects that are in this Hub.
    Note: dataunique (listeners, etc.) and dataactive (active object) are not cloned. Objects are not cloned.
    
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - getObject
```
public TYPE getObject(Object key)
```
    Used to mimic Hashtable.get(key). Find object with a matching key.
    
    Parameters:
    
    key - hashkey of object to find. OAObject "hashCode()" and "equals" is used to find match
    
    key - object to compare to, object or objects[] to compare this object's objectId(s) with or OAObjectKey to compare with this object's objectId
    
    Returns:
    
    Object or null if not found. Note: you need to cast this value
    
    See Also:
    
    OAObjectKey.OAObjectKey(java.lang.String)
  - getObjectAt
```
public TYPE getObjectAt(int pos)
```
    Get an object at a particular position, relative to 0
    
    Parameters:
    
    pos - position of object to retreive, relative to 0
    
    Returns:
    
    null if pos > size()
    
    See Also:
    
    elementAt(int)
  - getAt
```
public TYPE getAt(int pos)
```
  - getLast
```
public TYPE getLast()
```
  - contains
```
public boolean contains(Object obj)
```
    Returns true if object exists in Hub.
    
    Specified by:
    
    contains in interface Collection<TYPE>
    
    Specified by:
    
    contains in interface List<TYPE>
  - indexOf
```
public int indexOf(Object obj)
```
    Finds the position of an object in this hub.
    
    Specified by:
    
    indexOf in interface List<TYPE>
    
    See Also:
    
    which will adjust linkage hubs if necessary to find the object
  - elementAt
```
public TYPE elementAt(int pos)
```
    Returns object at a particular position within the Hub. If position does not exist, null is returned.
    
    See Also:
    
    getObject(java.lang.Object)
  - getActiveObject
```
public TYPE getActiveObject()
```
    Navigational method used to retrieve the current active object, or null if not set.
    
    See Also:
    
    setActiveObject(int)
  - getAO
```
public TYPE getAO()
```
  - setActiveObject
```
public TYPE setActiveObject(int pos)
```
    Navigational method that will set the position of the active object. GUI components use this to recongnize which object that they are working with.
    
    Parameters:
    
    pos - position to set. If > size() or < 0 then it will be set to null, and getPos() will return -1
    
    See Also:
    
    getActiveObject()
  - setAO
```
public Object setAO(int pos)
```
  - setActiveObject
```
public void setActiveObject(Object object)
```
    Navigational method to set the active object.
    
    Parameters:
    
    object - Object to make active. If it does not exist in Hub, then active object will be set to null
    
    See Also:
    
    getActiveObject()
  - setAO
```
public void setAO(Object object)
```
    Navigational method that sets the current active object.
    
    Parameters:
    
    object - is object to make the active object.
  - resetAO
```
public void resetAO()
```
    Navigational method that resets the current active object.
  - getRootHub
```
public Hub getRootHub()
```
    If this is a recursive hub with an owner, then the root hub will be returned, else null.
  - setRootHub
```
public void setRootHub()
```
  - setAddHub
```
public void setAddHub(Hub addHub)
```
    Hub used to add active object to whenever this active object is changed in this Hub. This can be used for building a pick list type program, where a user can select objects that are then added to a list.
  - getAddHub
```
public Hub getAddHub()
```
    Returns the Hub that this Hub's active objects are added to.
    
    See Also:
    
    setAddHub(com.viaoa.hub.Hub)
  - getRealHub
```
public Hub getRealHub()
```
    If this is a shared Hub, returns the Hub that this is shared from, else will return this Hub.
  - isOwned
```
public boolean isOwned()
```
    Returns true if this hub of objects is owned by a master object.
  - setUniqueProperty
```
public void setUniqueProperty(String propertyName)
```
    This is a property that is unique within this Hub, not other Objects in this Hub can have the same value.
  - setDefaultPos
```
public void setDefaultPos(int pos)
```
    Navigational method that sets the defalut position of active object when a new list is set. Can be set to 0 so that first object is always made the active object whenever a new list is created. Default is -1 (set to null).
    This can be set for Detail Hubs, so that the first object is active whenever a new list is create - which is when the Master Hub changes its active object.
  - getDefaultPos
```
public int getDefaultPos()
```
    Navigational method used to get the default position to set when a new list is generated.
    
    See Also:
    
    setDefaultPos(int)
  - setPos
```
public TYPE setPos(int pos)
```
    Navigational method used to set the active object to the object at specific position. If position is < 0 or there is not an object at position, then the active object will be set to null.
    
    See Also:
    
    setActiveObject(int)
  - getPos
```
public int getPos()
```
    Navigational method used to set the active object to the object at specific position. If the active object is null, then -1 will be returned.
    
    See Also:
    
    setActiveObject(int)
  - getPos
```
public int getPos(Object object)
```
    Returns the position of an object within the Hub.
    
    Parameters:
    
    object - Object to located. This can also be the value of the objectId for the object to find. If the object is not found and there is a masterObject, then the active object in the master Hub could be changed so that the object can then be found in this Hub.
    
    Returns:
    
    position of object in the Hub, else -1.
  - getPos
```
public int getPos(Object object,
                  boolean bAdjustMaster)
```
  - add
```
public boolean add(TYPE obj)
```
    Add an Object to end of collection. All listeners will be notified of add event.
    If Hub is sorted, then object will be inserted at correct/sorted position.
    
    Specified by:
    
    add in interface Collection<TYPE>
    
    Specified by:
    
    add in interface List<TYPE>
    
    Parameters:
    
    obj - Object to add, must be from the same class that was used when creating the Hub return true if object was added else false (Hub.canAdd(obj) returned false
  - add
```
public void add(List<TYPE> list)
```
  - add
```
public void add(Hub<TYPE> hub)
```
  - getEnabled
```
public boolean getEnabled()
```
    Flag to know if add/remove are enabled
  - setEnabled
```
public void setEnabled(boolean b)
```
  - addElement
```
public void addElement(TYPE obj)
```
    Helper method that mimics Vector.addElement(), it calls Hub.add(obj, false)
    
    See Also:
    
    add(Object)
  - swap
```
public void swap(int pos1,
                 int pos2)
```
    Swap the positon of two different objects within the hub. This will call the move method.
    
    Parameters:
    
    pos1 - position of object to move from, if there is not an object at this position, then no move is performed.
    
    pos2 - position of object to move to, if there is not an object at this position, then no move is performed.
    
    See Also:
    
    move(int, int)
  - move
```
public void move(int posFrom,
                 int posTo)
```
    Swap the position of two different objects within the hub. This will call the move method. Sends a hubMove event to all HubListeners.
    
    Parameters:
    
    posFrom - position of object to move, if there is not an object at this position, then no move is performed.
    
    posTo - the new ending position for object to be in, after the object is removed from posFrom
  - insert
```
public boolean insert(TYPE obj,
                      int pos)
```
    Insert an Object at a position. Hub Listeners will be notified with an insert event.
    If Hub is sorted, then object will be inserted at correct/sorted position.
    
    Parameters:
    
    obj - Object to insert, must be from the same class that was used when creating the Hub
    
    pos - position to insert the object into the Hub. If greater then size of Hub, then it will be added to the end.
    
    Returns:
    
    true if object was added else false (event hubBeforeAdd() threw an exception)
    
    See Also:
    
    getObjectClass(), add(TYPE), sort(java.util.Comparator)
  - remove
```
public boolean remove(Object obj)
```
    This will remove an object from this collection and send a remove event to all HubListeners.
    
    Specified by:
    
    remove in interface Collection<TYPE>
    
    Specified by:
    
    remove in interface List<TYPE>
  - remove
```
public TYPE remove(int pos)
```
    This will remove the object at a position from this collection and send a remove event to all HubListeners.
    
    Specified by:
    
    remove in interface List<TYPE>
    
    Parameters:
    
    pos - position of object to remove. If an object does not exist at this position, then no action is taken.
  - removeAt
```
public TYPE removeAt(int pos)
```
  - replace
```
public void replace(int pos,
                    TYPE obj)
```
  - setNullOnRemove
```
public void setNullOnRemove(boolean b)
```
    Flag used to have the active object set to null when active object is removed from Hub (default=false).
    
    Parameters:
    
    b - if true, then active object will be set to null. If false, then the active object will be set to next object. If next object does not exist, then previous object is set.
  - getNullOnRemove
```
public boolean getNullOnRemove()
```
    Flag used to have the active object set to null when active object is removed from Hub.
    
    See Also:
    
    setNullOnRemove(boolean)
  - clear
```
public void clear()
```
    Removes all objects from this Hub. Sends a hubRemoveAll event before clearing. Calls remove() for each object, but does not send a hubRemove HubEvent. Sends a hubNewList event when finished. Same as removeAll, removeAllElements
    
    Specified by:
    
    clear in interface Collection<TYPE>
    
    Specified by:
    
    clear in interface List<TYPE>
    
    See Also:
    
    remove(java.lang.Object)
  - removeAll
```
public void removeAll()
```
    Removes all objects from this Hub. Sends a hubRemoveAll event before clearing. Calls remove() for each object, but does not send a hubRemove HubEvent. Sends a hubNewList event when finished. Same as removeAll, removeAllElements
    
    See Also:
    
    remove(java.lang.Object)
  - createSharedHub
```
public Hub<TYPE> createSharedHub()
```
    Navigational method used to create a shared version of another Hub, so that this Hub will use the same objects as the shared hub. All events that affect the data will be sent to all shared Hubs.
    
    See Also:
    
    SharedHub
  - createSharedHub
```
public Hub<TYPE> createSharedHub(boolean bShareAO)
```
    Create a shared version of another Hub, so that this Hub will use the same objects as the shared hub. All events that affect the data will be sent to all shared Hubs.
    
    Parameters:
    
    bShareAO - (default=false) if true, then use same activeObject as shared hub, false:use seperate activeObject
    
    See Also:
    
    SharedHub
  - setSharedHub
```
public void setSharedHub(Hub<TYPE> masterHub,
                         boolean bShareAO)
```
    Create a shared version of another Hub, so that this Hub will use the same objects as the shared hub. All events that affect the data will be sent to all shared Hubs.
    
    Parameters:
    
    masterHub - is the source Hub that this Hub will share data from.
    
    bShareAO - true=use same activeObject as shared hub, false:use seperate activeObject
  - setSharedHub
```
public void setSharedHub(Hub<TYPE> masterHub)
```
    Create a shared version of another Hub, so that this Hub will use the same objects as the shared hub. All events that affect the data will be sent to all shared Hubs.
    
    Parameters:
    
    masterHub - is the source Hub that this Hub will share data from.
  - getSharedHub
```
public Hub<TYPE> getSharedHub()
```
    Returns the Hub that this Hub is sharing objects with. Same as getShared.
  - getDetailHub
```
public Hub getDetailHub(String path,
                        boolean bShareActive,
                        String selectOrder)
```
    Used to create Master/Detail relationships.
    Full Description
    This will create and return a Hub that will automatically be populated with the objects from a reference property from this Hubs active object. Whenever this Hub's active object is changed, then the Detail Hub will have its list changed to match the objects in the reference property.
    Example:
    A Department Class that has a method name getEmployees() that will return a Hub of all Employees that belong to the Department.
```
 Hub hubDept = new Hub(Department.class); // create new Hub for Department objects
 hubDept.select(); // select all departments from datasource
 Hub hubEmp = hubDept.getDetail(Employee.class); // this will find the method in
 // Department Class that returns
 // Employee Class objects
 // Or
 Hub hubEmp = hubDept.getDetail("Employees"); // this will use the getEmployees()
 // method in Department.
 // Or
 Hub hubEmp = hubDept.getDetail("Employees", "lastName, firstName"); // sets sort order

 // Or any other of the getDetail() methods

 
```
    This getDetail() example creates a Hub that will be populated with the Employee objects from the current active object in the hubDept Hub. When the active object is changed in hubDept, the hubEmp Hub will be automatically updated by calling the new active object Department object to get the Employee objects. A new list event will be sent to listeners for the hubEmp whenever this happens.
    Note: If the property being used for the Detail Hub is also a Hub, then the Detail Hub will call setSharedHub() to use the same objects.
    same as getDetailHub()
    Note: see DetailHub Class DetailHub
    Parameters:
    
    path - is the property path to follow to get to the object property needed for the detail Hub.
    
    bShareActive - is used to determine if the active object for hub that is being used (shared) is going to be the same for new Detail Hub. (default=false). In the example above, each Department object has a Hub of Employee Objects. If bShareActive=true, then the Detail Hub will use the same active object as the one in the Hub that it is sharing.
    
    selectOrder - is the sort order to select objects in.
    
    See Also:
    
    setSharedHub(com.viaoa.hub.Hub<TYPE>, boolean), DetailHub
  - getDetailHub
```
public Hub getDetailHub(String path,
                        boolean bShareActive)
```
    Used to create Master/Detail relationships.
  - getDetailHub
```
public Hub getDetailHub(String path,
                        String selectOrder)
```
    Used to create Master/Detail relationships.
  - getDetailHub
```
public Hub getDetailHub(String path)
```
    Used to create Master/Detail relationships.
  - getDetailHub
```
public Hub getDetailHub(String path,
                        Class objectClass,
                        boolean bShareActive)
```
    Used to create Master/Detail relationships.
  - getDetailHub
```
public Hub getDetailHub(String path,
                        Class objectClass)
```
    Used to create Master/Detail relationships.
  - getDetailHub
```
public Hub getDetailHub(Class clazz,
                        boolean bShareActive,
                        String selectOrder)
```
    Used to create Master/Detail relationships.
  - getDetailHub
```
public Hub getDetailHub(Class clazz,
                        boolean bShareActive)
```
    Used to create Master/Detail relationships.
  - getDetailHub
```
public Hub getDetailHub(Class clazz,
                        String selectOrder)
```
    Used to create Master/Detail relationships.
  - getDetailHub
```
public Hub getDetailHub(Class clazz)
```
    Used to create Master/Detail relationships.
  - getDetailHub
```
public Hub getDetailHub(Class[] classes)
```
    Used to create Master/Detail relationships.
  - setMasterHub
```
public void setMasterHub(Hub masterHub)
```
    Used to create Master/Detail relationships. Set the controlling/master hub for this hub
  - setMasterHub
```
public void setMasterHub(Hub masterHub,
                         boolean bShared)
```
    Used to create Master/Detail relationships. Set the controlling/master hub for this hub
  - setMasterHub
```
public void setMasterHub(Hub masterHub,
                         String path)
```
    Used to create Master/Detail relationships. Set the controlling/master hub for this hub
    
    Parameters:
    
    path - is the property path from masterHub to get to this hub
  - setMasterHub
```
public void setMasterHub(Hub masterHub,
                         String path,
                         boolean bShared)
```
    Used to create Master/Detail relationships. Set the controlling/master hub for this hub
    
    Parameters:
    
    path - is the property path from masterHub to get to this hub
  - setMasterHub
```
public void setMasterHub(Hub masterHub,
                         Class clazz,
                         String path,
                         boolean bShared,
                         String selectOrder)
```
    Used to create Master/Detail relationships. Set the controlling/master hub for this hub
  - getMasterHub
```
public Hub getMasterHub()
```
    Used to create Master/Detail relationships. Set the controlling/master hub for this hub
  - getMasterObject
```
public OAObject getMasterObject()
```
  - getMasterClass
```
public Class getMasterClass()
```
  - hasDetailHubs
```
public boolean hasDetailHubs()
```
    Returns true if this Hub has any detail hubs created.
  - removeDetailHub
```
public boolean removeDetailHub(Hub hub)
```
    Used to remove Master/Detail relationships.
  - addHubListener
```
public void addHubListener(HubListener<TYPE> hl,
                           String property)
```
    Add a Listener to this hub specifying a specific property name. If property is a calcualated property, then the Hub will automatically set up internal listeners to know when the calculated property changes.
    
    Parameters:
    
    property - name to listen for
  - addHubListener
```
public void addHubListener(HubListener<TYPE> hl,
                           String property,
                           boolean bActiveObjectOnly)
```
  - addHubListener
```
public void addHubListener(HubListener<TYPE> hl,
                           boolean bActiveObjectOnly)
```
  - addHubListener
```
public void addHubListener(HubListener<TYPE> hl,
                           String property,
                           String[] dependentPropertyPaths)
```
  - addHubListener
```
public void addHubListener(HubListener<TYPE> hl,
                           String property,
                           String dependentPropertyPath)
```
  - addHubListener
```
public void addHubListener(HubListener<TYPE> hl,
                           String property,
                           String dependentPropertyPath,
                           boolean bActiveObjectOnly)
```
  - addHubListener
```
public void addHubListener(HubListener<TYPE> hl,
                           String property,
                           String[] dependentPropertyPaths,
                           boolean bActiveObjectOnly)
```
  - addHubListener
```
public void addHubListener(HubListener<TYPE> hl,
                           String property,
                           String[] dependentPropertyPaths,
                           boolean bActiveObjectOnly,
                           boolean bUseBackgroundThread)
```
  - addTriggerListener
```
public void addTriggerListener(HubListener<TYPE> hl,
                               String property,
                               String propertyPath)
```
    add a trigger to this hub that will send a property change event.
    
    Parameters:
    
    hl - listener
    
    property - name of property for afterPropertyChange event
    
    propertyPath - to listen to
  - addTriggerListener
```
public void addTriggerListener(HubListener<TYPE> hl,
                               String property,
                               String propertyPath,
                               boolean useBackgroundThread)
```
  - addHubListener
```
public void addHubListener(HubListener<TYPE> hl)
```
    Add a Listener to this Hub.
  - addListener
```
public void addListener(HubListener<TYPE> hl)
```
  - removeHubListener
```
public void removeHubListener(HubListener<TYPE> hl)
```
    Remove a Listener to this Hub.
  - removeListener
```
public void removeListener(HubListener<TYPE> hl)
```
  - setAutoSequence
```
public void setAutoSequence(String property)
```
    Used to update a property in each object to equal/store the position within this Hub.
    
    Parameters:
    
    property - is neme of property to update.
  - setAutoSequence
```
public void setAutoSequence(String property,
                            int startNumber)
```
    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.
  - resequence
```
public void resequence()
```
  - setAutoSequence
```
public void setAutoSequence(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 name 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
  - setAutoMatch
```
public void setAutoMatch(String property,
                         Hub hubMaster)
```
    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 void setAutoMatch(String property,
                         Hub hubMaster,
                         boolean bServerSideOnly)
```
  - setAutoMatch
```
public void setAutoMatch(String property,
                         Hub hubMaster,
                         boolean bServerSideOnly,
                         OAObject objStop,
                         String stopProperty)
```
  - setAutoMatch
```
public void setAutoMatch(Hub hubMaster)
```
    Makes sure that for each object in a hubMaster, there exists an object in this hub.
    
    Parameters:
    
    hubMaster - hub with list of object
  - setAutoMatch
```
public void setAutoMatch(Hub hubMaster,
                         boolean bServerSideonly)
```
  - sort
```
public void sort(Comparator comp)
```
    Reorder objects in Hub using a custom Comparator.
    
    Specified by:
    
    sort in interface List<TYPE>
    
    Parameters:
    
    comp - is comparator that has callback method used to sort objects in this Hub.
  - sort
```
public void sort(String... propertyPaths)
```
    Reorder objects in this Hub, sorted by the value(s) from propertyPath(s).
  - sort
```
public void sort(String propertyPaths,
                 boolean bAscending)
```
    Sorts objects by propertyPath and calls hubAfterSort() method from listeners. All objects that are added or inserted will automatically be placed in sort order.
    Note: a HubSorter is used to continually keep the objects sorted. To remove HubSorter, call cancelSort example: hubEmp.sort("lastName, firstName") hubEmp.sort("lastName, age desc, weight desc")
    
    Parameters:
    
    propertyPaths, - list of propertypaths, separated by comma, can also include " asc" or " desc" to override sort ordering.
    
    bAscending - true=sort ascending, false=descending
  - sort
```
public void sort(String propertyPaths,
                 boolean bAscending,
                 Comparator comp)
```
    Reorder objects in this Hub, sorted by the value(s) from propertyPath(s).
    
    See Also:
    
    see HubSorter see #cancelSort
  - isSorted
```
public boolean isSorted()
```
    Returns true if this Hub has a sorter that is keeping it sorted.
  - cancelSort
```
public void cancelSort()
```
    Removes/disconnects HubSorter (if any) that is keeping objects in a sorted order.
    
    See Also:
    
    sort(String,boolean)
  - sort
```
public void sort()
```
    Re-sort using parameters from last sort or select.
  - resort
```
public void resort()
```
    Re-sort using last parameters from last sort or select.
  - find
```
public TYPE find(String propertyPath,
                 Object findValue)
```
    Finds first object that has a property that matches a value. The comparison is done using OACompare.like(..)
    
    Parameters:
    
    propertyPath - property to use to find value
    
    findValue - value to find (using Like)
  - find
```
public TYPE find(String propertyPath,
                 Object findValue,
                 boolean bSetAO)
```
  - find
```
public TYPE find(TYPE fromObject,
                 String propertyPath,
                 Object findValue)
```
  - find
```
public TYPE find(TYPE fromObject,
                 String propertyPath,
                 Object findValue,
                 boolean bSetAO)
```
  - findNext
```
public TYPE findNext(TYPE fromObject,
                     String propertyPath,
                     Object findValue)
```
  - findNext
```
public TYPE findNext(TYPE fromObject,
                     String propertyPath,
                     Object findValue,
                     boolean bSetAO)
```
  - setSelectWhere
```
public void setSelectWhere(String s)
```
    WHERE clause to use for select.
    
    See Also:
    
    setSelectOrder(java.lang.String), OASelect
  - getSelectWhere
```
public String getSelectWhere()
```
  - setSelectOrder
```
public void setSelectOrder(String s)
```
    Sort Order clause to use for select.
    
    See Also:
    
    getSelectOrder(com.viaoa.hub.Hub), OASelect
  - setSelectWhereHub
```
public void setSelectWhereHub(Hub fromHub,
                              String ppFromHub)
```
  - getSelectOrder
```
public String getSelectOrder(Hub thisHub)
```
    Sort Order clause to use for select.
    
    See Also:
    
    setSelectOrder(java.lang.String), OASelect
  - select
```
public void select(OAObject whereObject,
                   String orderByClause)
```
    Select all objects from OADataSource that have a reference to parameter "object".
    example: emp.select(dept); select all employees in Department "dept"
    
    See Also:
    
    OASelect
  - select
```
public void select()
```
    Used for retrieving all objects from OADataSource. If this hub has a masterObject, then this will call select(getMasterObject()).
    Note: orderBy clause is blank, there will not be a sort order.
    
    See Also:
    
    OASelect
  - select
```
public void select(String whereClause)
```
    Used for generating query to retrieve objects from OADataSource. If this hub has a masterObject, then this will call select(getMasterObject(), clause) where clause is the orderBy.
    If this hub does not have a masterObject, then it will select all objects and the supplied clause will be used for the where clause.
  - select
```
public void select(String whereClause,
                   Object[] params)
```
  - select
```
public void select(String whereClause,
                   String orderBy)
```
    Used for generating query to retrieve objects from OADataSource. Example:
    empHub.select("dept.manager.name LIKE 'V%' AND order.items.product.vendor = 123")
    
    Parameters:
    
    whereClause - string used for generating SQL WHERE
    
    orderBy - string used for generating SQL ORDER BY
    
    See Also:
    
    OASelect
  - select
```
public void select(String whereClause,
                   String orderBy,
                   OAFilter filter)
```
  - select
```
public void select(String whereClause,
                   Object[] whereParams,
                   String orderBy,
                   OAFilter filter)
```
    Used for generating query to retrieve objects from OADataSource. Example:
    empHub.select("dept.manager.name LIKE 'V%' AND order.items.product.vendor = 123")
    
    Parameters:
    
    whereClause - string used for generating SQL WHERE
    
    orderBy - string used for generating SQL ORDER BY
    
    See Also:
    
    OASelect
  - select
```
public void select(String whereClause,
                   Object[] whereParams,
                   String orderBy)
```
  - select
```
public void select(String whereClause,
                   Object whereParam,
                   String orderBy)
```
  - select
```
public void select(String whereClause,
                   Object whereParam,
                   String orderBy,
                   OAFilter filter)
```
  - select
```
public void select(OASelect select)
```
    Used to populate Hub with objects returned from a OADataSource select. By defalut, all objects will first be removed from the Hub, OASelect.select() will be called, and the first 45 objects will be added to Hub and active object will be set to null. As the Hub is accessed for more objects, more will be returned until the query is exhausted of objects.
    
    See Also:
    
    OASelect, loadAllData(), isMoreData()
  - selectPassthru
```
public void selectPassthru(String whereClause,
                           String orderClause)
```
    Send the query to OADataSource.selectPassthru.
    
    Parameters:
    
    whereClause - is where clause in native query language used by datasource, must start with "FROM tableName".
    
    orderClause - is sort order in native query language used by datasource.
    
    See Also:
    
    OASelect
  - getSelect
```
public OASelect getSelect()
```
    Returns the OASelect object currently used by select().
  - getSelect
```
public OASelect getSelect(boolean bCreateIfNull)
```
  - cancelSelect
```
public void cancelSelect()
```
    Cancel the reading of anymore records from OADataSource.
  - getLinkHub
```
public Hub getLinkHub(boolean bSearchOtherHubs)
```
    Find the linkHub for this hub or any of this hub's shared hubs that have a linkHub.
    
    Parameters:
    
    bSearchOtherHubs - also check any shared or copied/filtered hubs that use the same AO
    
    See Also:
    
    for other options
  - setLinkHubOnPos
```
public void setLinkHubOnPos(Hub linkHub,
                            String property)
```
    Set the property in a Hub to the position of the active object in this Hub.
  - setLinkHub
```
public void setLinkHub(Hub linkHub,
                       String property)
```
    Sets up this Hub so that it will automatically work with a property of the same Class in another (link) Hub. This linking will automatically set the active object in this Hub to the value of the property in the active object in the Hub that is being linked to. Whenever the active object is changed in the link Hub, the active object in this Hub will be changed to the same value as the link property in the link Hub.
    When the active object is changed in this Hub, the property value for the link Hub will be changed to the value of the active object.
    Types of linking:
    1: link the active object in this Hub to a property in another Hub, where the property type is the same Class as the objects in this Hub.
    2: link the position of the active object in this Hub to a property (numeric) in another Hub.
    3: link a property in this Hub to a property in another Hub.
    4: a link that will automatically create a new object in the link Hub and set the link property whenever the active object in this Hub is changed.
    Examples:
```
 // Link department Hub to the department property in a Employee Hub
 Hub hubDept = new Hub(Department.class);   // create new Hub for Department objects
 hubDept.select();      // select all departments from datasource
 Hub hubEmp = new Hub(Employee.class);
 hubEmp.select();   // select all employees from datasource
 hubDept.setLink(hubEmp, "Department");
 -or-
 hubDept.setLink(hubEmp);
 -or-
 hubDept.setLink(hubEmp, Employee.class);

 // Link the position of a value to a property in another Hub
 Hub hub = new Hub(String.class);
 hub.add("Yes");
 hub.add("No");
 hub.add("Maybe");
 hub.setLinkOnPos(hubEmployee, "retiredStatus");  // values will be set to 0,1, or 2

 // Link a the property value of active object to a property in the link Hub
 Hub hub = new Hub(State.class);  // Class that stores information about all 50 states
 hub.select();   // select all from OADataSource
 hub.setLink("stateName", hubEmp, "state");  // set the state property to name of state

 // automatically create an object and set link property when active object is changed
 Hub hubItem = new Hub(Item.class);
 Hub hubOrder = new Hub(Order.class);
 Hub hubOrderItem = hubOrder.getDetail(OrderItem.class);  // create detail Hub for
                                                          // order items
 hubItem.setLink(hubOrderItem, true);  // whenever hubItem's active object is
                                       // changed, a new OrderItem object will
                                       // be created with a reference to the
 // selected Item object.
 
```
    <br> @param linkHub hub that this hub will change @param property name of property in linkHub that will get changed. If this is not supplied,then it will be found using OAObjectInfo, OALinkInfo or Reflection
    See Also:
    
    HubLink
  - setLinkHub
```
public void setLinkHub(Hub linkHub)
```
    Have this Hub linked to another Hub. If property is not known, then OAObjectInfo, OALinkInfo will be used to find the correct property to link to.
  - setLinkHub
```
public void setLinkHub(String fromProperty,
                       Hub linkHub,
                       String toProperty)
```
    Link/Connect a property in this hub to a property in another hub.
    
    Parameters:
    
    fromProperty - is property active object of this Hub
    
    toProperty - is property in link Hub to set.
    
    See Also:
    
    Full Description of Linking Hubs, HubLink
  - removeLinkHub
```
public void removeLinkHub()
```
    Remove the link that this Hub has with another Hub.
  - setLinkHub
```
public void setLinkHub(Hub linkHub,
                       boolean bAutoCreate,
                       boolean bAutoCreateAllowDups)
```
    Used to automatically create a new Object in link Hub whenever the active object in this Hub is changed.
    
    Parameters:
    
    bAutoCreate - if true then a new object will be created and added to linkHub.
  - setLinkHub
```
public void setLinkHub(Hub linkHub,
                       boolean bAutoCreate)
```
  - setLinkHub
```
public void setLinkHub(Hub linkHub,
                       String property,
                       boolean bAutoCreate,
                       boolean bAutoCreateAllowDups)
```
    Used to automatically create a new Object in link Hub whenever the active object in this Hub is changed.
    
    Parameters:
    
    bAutoCreate - if true then a new object will be created and added to linkHub.
    
    property - is name of property in link Hub that will be set.
  - setLinkHub
```
public void setLinkHub(Hub linkHub,
                       String property,
                       boolean bAutoCreate)
```
  - setLinkHub
```
protected void setLinkHub(String propertyFrom,
                          Hub linkHub,
                          String propertyTo,
                          boolean linkPosFlag)
```
  - isValid
```
public boolean isValid()
```
  - getLinkPath
```
public String getLinkPath(boolean bSearchOtherHubs)
```
    Returns:
    
    path that this hub is linked to.
  - getOAObjectInfo
```
public static OAObjectInfo getOAObjectInfo(Class c)
```
  - getOAObjectInfo
```
public OAObjectInfo getOAObjectInfo()
```
  - setLink
```
public void setLink(Hub hub)
```
  - createShared
```
public Hub<TYPE> createShared()
```
  - updateLinkProperty
```
public void updateLinkProperty(Object obj,
                               Object value)
```
  - compareTo
```
public int compareTo(Object obj)
```
    Specified by:
    
    compareTo in interface Comparable<TYPE>
  - isServer
```
public boolean isServer()
```
  - canAdd
```
public boolean canAdd()
```
  - canAdd
```
public boolean canAdd(Object obj)
```
  - getCanAddMessage
```
public String getCanAddMessage(OAObject obj)
```
  - getAllowAdd
```
public boolean getAllowAdd()
```
  - getAllowAdd
```
public boolean getAllowAdd(Object obj)
```
  - getAllowAdd
```
public boolean getAllowAdd(int checkType,
                           TYPE obj)
```
    Uses OAObjectCallbackDelegate
    
    Parameters:
    
    checkType - from OAObjectCallback
  - getAllowRemove
```
public boolean getAllowRemove(int checkType,
                              TYPE obj)
```
  - getVerifyRemove
```
public boolean getVerifyRemove(int checkType,
                               TYPE obj)
```
  - getAllowRemoveAll
```
public boolean getAllowRemoveAll(boolean bCheckObjectCallback,
                                 int checkType)
```
  - setLoading
```
public void setLoading(boolean b)
```
  - isLoading
```
public boolean isLoading()
```
  - sendRefresh
```
public void sendRefresh()
```
    notifies clients that hub has changed, and should be retrieved from server.
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<TYPE>
    
    Specified by:
    
    isEmpty in interface List<TYPE>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<TYPE>
    
    Specified by:
    
    containsAll in interface List<TYPE>
  - addAll
```
public boolean addAll(Collection<? extends TYPE> c)
```
    Specified by:
    
    addAll in interface Collection<TYPE>
    
    Specified by:
    
    addAll in interface List<TYPE>
  - addAll
```
public boolean addAll(int index,
                      Collection<? extends TYPE> c)
```
    Specified by:
    
    addAll in interface List<TYPE>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<TYPE>
    
    Specified by:
    
    removeAll in interface List<TYPE>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<TYPE>
    
    Specified by:
    
    retainAll in interface List<TYPE>
  - get
```
public TYPE get(int index)
```
    Specified by:
    
    get in interface List<TYPE>
  - set
```
public TYPE set(int index,
                TYPE element)
```
    Specified by:
    
    set in interface List<TYPE>
  - add
```
public void add(int index,
                TYPE element)
```
    Specified by:
    
    add in interface List<TYPE>
  - lastIndexOf
```
public int lastIndexOf(Object o)
```
    Specified by:
    
    lastIndexOf in interface List<TYPE>
  - iterator
```
public Iterator<TYPE> iterator()
```
    Specified by:
    
    iterator in interface Iterable<TYPE>
    
    Specified by:
    
    iterator in interface Collection<TYPE>
    
    Specified by:
    
    iterator in interface List<TYPE>
  - listIterator
```
public ListIterator<TYPE> listIterator()
```
    Specified by:
    
    listIterator in interface List<TYPE>
  - listIterator
```
public ListIterator<TYPE> listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<TYPE>
  - subList
```
public List<TYPE> subList(int fromIndex,
                          int toIndex)
```
    Specified by:
    
    subList in interface List<TYPE>
  - stream
```
public Stream<TYPE> stream()
```
    Specified by:
    
    stream in interface Collection<TYPE>
  - onChangeAO
```
public void onChangeAO(HubOnEventInterface onEvent)
```
  - onPropertyChange
```
public void onPropertyChange(HubOnEventInterface onEvent)
```
  - onPropertyChange
```
public void onPropertyChange(HubOnEventInterface onEvent,
                             String propName)
```
  - onAdd
```
public void onAdd(HubOnEventInterface onEvent)
```
  - onBeforeRefresh
```
public void onBeforeRefresh(HubOnEventInterface onEvent)
```
  - onNewList
```
public void onNewList(HubOnEventInterface onEvent)
```
  - onRemove
```
public void onRemove(HubOnEventInterface onEvent)
```
  - createFilteredHub
```
public Hub<TYPE> createFilteredHub(OAFilter filter,
                                   String... dependentPropertyPaths)
```
  - refresh
```
public void refresh()
```
    Refresh this hub by reselecting from DataSource.

Class Hub<TYPE>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

data

datau

dataa

datam

DEBUG

Constructor Detail

Hub

Hub

Hub

Hub

Hub

Hub

Hub

Hub

Method Detail

ensureCapacity

resizeToFit

readResolve

setProperty

getProperty

removeProperty

toString

setRefresh

getRefresh

getChanged

setChanged

copyInto

toArray

toArray

toList

copyInto

isOAObject

getObjectClass

finalize

isMoreData

loadAllData

getCurrentSize

getSize

size

getLoadedSize

saveAll

saveAll

deleteAll

isDeletingAll

clone

getObject

getObjectAt

getAt

getLast

contains

indexOf

elementAt

getActiveObject

getAO

setActiveObject

setAO

setActiveObject

setAO

resetAO

getRootHub

setRootHub

setAddHub

getAddHub

getRealHub

isOwned

setUniqueProperty

setDefaultPos

getDefaultPos

setPos

getPos

getPos