com.viaoa.hub

Class HubAutoSequence

java.lang.Object

com.viaoa.hub.HubListenerAdapter

com.viaoa.hub.HubAutoSequence

All Implemented Interfaces:

HubListener, Serializable, EventListener

public class HubAutoSequence
extends HubListenerAdapter
implements Serializable

Used to store the position of an object within a hub in property within the object. This can then be used when retrieving the objects from a datasource.

See Also:

Hub.setAutoSequence(java.lang.String), Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.viaoa.hub.HubListener

HubListener.InsertLocation

Field Summary

Fields

Modifier and Type	Field and Description
static int	AutoSequenceHubListenerCount
protected boolean	bKeepSeq
protected boolean	bServerSideOnly
protected Hub	hub
protected String	propertyName
protected Method	propertySetMethod
protected int	startNumber

Constructor Summary

Constructors

Constructor and Description
HubAutoSequence()
HubAutoSequence(Hub hub, String propertyName) Create a new HubAutoSequence.
HubAutoSequence(Hub hub, String propertyName, int startNumber) Create a new HubAutoSequence.
HubAutoSequence(Hub hub, String propertyName, int startNumber, boolean bKeepSeq) Create a new HubAutoSequence.
HubAutoSequence(Hub hub, String propertyName, int startNumber, boolean bKeepSeq, boolean bServerSideOnly)

Method Summary

Modifier and Type	Method and Description
void	afterAdd(HubEvent e) HubListener interface method, used to listen to changes to Hub and update sequence numbers.
void	afterInsert(HubEvent e) HubListener interface method, used to listen to changes to Hub and update sequence numbers.
void	afterMove(HubEvent e) HubListener interface method, used to listen to changes to Hub and update sequence numbers.
void	afterRemove(HubEvent e) HubListener interface method, used to listen to changes to Hub and update sequence numbers.
void	afterSort(HubEvent e) HubListener interface method, used to listen to changes to Hub and update sequence numbers.
void	close()
protected void	finalize()
Hub	getHub()
String	getPropertyName() Number property in object that is used to keep track of the order of the object within the hub.
int	getStartNumber() Set the starting number to be used for first object.
void	onNewList(HubEvent e) HubListener interface method, used to listen to changes to Hub and update sequence numbers.
void	resequence()
protected void	resequence(int startPos)
void	setHub(Hub hub)
void	setPropertyName(String propertyName)
void	setStartNumber(int i) Set the starting number to be used for first object.
protected void	setup()

Methods inherited from class com.viaoa.hub.HubListenerAdapter

afterChangeActiveObject, afterDelete, afterLoad, afterNewList, afterPropertyChange, afterRemoveAll, afterSave, beforeAdd, beforeDelete, beforeInsert, beforeMove, beforePropertyChange, beforeRefresh, beforeRemove, beforeRemoveAll, beforeSave, beforeSelect, getDescription, getListener, getLocation, getName, setLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.viaoa.hub.HubListener

getAllowAdd, getAllowDelete, getAllowEnabled, getAllowRemove, getAllowRemoveAll, getAllowVisible, isValidAdd, isValidDelete, isValidPropertyChange, isValidRemove, isValidRemoveAll

Field Detail

AutoSequenceHubListenerCount

public static int AutoSequenceHubListenerCount

hub

protected Hub hub

propertyName

protected String propertyName

propertySetMethod

protected transient Method propertySetMethod

startNumber

protected int startNumber

bKeepSeq

protected boolean bKeepSeq

bServerSideOnly

protected boolean bServerSideOnly

Constructor Detail

HubAutoSequence

public HubAutoSequence()

HubAutoSequence

public HubAutoSequence(Hub hub,
                       String propertyName,
                       int startNumber)

Create a new HubAutoSequence.

Parameters:

propertyName - is int property for storing number.

HubAutoSequence

public HubAutoSequence(Hub hub,
                       String propertyName,
                       int startNumber,
                       boolean bKeepSeq)

Create a new HubAutoSequence.

Parameters:

propertyName - is int property for storing number.

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

HubAutoSequence

public HubAutoSequence(Hub hub,
                       String propertyName,
                       int startNumber,
                       boolean bKeepSeq,
                       boolean bServerSideOnly)

Parameters:

hub -

propertyName -

startNumber -

bKeepSeq -

bServerSideOnly - this is used by Hub.setAutoSequence(...) so that the server will control the seq property and send CS messages to clients. If true, then the property changes (for seq prop) will need to be sent to clients.

HubAutoSequence

public HubAutoSequence(Hub hub,
                       String propertyName)

Create a new HubAutoSequence.

Parameters:

propertyName - is int property for storing number.

Method Detail

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

close

public void close()

getStartNumber

public int getStartNumber()

Set the starting number to be used for first object. default is "0".

setStartNumber

public void setStartNumber(int i)

Set the starting number to be used for first object. default is "0".

getHub

public Hub getHub()

setHub

public void setHub(Hub hub)

getPropertyName

public String getPropertyName()

Number property in object that is used to keep track of the order of the object within the hub. The hub will set the value based on the objects position within the Hub.

Note: the object is not automatically saved.

setPropertyName

public void setPropertyName(String propertyName)

See Also:

getPropertyName

setup

protected void setup()

resequence

public void resequence()

resequence

protected void resequence(int startPos)

afterInsert

public void afterInsert(HubEvent e)

HubListener interface method, used to listen to changes to Hub and update sequence numbers.

Specified by:

afterInsert in interface HubListener

Overrides:

afterInsert in class HubListenerAdapter

afterAdd

public void afterAdd(HubEvent e)

HubListener interface method, used to listen to changes to Hub and update sequence numbers.

Specified by:

afterAdd in interface HubListener

Overrides:

afterAdd in class HubListenerAdapter

See Also:

Hub.add

afterRemove

public void afterRemove(HubEvent e)

HubListener interface method, used to listen to changes to Hub and update sequence numbers.

Specified by:

afterRemove in interface HubListener

Overrides:

afterRemove in class HubListenerAdapter

afterMove

public void afterMove(HubEvent e)

HubListener interface method, used to listen to changes to Hub and update sequence numbers.

Specified by:

afterMove in interface HubListener

Overrides:

afterMove in class HubListenerAdapter

onNewList

public void onNewList(HubEvent e)

HubListener interface method, used to listen to changes to Hub and update sequence numbers.

Specified by:

onNewList in interface HubListener

Overrides:

onNewList in class HubListenerAdapter

afterSort

public void afterSort(HubEvent e)

HubListener interface method, used to listen to changes to Hub and update sequence numbers.

Specified by:

afterSort in interface HubListener

Overrides:

afterSort in class HubListenerAdapter

See Also:

Hub.sort