galatea.glider
Class List

java.lang.Object
  galatea.glider.List

Direct Known Subclasses:

LEvents, LFields, LInfluences, ListAg, LMess, LNodes, LOutputs

public class List

extends java.lang.Object

Class List definition.
This is the base class for list in Galatea.
-----
Clase básica para el manejo de listas en Galatea.

Version:

3 10/06/00

Author:

Mayerlin Uzcátegui

Field Summary

Element	head Pointer to head.
java.lang.String	name List's name.
int	num Number of elements on list.

Constructor Summary

List()
Constructor.

List(byte order)
Constructor.

List(java.lang.Object dhead)
Constructor.

List(java.lang.Object dhead, byte order)
Constructor.

List(java.lang.Object dhead, java.lang.String name)
Constructor.

List(java.lang.Object dhead, java.lang.String name, byte order)
Constructor.

List(java.lang.String name)
Constructor.

List(java.lang.String name, byte order)
Constructor.

Method Summary

void	add(List l) Adds a list to list.
void	add(java.lang.Object dat) Adds an element to list.
boolean	empty() Get Method.
boolean	equals(java.lang.Object o) List's names comparation.
java.lang.Object	extract() Removes an element in list.
Element	getAnt(java.lang.Object dat) Get Method.
java.lang.Object	getDat() Get Method.
java.lang.Object	getDat(int pos) Get Method.
boolean	getDat(java.lang.Object dat) Get Method.
java.lang.Object	getHead() Get Method.
java.lang.String	getName() Get Method.
Element	getNext(java.lang.Object dat) Get Method.
byte	getOrder() Get Method.
int	getPos() Get Method.
int	getPos(java.lang.Object dat) Get Method.
void	insert(java.lang.Object dat) Adds an element.
void	insert(java.lang.Object dat, int pos) Adds an element based on position.
int	ll() Get Method.
boolean	next() Step to next position.
java.lang.Object	remove() Removes an element.
boolean	remove(java.lang.Object dat) Remove an element.
void	setDat(java.lang.Object dat, java.lang.Object dnew) Set Method.
void	setPos() Set Method.
boolean	setPos(int pos) Set Method.
boolean	setPos(java.lang.Object dat) Set Method.
java.lang.String	stat() List's statistics.
java.lang.String	toString() Visual Method.
boolean	valPos() Validate current position.
boolean	valPos(int pos) Validate position.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

head

public Element head

Pointer to head.
-----
Apuntador a la cabecera.

name

public java.lang.String name

List's name.
-----
Nombre de la lista.

num

public int num

Number of elements on list.
-----
Número de elementos de la lista.

Constructor Detail

List

public List()

Constructor. It's creates a empty FIFO list.
-----
Constructor. Crea una nueva lista FIFO vacía.

List

public List(byte order)

Constructor. It's creates a empty order list.
-----
Constructor. Crea una nueva lista ordenada vacía.

Parameters:

order - byte. Order.
-----
order - byte. Orden de la lista.

List

public List(java.lang.Object dhead)

Constructor. It's creates a FIFO list.
-----
Constructor. Crea una nueva lista FIFO.

Parameters:

dhead - Object. Head's data.
-----
dhead - Object. Cabecera.

List

public List(java.lang.Object dhead,
            byte order)

Constructor. It's creates an order list.
-----
Constructor. Crea una nueva lista ordenada.

Parameters:

dhead - Object. Head's data.
-----
dhead - Object. Cabecera.

order - byte. Order.
-----
order - byte. Orden de la lista.

List

public List(java.lang.Object dhead,
            java.lang.String name)

Constructor. It's creates a FIFO list.
-----
Constructor. Crea una nueva lista FIFO.

Parameters:

dhead - Object. Head's data.
-----
dhead - Object. Cabecera.

name - String. List's name.
-----
name - String. Nombre de la lista.

List

public List(java.lang.Object dhead,
            java.lang.String name,
            byte order)

Constructor. It's creates a order list.
-----
Constructor. Crea una nueva lista ordenada.

Parameters:

dhead - Object. Head's data.
-----
dhead - Object. Cabecera.

name - String. List's name.
-----
name - String. Nombre de la lista.

order - byte. Order.
-----
order - byte. Orden de la lista.

List

public List(java.lang.String name)

Constructor. It's creates a FIFO list.
-----
Constructor. Crea una nueva lista FIFO.

Parameters:

name - String. List's name.
-----
name - String. Nombre de la lista.

List

public List(java.lang.String name,
            byte order)

Constructor. It's creates a order list.
-----
Constructor. Crea una nueva lista ordenada.

Parameters:

name - String. List's name.
-----
name - String. Nombre de la lista.

order - byte. Order.
-----
order - byte. Orden de la lista.

Method Detail

add

public void add(List l)

Adds a list to list.
-----
Agrega una lista a la lista.

Parameters:

l - List. List.
-----
l - List. lista.

add

public void add(java.lang.Object dat)

Adds an element to list.
-----
Agrega un elemento a la lista.

Parameters:

dat - Object. Data.
-----
dat - Object. Dato.

empty

public boolean empty()

Get Method. Empty list.
-----
Método de Consulta. Indica si la lista esta vacía.

Returns:

boolean. Empty list.
-----
boolean. Indica si la lista esta vacía.

equals

public boolean equals(java.lang.Object o)

List's names comparation.
-----
Compara el nombre de dos listas.

Parameters:

o - Object. Object to compare.
-----
o - Object. Objeto a comparar.

Returns:

boolean. this.name = o.name

extract

public java.lang.Object extract()
                         throws ErrorEmpty

Removes an element in list.
-----
Extrae el elemento actual.

Returns:

Object. Element.
-----
Object. Elemento.

Throws:

ErrorEmpty - Error Message: Empty list.
-----
ErrorEmpty Mensaje de Error: Lista vacía.

getAnt

public Element getAnt(java.lang.Object dat)

Get Method. Previous element.
-----
Método de Consulta. Elemento anterior al dato indicado.

Parameters:

dat - Object. Data.
-----
dat - Object. Dato.

Returns:

Object. Previous element.
-----
Object. Elemento anterior.

getDat

public java.lang.Object getDat()
                        throws ErrorEmpty

Get Method. Current element's data.
-----
Método de Consulta. Dato del elemento actual de la lista.

Returns:

Object. Current element's data.
-----
Object. Dato del elemento actual.

Throws:

ErrorEmpty - Error Message: Empty list.
-----
ErrorEmpty Mensaje de Error: Lista vacía.

getDat

public java.lang.Object getDat(int pos)
                        throws ErrorEmpty

Get Method. Data into position.
-----
Método de Consulta. Dato en una posición de la lista.

Parameters:

pos - int. Position.
-----
pos - int. Posición.

Returns:

Object. Data into position.
-----
Object. Dato en la posición.

Throws:

ErrorEmpty - Error Message: Empty list.
-----
ErrorEmpty Mensaje de Error: Lista vacía.

getDat

public boolean getDat(java.lang.Object dat)

Get Method. Data exists?.
-----
Método de Consulta. Indica si el dato existe.

Parameters:

dat - Object. Data.
-----
dat - Object. Dato.

Returns:

boolean. pos(dat)>0.

getHead

public java.lang.Object getHead()

Get Method. Head's data.
-----
Método de Consulta. Dato cabecera de la lista.

Returns:

Object. Head's data.
-----
Object. Dato cabecera de la lista.

getName

public java.lang.String getName()

Get Method. List's name.
-----
Método de Consulta. Nombre de la lista.

Returns:

String. List's name.
-----
String. Nombre de la lista.

getNext

public Element getNext(java.lang.Object dat)

Get Method. Next element .
-----
Método de Consulta. Elemento siguiente al dato indicado.

Parameters:

dat - Object. Dat.
-----
dat - Object. Dato.

Returns:

Object. Next element .
-----
Object. Elemento siguiente.

getOrder

public byte getOrder()

Get Method. List's order.
-----
Método de Consulta. Orden de la lista.

Returns:

byte. List's order.
-----
byte. Orden de la lista.

getPos

public int getPos()

Get Method. Current position.
-----
Método de Consulta. Posición actual.

Returns:

int. Current position.
-----
int. Posición actual.

getPos

public int getPos(java.lang.Object dat)

Get Method. Data's position.
-----
Método de Consulta. Posición del dato indicado.

Parameters:

dat - Object. Data.
-----
dat - Object. Dato a buscar.

Returns:

int. Data's position.
-----
int. Posición del dato.

insert

public void insert(java.lang.Object dat)

Adds an element.
-----
Agrega un elemento.

Parameters:

dat - Object. Dat.
-----
dat - Object. Dato.

insert

public void insert(java.lang.Object dat,
                   int pos)

Adds an element based on position.
-----
Agrega un elemento con el dato inidicado en la posición indicada.

Parameters:

dat - Object. Data.
-----
dat - Object. Dato.

pos - int. Position.
-----
pos - int. Posición.

ll

public int ll()

Get Method. List's lenght.
-----
Método de Consutla. Longitud de la lista.

Returns:

int. List's lenght.
-----
int. Longitud de la lista.

next

public boolean next()

Step to next position.
-----
Avanza a la posición siguiente.

Returns:

boolean. Step to next position.
-----
boolean. Avanza a la posición siguiente.

remove

public java.lang.Object remove()
                        throws ErrorEmpty

Removes an element.
-----
Extrae un elemento de acuerdo al orden de la lista.

Returns:

Object. Element
-----
Object. Elemento.

Throws:

ErrorEmpty - Error Message: Empty list.
-----
ErrorEmpty Mensaje de Error: Lista vacía.

remove

public boolean remove(java.lang.Object dat)
               throws ErrorEmpty

Remove an element.
-----
Extrae el elemento del dato dado de acuerdo al orden de la lista.

Parameters:

dat - Object. Data.
-----
dat - Object. Dato.

Returns:

boolean. Removed an event.
-----
boolean. Elimino un evento.

Throws:

ErrorEmpty - Error Message: Empty list.
-----
ErrorEmpty Mensaje de Error: Lista vacía.

setDat

public void setDat(java.lang.Object dat,
                   java.lang.Object dnew)
            throws ErrorEmpty

Set Method. Replace data.
-----
Método de Asignación. Reeemplaza un dato en la lista.

Parameters:

dat - Object. Data.
-----
dat - Object. Dato.

dnew - Object. New data.
-----
dat - Object. Dato nuevo.

Throws:

ErrorEmpty - Error Message: Empty list.
-----
ErrorEmpty Mensaje de Error: Lista vacía.

setPos

public void setPos()

Set Method. Step to first element.
-----
Método de Asignación. Avanza al inicio de la lista.

setPos

public boolean setPos(int pos)

Set Method. Step to position.
-----
Método de Asignación. Avanza a la posición indicada.

Parameters:

pos - int. Position.
-----
pos - int. Posición.

Returns:

false si la posición dada no es válida de lo contrario es true

setPos

public boolean setPos(java.lang.Object dat)

Set Method. Step to data's position.
-----
Método de Asignación. Avanza a la posición del dato dado.

Parameters:

dat - Object. Data.
-----
dat - Object. Dato.

Returns:

boolean. Step to data's position.
-----
boolean. Avanza a la posición del dato dado.

stat

public java.lang.String stat()

List's statistics.
-----
Estadísticas sobre la lista.

Returns:

String. List's statistics.
-----
String. Estadísticas sobre la lista.

toString

public java.lang.String toString()

Visual Method. List.
-----
Visualización del objeto List.

Returns:

String. List in String format.
-----
String. Lista como una cadena.

valPos

public boolean valPos()

Validate current position.
-----
Indica si la posición actual es válida.

Returns:

boolean

valPos

public boolean valPos(int pos)

Validate position.
-----
Indica si la posición dada es válida.

Parameters:

pos - int. Position.
-----
pos - int. Posición.

Returns:

boolean