org.agilewiki.jid.collection.vlenc.map

Class MapJid<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.CollectionJid<ENTRY_TYPE>

org.agilewiki.jid.collection.vlenc.ListJid<MapEntry<KEY_TYPE,VALUE_TYPE>>

org.agilewiki.jid.collection.vlenc.map.MapJid<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:

IntegerMapJid, LongMapJid, StringMapJid

public abstract class MapJid<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>
extends ListJid<MapEntry<KEY_TYPE,VALUE_TYPE>>
implements JAMap<KEY_TYPE,VALUE_TYPE>, Collection<MapEntry<KEY_TYPE,VALUE_TYPE>>

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
org.agilewiki.jactor.factory.ActorFactory	valueFactory

Fields inherited from class org.agilewiki.jid.collection.vlenc.ListJid

entryFactory, initialCapacity, list

Fields inherited from class org.agilewiki.jid.collection.CollectionJid

len

Fields inherited from class org.agilewiki.jid.Jid

serializedBytes, serializedOffset

Constructor Summary

Constructors

Constructor and Description
MapJid()

Method Summary

Methods

Modifier and Type	Method and Description
int	ceiling(KEY_TYPE key) Locate the entry with the first element >= a key.
MapEntry<KEY_TYPE,VALUE_TYPE>	getCeiling(KEY_TYPE key) Returns the JID value with the smallest key >= the given key.
protected org.agilewiki.jactor.factory.ActorFactory	getEntryFactory() Returns the actor type of all the elements in the list.
MapEntry<KEY_TYPE,VALUE_TYPE>	getFirst()
MapEntry<KEY_TYPE,VALUE_TYPE>	getHigher(KEY_TYPE key) Returns the JID value with a greater key.
protected abstract org.agilewiki.jactor.factory.ActorFactory	getKeyFactory() Returns the JidFactory for the key.
MapEntry<KEY_TYPE,VALUE_TYPE>	getLast()
KEY_TYPE	getLastKey()
protected org.agilewiki.jactor.factory.ActorFactory	getValueFactory() Returns the JidFactory for the values in the map.
int	higher(KEY_TYPE key) Locate the entry with a higher key.
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	match(KEY_TYPE key) Locate the entry with the first element >= a key, or the last entry.
_Jid	resolvePathname(String pathname) Resolves a JID pathname, returning a JID actor or null.
int	search(KEY_TYPE key) Locate the entry with a matching first element.
protected abstract KEY_TYPE	stringToKey(String skey) Converts a string to a key.

Methods inherited from class org.agilewiki.jid.collection.vlenc.ListJid

empty, getSerializedLength, iAdd, iAddBytes, iGet, initializeList, iRemove, iSetBytes, load, serialize, size

Methods inherited from class org.agilewiki.jid.collection.CollectionJid

change, loadLen, saveLen, skipLen

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.collection.vlenc.map.JAMap

size

Methods inherited from interface org.agilewiki.jid.collection.Collection

iGet, iSetBytes, size

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

valueFactory

public org.agilewiki.jactor.factory.ActorFactory valueFactory

Constructor Detail

MapJid

public MapJid()

Method Detail

getKeyFactory

protected abstract org.agilewiki.jactor.factory.ActorFactory getKeyFactory()

Returns the JidFactory for the key.

Returns:

The JidFactory for the key.

stringToKey

protected abstract KEY_TYPE stringToKey(String skey)

Converts a string to a key.

Parameters:

skey - The string to be converted.

Returns:

The key.

getEntryFactory

protected final org.agilewiki.jactor.factory.ActorFactory getEntryFactory()
                                                                   throws Exception

Returns the actor type of all the elements in the list.

Overrides:

getEntryFactory in class ListJid<MapEntry<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>>

Returns:

The actor type of all the elements in the list.

Throws:

Exception

getValueFactory

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

Returns the JidFactory for the values in the map.

Returns:

The actor type of the values in the list.

Throws:

Exception

search

public final int search(KEY_TYPE key)
                 throws Exception

Locate the entry with a matching first element.

Parameters:

key - The key which matches to the entry's first element.

Returns:

The index or - (insertion point + 1).

Throws:

Exception

higher

public final int higher(KEY_TYPE key)
                 throws Exception

Locate the entry with a higher key.

Parameters:

key - The key which matches to the entry's first element.

Returns:

The index or -1.

Throws:

Exception

match

public final int match(KEY_TYPE key)
                throws Exception

Locate the entry with the first element >= a key, or the last entry.

Parameters:

key - The key which matches to the entry's first element, or size.

Returns:

The index, or size.

Throws:

Exception

ceiling

public final int ceiling(KEY_TYPE key)
                  throws Exception

Locate the entry with the first element >= a key.

Parameters:

key - The key which matches to the entry's first element.

Returns:

The index or -1.

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

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

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

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

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

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

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 ListJid<MapEntry<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends 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