org.agilewiki.jid.collection.vlenc.map

Class BMapJid<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>

java.lang.Object

org.agilewiki.jactor.lpc.JLPCActor

org.agilewiki.jid.Jid

org.agilewiki.jid.collection.flenc.AppJid

org.agilewiki.jid.collection.vlenc.map.BMapJid<KEY_TYPE,VALUE_TYPE>

All Implemented Interfaces:

org.agilewiki.jactor.Actor, org.agilewiki.jactor.apc.APCRequestSource, org.agilewiki.jactor.apc.RequestProcessor, org.agilewiki.jactor.lpc.RequestSource, org.agilewiki.jactor.lpc.TargetActor, _Jid, Collection<MapEntry<KEY_TYPE,VALUE_TYPE>>, JAList, JAMap<KEY_TYPE,VALUE_TYPE>

Direct Known Subclasses:

IntegerBMapJid, LongBMapJid, StringBMapJid

public abstract class BMapJid<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>
extends AppJid
implements Collection<MapEntry<KEY_TYPE,VALUE_TYPE>>, JAList, JAMap<KEY_TYPE,VALUE_TYPE>

A balanced tree that holds a map.

Nested Class Summary

Nested classes/interfaces inherited from class org.agilewiki.jactor.lpc.JLPCActor

org.agilewiki.jactor.lpc.JLPCActor.SMBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isRoot
protected int	nodeCapacity
protected int	TUPLE_SIZE
protected int	TUPLE_UNION
org.agilewiki.jactor.factory.ActorFactory	valueFactory

Fields inherited from class org.agilewiki.jid.collection.flenc.AppJid

tuple, tupleFactories

Fields inherited from class org.agilewiki.jid.Jid

serializedBytes, serializedOffset

Constructor Summary

Constructors

Constructor and Description
BMapJid()

Method Summary

Methods

Modifier and Type	Method and Description
void	empty()
MapEntry<KEY_TYPE,VALUE_TYPE>	getCeiling(KEY_TYPE key) Returns the JID value with the smallest key >= the given key.
MapEntry<KEY_TYPE,VALUE_TYPE>	getFirst()
MapEntry<KEY_TYPE,VALUE_TYPE>	getHigher(KEY_TYPE key) Returns the JID value with a greater key.
MapEntry<KEY_TYPE,VALUE_TYPE>	getLast()
KEY_TYPE	getLastKey()
protected MapJid<KEY_TYPE,Jid>	getNode()
String	getNodeType()
protected IntegerJid	getSizeJid()
protected UnionJid	getUnionJid()
protected abstract org.agilewiki.jactor.factory.ActorFactory	getUnionJidFactory()
protected org.agilewiki.jactor.factory.ActorFactory	getValueFactory()
void	iAdd(int i)
void	iAddBytes(int ndx, byte[] bytes)
MapEntry<KEY_TYPE,VALUE_TYPE>	iGet(int ndx) Returns the selected element.
protected void	incSize(int inc)
protected void	init()
protected void	inodeSplit(MapEntry<KEY_TYPE,BMapJid<KEY_TYPE,Jid>> leftEntry)
void	iRemove(int ndx)
void	iSetBytes(int ndx, byte[] bytes) Creates a JID actor and loads its serialized data.
boolean	isFat()
boolean	isLeaf()
VALUE_TYPE	kGet(KEY_TYPE key) Returns the JID value associated with the key.
MapEntry<KEY_TYPE,VALUE_TYPE>	kGetEntry(KEY_TYPE key)
Boolean	kMake(KEY_TYPE key) Add an entry to the map unless there is an entry with a matching first element.
Boolean	kMakeBytes(KEY_TYPE key, byte[] bytes) Add a tuple to the map unless there is a tuple with a matching first element.
boolean	kRemove(KEY_TYPE key) Removes the item identified by the key.
void	kSetBytes(KEY_TYPE key, byte[] bytes)
int	nodeSize()
_Jid	resolvePathname(String pathname) Resolves a JID pathname, returning a JID actor or null.
protected void	rootSplit()
protected void	setNodeType(String nodeType)
int	size() Returns the size of the collection.
protected abstract KEY_TYPE	stringToKey(String skey) Converts a string to a key.

Methods inherited from class org.agilewiki.jid.collection.flenc.AppJid

_iGet, _iSetBytes, _resolvePathname, _size, change, getSerializedLength, getTupleFactories, load, serialize

Methods inherited from class org.agilewiki.jid.Jid

changed, copyJID, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, createSubordinate, getSerializedBytes, isJidEqual, isSerialized, readable, save, setContainerJid

Methods inherited from class org.agilewiki.jactor.lpc.JLPCActor

acceptEvent, acceptRequest, getActorType, getAncestor, getExceptionHandler, getFactory, getMailbox, getMailboxFactory, getMatch, getParent, hasDataItem, haveEvents, initialize, initialize, initialize, initialize, initialize, requirements, responseFrom, send, send, sendEvent, setExceptionHandler, setInitialBufferCapacity

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.agilewiki.jid._Jid

change, getSerializedLength, load, save, setContainerJid

Methods inherited from interface org.agilewiki.jactor.lpc.TargetActor

setExceptionHandler

Methods inherited from interface org.agilewiki.jactor.Actor

acceptEvent, acceptRequest, getActorType, getAncestor, getFactory, getMailbox, getMatch, getParent, hasDataItem, setInitialBufferCapacity

Field Detail

TUPLE_SIZE

protected final int TUPLE_SIZE

See Also:

Constant Field Values

TUPLE_UNION

protected final int TUPLE_UNION

See Also:

Constant Field Values

nodeCapacity

protected int nodeCapacity

isRoot

protected boolean isRoot

valueFactory

public org.agilewiki.jactor.factory.ActorFactory valueFactory

Constructor Detail

BMapJid

public BMapJid()

Method Detail

getUnionJidFactory

protected abstract org.agilewiki.jactor.factory.ActorFactory getUnionJidFactory()
                                                                         throws Exception

Throws:

Exception

stringToKey

protected abstract KEY_TYPE stringToKey(String skey)

Converts a string to a key.

Parameters:

skey - The string to be converted.

Returns:

The key.

getValueFactory

protected org.agilewiki.jactor.factory.ActorFactory getValueFactory()
                                                             throws Exception

Throws:

Exception

init

protected void init()
             throws Exception

Throws:

Exception

setNodeType

protected void setNodeType(String nodeType)
                    throws Exception

Throws:

Exception

getSizeJid

protected IntegerJid getSizeJid()
                         throws Exception

Throws:

Exception

size

public int size()
         throws Exception

Returns the size of the collection.

Specified by:

size in interface Collection<MapEntry<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>>

Specified by:

size in interface JAMap<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>

Returns:

The size of the collection.

Throws:

Exception

incSize

protected void incSize(int inc)
                throws Exception

Throws:

Exception

getUnionJid

protected UnionJid getUnionJid()
                        throws Exception

Throws:

Exception

getNode

protected MapJid<KEY_TYPE,Jid> getNode()
                                                             throws Exception

Throws:

Exception

getNodeType

public String getNodeType()
                   throws Exception

Throws:

Exception

isLeaf

public boolean isLeaf()
               throws Exception

Throws:

Exception

nodeSize

public int nodeSize()
             throws Exception

Throws:

Exception

isFat

public boolean isFat()
              throws Exception

Throws:

Exception

iGet

public MapEntry<KEY_TYPE,VALUE_TYPE> iGet(int ndx)
                                                                            throws Exception

Returns the selected element.

Specified by:

iGet in interface Collection<MapEntry<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>>

Parameters:

ndx - Selects the element.

Returns:

The ith JID component, or null if the index is out of range.

Throws:

Exception

iSetBytes

public void iSetBytes(int ndx,
             byte[] bytes)
               throws Exception

Creates a JID actor and loads its serialized data.

Specified by:

iSetBytes in interface Collection<MapEntry<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>>

Parameters:

ndx - The index of the desired element.

bytes - Holds the serialized data.

Throws:

Exception - Any exceptions thrown while processing the request.

iAdd

public void iAdd(int i)
          throws Exception

Specified by:

iAdd in interface JAList

Throws:

Exception

iAddBytes

public void iAddBytes(int ndx,
             byte[] bytes)
               throws Exception

Specified by:

iAddBytes in interface JAList

Throws:

Exception

kMakeBytes

public Boolean kMakeBytes(KEY_TYPE key,
                 byte[] bytes)
                   throws Exception

Add a tuple to the map unless there is a tuple with a matching first element.

Specified by:

kMakeBytes in interface JAMap<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>

Parameters:

key - Used to match the first element of the tuples.

bytes - The serialized form of a JID of the appropriate type.

Returns:

True if a new tuple was created; otherwise the old value is unaltered.

Throws:

Exception

kMake

public final Boolean kMake(KEY_TYPE key)
                    throws Exception

Add an entry to the map unless there is an entry with a matching first element.

Specified by:

kMake in interface JAMap<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>

Parameters:

key - Used to match the first element of the entries.

Returns:

True if a new entry was created.

Throws:

Exception

rootSplit

protected void rootSplit()
                  throws Exception

Throws:

Exception

inodeSplit

protected void inodeSplit(MapEntry<KEY_TYPE,BMapJid<KEY_TYPE,Jid>> leftEntry)
                   throws Exception

Throws:

Exception

empty

public void empty()
           throws Exception

Specified by:

empty in interface JAList

Throws:

Exception

iRemove

public void iRemove(int ndx)
             throws Exception

Specified by:

iRemove in interface JAList

Throws:

Exception

kRemove

public final boolean kRemove(KEY_TYPE key)
                      throws Exception

Removes the item identified by the key.

Specified by:

kRemove in interface JAMap<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>

Parameters:

key - The key.

Returns:

True when the item was present and removed.

Throws:

Exception

kGetEntry

public final MapEntry<KEY_TYPE,VALUE_TYPE> kGetEntry(KEY_TYPE key)
                                                                                       throws Exception

Throws:

Exception

kGet

public final VALUE_TYPE kGet(KEY_TYPE key)
                                  throws Exception

Returns the JID value associated with the key.

Specified by:

kGet in interface JAMap<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>

Parameters:

key - The key.

Returns:

The jid assigned to the key, or null.

Throws:

Exception

getCeiling

public final MapEntry<KEY_TYPE,VALUE_TYPE> getCeiling(KEY_TYPE key)
                                                                                        throws Exception

Returns the JID value with the smallest key >= the given key.

Specified by:

getCeiling in interface JAMap<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>

Parameters:

key - The key.

Returns:

The matching jid, or null.

Throws:

Exception

getHigher

public final MapEntry<KEY_TYPE,VALUE_TYPE> getHigher(KEY_TYPE key)
                                                                                       throws Exception

Returns the JID value with a greater key.

Specified by:

getHigher in interface JAMap<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>

Parameters:

key - The key.

Returns:

The matching jid, or null.

Throws:

Exception

resolvePathname

public final _Jid resolvePathname(String pathname)
                           throws Exception

Resolves a JID pathname, returning a JID actor or null.

Specified by:

resolvePathname in interface _Jid

Overrides:

resolvePathname in class Jid

Parameters:

pathname - A JID pathname.

Returns:

A JID actor or null.

Throws:

Exception - Any uncaught exception which occurred while processing the request.

getFirst

public MapEntry<KEY_TYPE,VALUE_TYPE> getFirst()
                                                                                throws Exception

Specified by:

getFirst in interface JAMap<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>

Throws:

Exception

getLast

public MapEntry<KEY_TYPE,VALUE_TYPE> getLast()
                                                                               throws Exception

Specified by:

getLast in interface JAMap<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>

Throws:

Exception

getLastKey

public KEY_TYPE getLastKey()
                                                 throws Exception

Throws:

Exception

kSetBytes

public void kSetBytes(KEY_TYPE key,
             byte[] bytes)
               throws Exception

Specified by:

kSetBytes in interface JAMap<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>

Throws:

Exception