com.c5corp.c5gps
Class RouteList

java.lang.Object
  extended by com.c5corp.c5gps.RouteList
All Implemented Interfaces:
GpsDataFileType, java.util.Enumeration

public class RouteList
extends java.lang.Object
implements GpsDataFileType, java.util.Enumeration

A RouteList is a container class for a list of Route objects. A list of Routes is typically stored in a file; this object represents such a file. The file has header data that applies to all of the Routes it contains.

Since:
2.0
Author:
Brett Stalbaum Copyright 2002-2006 see LICENSE.txt and UCSD_LICENSE.txt
See Also:
Route, CsvRouteListFilter

Constructor Summary
RouteList(java.util.Vector<Route> routes)
          Constructs a RouteList from a Vector of Route objects
 
Method Summary
 java.util.Vector<RoutePoint> getRoutePointDatabase()
          returns the entire Vector of RoutePoint objects represented as the entire RoutePoint database in this list of Routes.
 boolean hasMoreElements()
          implements java.util.Enumeration
 Route nextElement()
          implements java.util.Enumeration
 void reset()
          resets the java.util.Enumeration to the first element
 int size()
          returns the number of RoutePoints in this RoutePointList
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RouteList

public RouteList(java.util.Vector<Route> routes)
Constructs a RouteList from a Vector of Route objects

Parameters:
routes - a Vector of Route objects
See Also:
Route
Method Detail

hasMoreElements

public boolean hasMoreElements()
implements java.util.Enumeration

Specified by:
hasMoreElements in interface java.util.Enumeration
Returns:
true if has more elements
See Also:
Enumeration

nextElement

public Route nextElement()
                  throws java.util.NoSuchElementException
implements java.util.Enumeration

Specified by:
nextElement in interface java.util.Enumeration
Returns:
the next Route
Throws:
java.util.NoSuchElementException
See Also:
Enumeration

getRoutePointDatabase

public java.util.Vector<RoutePoint> getRoutePointDatabase()
returns the entire Vector of RoutePoint objects represented as the entire RoutePoint database in this list of Routes. (In other words, a Vector of all of the RoutePoints for all of the Routes objects in this RouteList.)

Returns:
the RoutePoint database for the RouteList

size

public int size()
returns the number of RoutePoints in this RoutePointList

Returns:
the mber of RoutePoints in this RoutePointList

reset

public void reset()
resets the java.util.Enumeration to the first element