org.basex.util.list

Class TwoWayTokenMap

java.lang.Object

org.basex.util.list.ElementList

org.basex.util.list.TokenList

org.basex.util.list.TwoWayTokenMap

All Implemented Interfaces:

java.lang.Iterable<byte[]>

public class TwoWayTokenMap
extends TokenList

Two-way Token Map allows efficient key->value and value->key lookups. Also speeds up "contains"-operation.

• Value->key is done using TokenList which is an ArrayList.
• Key->value is done using TokenIntMap which is an HashMap.

Elements may not be inserted twice (bijection).

Author:

BaseX Team 2005-12, BSD License, Jens Erat

Field Summary

Fields inherited from class org.basex.util.list.ElementList

CAP, size

Constructor Summary

Constructors

Constructor and Description
TwoWayTokenMap()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(byte[] e) Adds an element.
void	add(long e) Adds an element.
void	add(java.lang.String e) Adds an element.
boolean	contains(byte[] e) Checks if the specified element is found in the list.
boolean	contains(java.lang.String e) Checks if the specified element is found in the list.
int	delete(byte[] val) Deletes a value.
int	delete(java.lang.String val) Deletes a value.
int	getKey(byte[] val) Gets key by value.
int	getKey(java.lang.String val) Gets key by value.
byte[]	pop() Pops the uppermost element from the stack.
void	push(byte[] val) Pushes an element onto the stack.
void	set(int i, byte[] e) Sets an element at the specified index.
void	set(int i, java.lang.String e) Sets an element at the specified index.
TokenList	sort(boolean cs) Sorting a TwoWayTokenMap is not implemented.

Methods inherited from class org.basex.util.list.TokenList

delete, get, insert, iterator, peek, toArray, toString, toStringArray

Methods inherited from class org.basex.util.list.ElementList

isEmpty, newSize, newSize, reset, size

Methods inherited from class java.lang.Object

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

Constructor Detail

TwoWayTokenMap

public TwoWayTokenMap()

Method Detail

add

public void add(byte[] e)

Adds an element.

Overrides:

add in class TokenList

Parameters:

e - element to be added

Throws:

java.lang.IllegalArgumentException - when element already exists

add

public void add(long e)

Adds an element.

Overrides:

add in class TokenList

Parameters:

e - element to be added

Throws:

java.lang.IllegalArgumentException - when element already exists

add

public void add(java.lang.String e)

Adds an element.

Overrides:

add in class TokenList

Parameters:

e - element to be added

Throws:

java.lang.IllegalArgumentException - when element already exists

set

public void set(int i,
       byte[] e)

Sets an element at the specified index.

Overrides:

set in class TokenList

Parameters:

i - index

e - element to be set

Throws:

java.lang.IllegalArgumentException - when element already exists

set

public void set(int i,
       java.lang.String e)

Sets an element at the specified index.

Parameters:

i - index

e - element to be set

Throws:

java.lang.IllegalArgumentException - when element already exists

pop

public byte[] pop()

Description copied from class: TokenList

Pops the uppermost element from the stack.

Overrides:

pop in class TokenList

Returns:

the popped element

push

public void push(byte[] val)

Pushes an element onto the stack.

Overrides:

push in class TokenList

Parameters:

val - element

Throws:

java.lang.IllegalArgumentException - when element already exists

contains

public boolean contains(byte[] e)

Description copied from class: TokenList

Checks if the specified element is found in the list.

Overrides:

contains in class TokenList

Parameters:

e - element to be found

Returns:

result of check

contains

public boolean contains(java.lang.String e)

Checks if the specified element is found in the list. Convenience method for casting Strings.

Parameters:

e - element to be checked

Returns:

result of check

See Also:

contains(byte[])

sort

public TokenList sort(boolean cs)

Sorting a TwoWayTokenMap is not implemented.

Overrides:

sort in class TokenList

Parameters:

cs - sort order: not used

Returns:

(will not return)

Throws:

java.lang.UnsupportedOperationException - when executed

getKey

public int getKey(byte[] val)

Gets key by value.

Parameters:

val - Value to search for

Returns:

key or -1 if not found

getKey

public int getKey(java.lang.String val)

Gets key by value.

Parameters:

val - Value to search for

Returns:

key or -1 if not found

delete

public int delete(byte[] val)

Deletes a value. ElementList.size() will not represent actual size any more and TokenList.get(int) will return null values for this key afterwards!

Parameters:

val - Value to delete

Returns:

key or -1 if not found

delete

public final int delete(java.lang.String val)

Deletes a value. ElementList.size() will not represent actual size any more and TokenList.get(int) will return null values for this key afterwards!

Parameters:

val - Value to delete

Returns:

key or -1 if not found