maps

Interface MapFormat

All Known Implementing Classes:

GeospatialInformationAuthorityFormat, GMLMapFormat, LegacyMapFormat, MeijoFormat, OrdnanceSurveyFormat, RobocupFormat

public interface MapFormat

Interface for different types of map format.

Method Summary

Modifier and Type	Method and Description
boolean	canRead(java.io.File file) Find out if a file looks valid to this format.
Map	read(java.io.File file) Read a File and return a Map.
void	write(Map map, java.io.File file) Write a map to a file.

Method Detail

read

Map read(java.io.File file)
  throws MapException

Read a File and return a Map.

Parameters:

file - The file to read.

Returns:

A new Map.

Throws:

MapException - If there is a problem reading the map.

write

void write(Map map,
           java.io.File file)
    throws MapException

Write a map to a file.

Parameters:

map - The map to write.

file - The file to write to.

Throws:

MapException - If there is a problem writing the map.

canRead

boolean canRead(java.io.File file)
         throws MapException

Find out if a file looks valid to this format.

Parameters:

file - The file to check.

Returns:

True if this format can probably read the file, false otherwise.

Throws:

MapException - If there is a problem reading the file.