com.neurosys.domain

Interface OrderableByRef<R>

Type Parameters:

R - as Reference type. Typically Number type.

public interface OrderableByRef<R>

An object that can be ordered by its getCurrentRef(), getNextRef() or getPreviousRef().

For example if Id is Long type; then getNextRef() can refer to the Id that will follow this, similarly getPreviousRef() will refer to the Id that is before/previous to this.

There are following types of nodes determine sequencing:

• Nodes that are un-linked. getPreviousRef() and getNextRef() are null. Neutral precedence, in order in which it exists.
• Nodes getPreviousRef() not null - The previous node has greater precedence
• Nodes getNextRef() not null - The next node has lower precedence

If both next and previous are defined then hat depends on the sort and conflict resolution to determine order.

Author:

Arjun Dhar

See Also:

OrderByRefList

Method Summary

Modifier and Type	Method and Description
R	getCurrentRef() Get the reference of the current node
R	getNextRef() The Reference to the Node After this one. To add more meaning by convention typically Next or After means, the next will be pushed to the right.
R	getPreviousRef() The Reference to the Node Previous this one. To add more meaning by convention typically Before or Previous means, this node will be pushed to the right.
void	setNextRef(R ref) The Reference to the Node After this one. To add more meaning by convention typically Next or After means, the next will be pushed to the right.
void	setPreviousRef(R ref) The Reference to the Node Previous this one. To add more meaning by convention typically Before or Previous means, this node will be pushed to the right.

Method Detail

getNextRef

R getNextRef()

The Reference to the Node After this one.
To add more meaning by convention typically Next or After means, the next will be pushed to the right. This node will not move.

setNextRef

void setNextRef(R ref)

The Reference to the Node After this one.
To add more meaning by convention typically Next or After means, the next will be pushed to the right. This node will not move.

getPreviousRef

R getPreviousRef()

The Reference to the Node Previous this one.
To add more meaning by convention typically Before or Previous means, this node will be pushed to the right. The previous node will not move.

setPreviousRef

void setPreviousRef(R ref)

The Reference to the Node Previous this one.
To add more meaning by convention typically Before or Previous means, this node will be pushed to the right. The previous node will not move.

getCurrentRef

R getCurrentRef()

Get the reference of the current node