com.portal.pcm

Class SparseArray

java.lang.Object

com.portal.pcm.AssocArray

com.portal.pcm.SparseArray

All Implemented Interfaces:

Externalizable, Serializable

public class SparseArray
extends AssocArray
implements Externalizable

The SparseArray class is used to simulate the Portal `Array' in an FList. It is an array that doesn't require all elements to be filled.

Version:

1.0

Author:

Larry Lynch-Freshner

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SparseArray.SAPairEnumeration

Nested classes/interfaces inherited from class com.portal.pcm.AssocArray

AssocArray.Pair, AssocArray.PairEnumeration

Field Summary

Fields inherited from class com.portal.pcm.AssocArray

keys, values

Constructor Summary

Constructors

Constructor and Description
SparseArray() Constructs an instance of SparseArray.

Method Summary

Modifier and Type	Method and Description
void	add(FList newElement) Adds a new element to the end of array.
void	add(int index, FList newElement) Adds a new element to the array.
void	dump() Dumps the SparseArray.
FList	elementAt(int index) Returns the element, if any, associated with an index.
FList	elementAt(Integer index) Returns the element, if any, associated with an index.
FList	getAnyElement() Returns an element (usually called when it is known that there is only one).
Enumeration<Integer>	getKeyEnumerator() Returns an enumeration of the index values in the array.
List<Integer>	getKeys() Returns a read-only list of the index values in the sparsearray
AssocArray.PairEnumeration	getPairs()
int	getSize() Returns the number of element pairs in the array.
Enumeration<FList>	getValueEnumerator() Returns an enumeration of the values in the array.
List<FList>	getValues() Returns a read-only list of the values in the sparsearray
void	readExternal(ObjectInput in)
void	remove(int index) Remove an element from the array.
void	writeExternal(ObjectOutput out)

Methods inherited from class com.portal.pcm.AssocArray

clear, containsKey, elements, get, isEmpty, keys, put, remove, size

Methods inherited from class java.lang.Object

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

Constructor Detail

SparseArray

public SparseArray()

Constructs an instance of SparseArray. The array is initially empty.

Method Detail

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

getSize

public int getSize()

Returns the number of element pairs in the array.

Returns:

The number of elements in the array.

elementAt

public FList elementAt(int index)

Returns the element, if any, associated with an index.

Parameters:

index - Where to find the element.

Returns:

An FList instance, if present, NULL if not.

See Also:

Element.ELEMID_ANY, Element.ELEMID_ASSIGN, Element.ELEMID_MAX

elementAt

public FList elementAt(Integer index)

Returns the element, if any, associated with an index.

Parameters:

index - Where to find the element.

Returns:

An FList instance, if present, NULL if not.

See Also:

Element.ELEMID_ANY, Element.ELEMID_ASSIGN, Element.ELEMID_MAX

getAnyElement

public FList getAnyElement()

Returns an element (usually called when it is known that there is only one).

Returns:

An FList instance, if present, NULL if not.

add

public void add(int index,
                FList newElement)

Adds a new element to the array.

Parameters:

index - Where to add the new element.

newElement - The new element to add.

See Also:

Element.ELEMID_ANY, Element.ELEMID_ASSIGN, Element.ELEMID_MAX

add

public void add(FList newElement)

Adds a new element to the end of array.

Parameters:

newElement - The new element to add.

See Also:

Element.ELEMID_ANY, Element.ELEMID_ASSIGN, Element.ELEMID_MAX

remove

public void remove(int index)

Remove an element from the array.

Parameters:

index - Where to remove the element.

getValueEnumerator

public Enumeration<FList> getValueEnumerator()

Returns an enumeration of the values in the array.

Returns:

An enumeration of the values in the array.

getKeyEnumerator

public Enumeration<Integer> getKeyEnumerator()

Returns an enumeration of the index values in the array.

Returns:

An enumeration of the index values in the array.

getValues

public List<FList> getValues()

Returns a read-only list of the values in the sparsearray

Returns:

a read-only list of the values in the sparsearray

getKeys

public List<Integer> getKeys()

Returns a read-only list of the index values in the sparsearray

Returns:

a read-only list of the index values in the sparsearray

getPairs

public AssocArray.PairEnumeration getPairs()

Overrides:

getPairs in class AssocArray

dump

public void dump()

Dumps the SparseArray.