elge.agent
Class VectorRepresentation

java.lang.Object
  |
  +--java.util.AbstractCollection
        |
        +--java.util.AbstractList
              |
              +--elge.agent.VectorRepresentation

All Implemented Interfaces:

AgentRepresentation, Collection, List, Serializable

Direct Known Subclasses:

MatrixRepresentation

public class VectorRepresentation

extends AbstractList

implements AgentRepresentation

VectorRepresentation is very simple class, that holds the agents like Vector class but it supports proprtyChangeListener and fires a event every time an agent has been added or removed.

Author:

Pavol Žibrita

See Also:

Serialized Form

Field Summary

protected Vector	agents delegate to hold the agents
protected PropertyChangeSupport	propertySupport the propertyChangeSupport for listener

Fields inherited from class java.util.AbstractList

modCount

Fields inherited from interface elge.agent.AgentRepresentation

PROP_DIMENSION

Constructor Summary

VectorRepresentation()
Creates a new instance of VectorRepresentation

Method Summary

void	add(int index, Object element) Inserts the specified element at the specified position in this list (optional operation).
boolean	add(Object o) Ensures that this collection contains the specified element (optional operation).
boolean	addAll(Collection c) Adds all of the elements in the specified collection to this collection (optional operation).
boolean	addAll(int index, Collection c) Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a listener.
void	clear() Removes all of the elements from this collection (optional operation).
boolean	contains(Object o) Returns true if this collection contains the specified element.
boolean	containsAll(Collection c) Returns true if this collection contains all of the elements in the specified collection.
Object	get(int index) Returns the element at the specified position in this list.
Dimension	getDimension() does nothing
Dimension	getDimenstion() does nothing.
int	indexOf(Object o) Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element.
boolean	isEmpty() Returns true if this collection contains no elements.
Iterator	iterator() Returns an iterator over the elements in this collection.
int	lastIndexOf(Object o) Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.
ListIterator	listIterator() Returns a list iterator of the elements in this list (in proper sequence).
ListIterator	listIterator(int index) Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list.
Object	remove(int index) Removes the element at the specified position in this list (optional operation).
boolean	remove(Object o) Removes a single instance of the specified element from this collection, if it is present (optional operation).
boolean	removeAll(Collection c) Removes all this collection's elements that are also contained in the specified collection (optional operation).
void	removePropertyChangeListener(PropertyChangeListener listener) removes property listener
boolean	retainAll(Collection c) Retains only the elements in this collection that are contained in the specified collection (optional operation).
Point	rndPosition() Generates position somewhere within the representation dimension.
Point	rndRelPosition(Point from, double radius) Like rndPosition, but it generates relativee from point from with max distance to point radius.
Object	set(int index, Object element) Replaces the element at the specified position in this list with the specified element (optional operation).
void	setDimension(Dimension d) does nothing
int	size() Returns the number of agents
List	subList(int fromIndex, int toIndex) Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
Object[]	toArray() Returns an array containing all of the elements in this collection.
Object[]	toArray(Object[] a) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.

Methods inherited from class java.util.AbstractList

equals, hashCode, removeRange

Methods inherited from class java.util.AbstractCollection

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

equals, hashCode

Field Detail

agents

protected Vector agents

delegate to hold the agents

propertySupport

protected PropertyChangeSupport propertySupport

the propertyChangeSupport for listener

Constructor Detail

VectorRepresentation

public VectorRepresentation()

Creates a new instance of VectorRepresentation

Method Detail

getDimenstion

public Dimension getDimenstion()

does nothing.

Returns:

returns null

rndPosition

public Point rndPosition()

Generates position somewhere within the representation dimension.

Specified by:

rndPosition in interface AgentRepresentation

Returns:

returns null.

rndRelPosition

public Point rndRelPosition(Point from,
                            double radius)

Like rndPosition, but it generates relativee from point from with max distance to point radius. Welll

Specified by:

rndRelPosition in interface AgentRepresentation

Parameters:

from - relative point

radius - distance

Returns:

returns null

setDimension

public void setDimension(Dimension d)

does nothing

Specified by:

setDimension in interface AgentRepresentation

Parameters:

d - size

size

public int size()

Returns the number of agents

Specified by:

size in interface List

Specified by:

size in class AbstractCollection

Returns:

the number of agents in the representation.

getDimension

public Dimension getDimension()

does nothing

Specified by:

getDimension in interface AgentRepresentation

Returns:

returns null

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a listener.

Specified by:

addPropertyChangeListener in interface AgentRepresentation

Parameters:

listener - a lsitener to this AgentRepresentation

See Also:

PropertyChangeListener

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

removes property listener

Specified by:

removePropertyChangeListener in interface AgentRepresentation

Parameters:

listener - the lsitener

See Also:

PropertyChangeListener

add

public boolean add(Object o)

Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.)

Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Specified by:

add in interface List

Overrides:

add in class AbstractList

Parameters:

o - element whose presence in this collection is to be ensured.

Returns:

true if this collection changed as a result of the call

Throws:

ClassCastException - class of the specified element prevents it from being added to this collection.

add

public void add(int index,
                Object element)

Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Specified by:

add in interface List

Overrides:

add in class AbstractList

Parameters:

index - index at which the specified element is to be inserted.

element - element to be inserted.

Throws:

ClassCastException - if the class of the specified element prevents it from being added to this list.

NullPointerException - if the specified element is null and this list does not support null elements.

IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).

addAll

public boolean addAll(Collection c)

Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)

Specified by:

addAll in interface List

Overrides:

addAll in class AbstractCollection

Parameters:

c - elements to be inserted into this collection.

Returns:

true if this collection changed as a result of the call

Throws:

ClassCastException - if the class of an element of the specified collection prevents it from being added to this collection.

See Also:

add(Object)

addAll

public boolean addAll(int index,
                      Collection c)

Inserts all of the elements in the specified collection into this list at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Specified by:

addAll in interface List

Overrides:

addAll in class AbstractList

Parameters:

index - index at which to insert first element from the specified collection.

c - elements to be inserted into this list.

Returns:

true if this list changed as a result of the call.

Throws:

ClassCastException - if the class of one of elements of the specified collection prevents it from being added to this list.

IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).

clear

public void clear()

Removes all of the elements from this collection (optional operation). This collection will be empty after this method returns unless it throws an exception.

Specified by:

clear in interface List

Overrides:

clear in class AbstractList

contains

public boolean contains(Object o)

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface List

Overrides:

contains in class AbstractCollection

Parameters:

o - element whose presence in this collection is to be tested.

Returns:

true if this collection contains the specified element

Throws:

NullPointerException - if the specified element is null and this collection does not support null elements (optional).

containsAll

public boolean containsAll(Collection c)

Returns true if this collection contains all of the elements in the specified collection.

Specified by:

containsAll in interface List

Overrides:

containsAll in class AbstractCollection

Parameters:

c - collection to be checked for containment in this collection.

Returns:

true if this collection contains all of the elements in the specified collection

Throws:

ClassCastException - if the types of one or more elements in the specified collection are incompatible with this collection (optional).

NullPointerException - if the specified collection is null.

See Also:

contains(Object)

get

public Object get(int index)

Returns the element at the specified position in this list.

Specified by:

get in interface List

Specified by:

get in class AbstractList

Parameters:

index - index of element to return.

Returns:

the element at the specified position in this list.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

indexOf

public int indexOf(Object o)

Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:

indexOf in interface List

Overrides:

indexOf in class AbstractList

Parameters:

o - element to search for.

Returns:

the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element.

Throws:

ClassCastException - if the type of the specified element is incompatible with this list (optional).

isEmpty

public boolean isEmpty()

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface List

Overrides:

isEmpty in class AbstractCollection

Returns:

true if this collection contains no elements

iterator

public Iterator iterator()

Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides a guarantee).

Specified by:

iterator in interface List

Overrides:

iterator in class AbstractList

Returns:

an Iterator over the elements in this collection

lastIndexOf

public int lastIndexOf(Object o)

Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:

lastIndexOf in interface List

Overrides:

lastIndexOf in class AbstractList

Parameters:

o - element to search for.

Returns:

the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.

Throws:

ClassCastException - if the type of the specified element is incompatible with this list (optional).

NullPointerException - if the specified element is null and this list does not support null elements (optional).

listIterator

public ListIterator listIterator()

Returns a list iterator of the elements in this list (in proper sequence).

Specified by:

listIterator in interface List

Overrides:

listIterator in class AbstractList

Returns:

a list iterator of the elements in this list (in proper sequence).

listIterator

public ListIterator listIterator(int index)

Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. The specified index indicates the first element that would be returned by an initial call to the next method. An initial call to the previous method would return the element with the specified index minus one.

Specified by:

listIterator in interface List

Overrides:

listIterator in class AbstractList

Parameters:

index - index of first element to be returned from the list iterator (by a call to the next method).

Returns:

a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).

remove

public boolean remove(Object o)

Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).

Specified by:

remove in interface List

Overrides:

remove in class AbstractCollection

Parameters:

o - element to be removed from this collection, if present.

Returns:

true if this collection changed as a result of the call

Throws:

ClassCastException - if the type of the specified element is incompatible with this collection (optional).

NullPointerException - if the specified element is null and this collection does not support null elements (optional).

remove

public Object remove(int index)

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Specified by:

remove in interface List

Overrides:

remove in class AbstractList

Parameters:

index - the index of the element to removed.

Returns:

the element previously at the specified position.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

removeAll

public boolean removeAll(Collection c)

Removes all this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.

Specified by:

removeAll in interface List

Overrides:

removeAll in class AbstractCollection

Parameters:

c - elements to be removed from this collection.

Returns:

true if this collection changed as a result of the call

Throws:

ClassCastException - if the types of one or more elements in this collection are incompatible with the specified collection (optional).

NullPointerException - if this collection contains one or more null elements and the specified collection does not support null elements (optional).

NullPointerException - if the specified collection is null.

See Also:

remove(Object), contains(Object)

retainAll

public boolean retainAll(Collection c)

Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.

Specified by:

retainAll in interface List

Overrides:

retainAll in class AbstractCollection

Parameters:

c - elements to be retained in this collection.

Returns:

true if this collection changed as a result of the call

Throws:

UnsupportedOperationException - if the retainAll method is not supported by this Collection.

See Also:

remove(Object), contains(Object)

set

public Object set(int index,
                  Object element)

Replaces the element at the specified position in this list with the specified element (optional operation).

Specified by:

set in interface List

Overrides:

set in class AbstractList

Parameters:

index - index of element to replace.

element - element to be stored at the specified position.

Returns:

the element previously at the specified position.

Throws:

ClassCastException - if the class of the specified element prevents it from being added to this list.

NullPointerException - if the specified element is null and this list does not support null elements.

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

subList

public List subList(int fromIndex,
                    int toIndex)

Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list.

This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:

 	    list.subList(from, to).clear();
 

Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList.

The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

Specified by:

subList in interface List

Overrides:

subList in class AbstractList

Parameters:

fromIndex - low endpoint (inclusive) of the subList.

toIndex - high endpoint (exclusive) of the subList.

Returns:

a view of the specified range within this list.

Throws:

IndexOutOfBoundsException - for an illegal endpoint index value (fromIndex < 0 || toIndex > size || fromIndex > toIndex).

toArray

public Object[] toArray()

Returns an array containing all of the elements in this collection. If the collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Specified by:

toArray in interface List

Overrides:

toArray in class AbstractCollection

Returns:

an array containing all of the elements in this collection

toArray

public Object[] toArray(Object[] a)

Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.

If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of this collection only if the caller knows that this collection does not contain any null elements.)

If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs

Suppose l is a List known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:

     String[] x = (String[]) v.toArray(new String[0]);
 

Note that toArray(new Object[0]) is identical in function to toArray().

Specified by:

toArray in interface List

Overrides:

toArray in class AbstractCollection

Parameters:

a - the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing the elements of this collection

Throws:

ArrayStoreException - the runtime type of the specified array is not a supertype of the runtime type of every element in this collection.

NullPointerException - if the specified array is null.