com.c5corp.c5gps.filters
Interface GpsDataFilter

All Known Implementing Classes:
CsvRouteListFilter, CsvTrackLogListFilter, CsvWayPointListFilter

public interface GpsDataFilter

The com.c5corp.c5gps.filters.GpsFilter interface is implemented by of all GPS filters in the package com.c5corp.c5gps.filters package. These are helpers for file i/o for arbitrary file formats.

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

Method Summary
 GpsDataFileType readFile()
           
 void setFile(java.io.File outputfile)
           
 java.lang.String toString(GpsDataFileType dataOb)
          Converts a GpsDataFileType into a String representation
 void writeFile(GpsDataFileType dataOb)
           
 

Method Detail

readFile

GpsDataFileType readFile()
Returns:
a GpsDataFileType representing the data read from the file

setFile

void setFile(java.io.File outputfile)
Parameters:
outputfile - the output file to which data should be sent
See Also:
writeFile(GpsDataFileType)

writeFile

void writeFile(GpsDataFileType dataOb)
Parameters:
dataOb - the object containing the data to write to the file
See Also:
setFile(File)

toString

java.lang.String toString(GpsDataFileType dataOb)
Converts a GpsDataFileType into a String representation

Parameters:
dataOb - the dataOb to Stringify
Returns:
a String representation of the data in dataOb