org.primordion.xholon.base

Class QueueSynchronized

java.lang.Object

org.primordion.xholon.base.Xholon

org.primordion.xholon.base.QueueSynchronized

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, IQueue, IXholon, XholonMarker

public class QueueSynchronized
extends Xholon
implements IQueue

This is the synchronized version of a generic Queue data structure that can be used to store references to any type of data. Items are added at one end of the Queue and taken off at the other end, which is why a Queue is called a First In First Out (FIFO) structure. WARNING: A Queue can fill up to maximum capacity, or it may become empty. Check the return value when calling the enqueue and dequeue functions to see if it is Q_FULL or null.

Since:

0.7.1 (Created on November 7, 2007)

See Also:

Xholon Project website, Serialized Form

Field Summary

Fields inherited from interface org.primordion.xholon.base.IQueue

Q_FULL, Q_OK

Fields inherited from interface org.primordion.xholon.base.IXholon

DEFAULT_SIZE_MSG_Q, DEFAULT_SIZE_SYSTEM_MSG_Q, GETNAME_DEFAULT, GETNAME_LOCALPART_ID, GETNAME_NOROLENAME, GETNAME_ROLENAME_OR_CLASSNAME, GETNAME_ROLENAMESEP_, GETNAME_SIZE_TEMPLATE, NINCLUDE_PSC, NINCLUDE_PSx, NINCLUDE_PxC, NINCLUDE_Pxx, NINCLUDE_xSC, NINCLUDE_xSx, NINCLUDE_xxC, NINCLUDE_xxx, XHOLON_ID_DEFAULT, XHOLON_ID_NULL

Constructor Summary

Constructors

Constructor and Description
QueueSynchronized(int numItems) Use this constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	dequeue() Take an object off the queue.
void	doAction(java.lang.String action) Do a specific action that this xholon knows how to do.
void	empty() Empty the Queue, and discard its contents.
int	enqueue(java.lang.Object p_item) Add an object to the queue.
java.lang.String[]	getActionList() Get a list of actions that this xholon can do.
java.util.Vector	getItems() Get the internal item array.
int	getMaxSize() Get maximum number of items that can be in the queue.
int	getSize() Get number of items currently in the queue.
java.lang.Object	getVal_Object() Get the value of a "Object" maintained by this xholon instance.
void	sendMessage(int signal, java.lang.Object data, IXholon sender) Send a message to a receiving Xholon instance.
void	setMaxSize(int maxSize) Set the maximum number of items that can be in the queue, and allocate space for that many items.
void	setVal_Object(java.lang.Object obj) Set the value of a "Object" maintained by this xholon instance.
void	shuffle() Randomize the order of the items in the queue.
void	sort() Sort the items in the queue.

Methods inherited from class org.primordion.xholon.base.Xholon

act, actNr, appendChild, appendChild, appendChild, appendsOwnChildren, bindPorts, cleanup, compareTo, configure, configure, consoleLog, decVal, decVal, depth, equals, findFirstChildWithXhClass, findFirstChildWithXhClass, forwardMessage, forwardSyncMessage, getAllPorts, getAnnotation, getApp, getAttributeNodeXh, getAttributeXh, getChildNodes, getClassNode, getClassNode, getFactory, getFirstChild, getFirstSibling, getId, getInteraction, getInteractionsEnabled, getIQueueImplName, getLastChild, getLastSibling, getLogger, getMsgQ, getName, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumLevels, getNumSiblings, getParentNode, getPort, getPort, getPreviousSibling, getRoleName, getRootNode, getSelfAndSiblings, getSelfAndSiblingsIndex, getService, getSiblings, getSystemMsgQ, getUid, getUri, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_short, getVal_String, getVal, getXhc, getXhcId, getXhcName, getXholon2Xml, getXhType, getXml2Xholon, getXPath, handleNodeSelection, handleNodeSelection, hasAncestor, hasAnnotation, hasAttributeXh, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, hasSiblingNodes, height, incVal, incVal, initialize, initStatics, inOrderPrint, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertFirstChild, isActiveObject, isAttributeHandler, isBound, isContainer, isExternal, isInternal, isLeaf, isPassiveObject, isRootNode, isUniqueSibling, isUniqueSiblingRoleName, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedMessage, processReceivedSyncMessage, processSystemMessageQ, reconfigure, registerMessageForwardee, remove, removeAttributeNodeXh, removeAttributeXh, removeChild, replaceNode, searchForReferencingNodes, searchForReferencingNodesRecurse, sendMessage, sendMessage, sendSyncMessage, sendSyncMessage, sendSyncMessage, sendSystemMessage, sendSystemMessage, setActionList, setAnnotation, setApp, setAttributeNodeXh, setAttributeVal, setAttributeXh, setFirstChild, setId, setName, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setPort, setPort, setPorts, setRoleName, setUid, setUri, setVal_boolean, setVal_byte, setVal_char, setVal_double, setVal_float, setVal_int, setVal_long, setVal_short, setVal_String, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setXhc, showAnnotation, swapNode, terminate, toString, toXml, toXmlAttribute, toXmlAttributes, toXmlText, treeSize, visit

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.primordion.xholon.base.IXholon

act, actNr, appendChild, appendChild, appendChild, appendsOwnChildren, bindPorts, cleanup, configure, configure, consoleLog, decVal, decVal, depth, findFirstChildWithXhClass, findFirstChildWithXhClass, forwardMessage, forwardSyncMessage, getAllPorts, getAnnotation, getApp, getAttributeNodeXh, getAttributeXh, getChildNodes, getClassNode, getClassNode, getFirstChild, getFirstSibling, getId, getLastChild, getLastSibling, getName, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumLevels, getNumSiblings, getParentNode, getPort, getPort, getPreviousSibling, getRoleName, getRootNode, getSelfAndSiblings, getSelfAndSiblingsIndex, getService, getSiblings, getUid, getUri, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_short, getVal_String, getVal, getXhc, getXhcId, getXhcName, getXholon2Xml, getXhType, getXml2Xholon, handleNodeSelection, handleNodeSelection, hasAncestor, hasAnnotation, hasAttributeXh, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, hasSiblingNodes, height, incVal, incVal, initialize, initStatics, inOrderPrint, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertFirstChild, isActiveObject, isAttributeHandler, isBound, isContainer, isExternal, isInternal, isLeaf, isPassiveObject, isRootNode, isUniqueSibling, isUniqueSiblingRoleName, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedMessage, processReceivedSyncMessage, processSystemMessageQ, reconfigure, registerMessageForwardee, remove, removeAttributeNodeXh, removeAttributeXh, removeChild, replaceNode, searchForReferencingNodes, sendMessage, sendMessage, sendSyncMessage, sendSyncMessage, sendSyncMessage, sendSystemMessage, sendSystemMessage, setActionList, setAnnotation, setApp, setAttributeNodeXh, setAttributeVal, setAttributeXh, setFirstChild, setId, setName, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setPort, setPort, setPorts, setRoleName, setUid, setUri, setVal_boolean, setVal_byte, setVal_char, setVal_double, setVal_float, setVal_int, setVal_long, setVal_short, setVal_String, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setXhc, showAnnotation, swapNode, terminate, toXml, toXmlAttribute, toXmlAttributes, toXmlText, treeSize, visit

Constructor Detail

QueueSynchronized

public QueueSynchronized(int numItems)

Use this constructor.

Parameters:

numItems - Maximum number of items that can be in the queue.

Method Detail

enqueue

public int enqueue(java.lang.Object p_item)

Description copied from interface: IQueue

Add an object to the queue.

Specified by:

enqueue in interface IQueue

Parameters:

p_item - The object.

Returns:

Q_OK or Q_FULL

dequeue

public java.lang.Object dequeue()

Description copied from interface: IQueue

Take an object off the queue.

Specified by:

dequeue in interface IQueue

Returns:

An instance of Object, or null.

getSize

public int getSize()

Description copied from interface: IQueue

Get number of items currently in the queue.

Specified by:

getSize in interface IQueue

Returns:

Current queue size.

getMaxSize

public int getMaxSize()

Description copied from interface: IQueue

Get maximum number of items that can be in the queue.

Specified by:

getMaxSize in interface IQueue

Returns:

Maximum queue size.

setMaxSize

public void setMaxSize(int maxSize)

Description copied from interface: IQueue

Set the maximum number of items that can be in the queue, and allocate space for that many items. If there are already some items in the queue, then the method will atttempt to move all of them into the new internal data structure. If the new maxSize is less than the old maxSize, then some of the existing items may be lost.

Specified by:

setMaxSize in interface IQueue

Parameters:

maxSize - Maximum queue size.

shuffle

public void shuffle()

Description copied from interface: IQueue

Randomize the order of the items in the queue.

Specified by:

shuffle in interface IQueue

sort

public void sort()

Description copied from interface: IQueue

Sort the items in the queue. To use this capability, the Java class of the items in the queue must implement Comparable, with its "public int compareTo(Object o)" method.

Specified by:

sort in interface IQueue

empty

public void empty()

Description copied from interface: IQueue

Empty the Queue, and discard its contents.

Specified by:

empty in interface IQueue

getActionList

public java.lang.String[] getActionList()

Description copied from interface: IXholon

Get a list of actions that this xholon can do. These actions can be presented to users in a GUI, or used for other purposes.

Specified by:

getActionList in interface IXholon

Overrides:

getActionList in class Xholon

Returns:

A list of actions, or null.

doAction

public void doAction(java.lang.String action)

Description copied from interface: IXholon

Do a specific action that this xholon knows how to do.

Specified by:

doAction in interface IXholon

Overrides:

doAction in class Xholon

Parameters:

action - The name of a specific action.

sendMessage

public void sendMessage(int signal,
               java.lang.Object data,
               IXholon sender)

Description copied from interface: IXholon

Send a message to a receiving Xholon instance.

Specified by:

sendMessage in interface IXholon

Overrides:

sendMessage in class Xholon

Parameters:

signal - A distinguishing identifier for this message.

data - Any data that needs to be sent (optional).

sender - The sender of the message.

getItems

public java.util.Vector getItems()

Description copied from interface: IQueue

Get the internal item array. This should be used for debugging purposes only.

Specified by:

getItems in interface IQueue

Returns:

An array of Object items.

getVal_Object

public java.lang.Object getVal_Object()

Description copied from interface: IXholon

Get the value of a "Object" maintained by this xholon instance.

Specified by:

getVal_Object in interface IXholon

Overrides:

getVal_Object in class Xholon

setVal_Object

public void setVal_Object(java.lang.Object obj)

Description copied from interface: IXholon

Set the value of a "Object" maintained by this xholon instance.

Specified by:

setVal_Object in interface IXholon

Overrides:

setVal_Object in class Xholon