maps.gml

Class GMLMapFormat

java.lang.Object

maps.gml.GMLMapFormat

All Implemented Interfaces:

MapFormat

Direct Known Subclasses:

GeospatialInformationAuthorityFormat, MeijoFormat, OrdnanceSurveyFormat, RobocupFormat

public abstract class GMLMapFormat
extends java.lang.Object
implements MapFormat

Abstract base class for map formats that use GML.

Constructor Summary

Constructors

Constructor and Description
GMLMapFormat()

Method Summary

Modifier and Type	Method and Description
boolean	canRead(java.io.File file) Find out if a file looks valid to this format.
protected abstract java.util.Map<java.lang.String,java.lang.String>	getNamespaces() Get the uris and preferred prefixes for all namespaces this format cares about.
protected abstract boolean	isCorrectRootElement(java.lang.String uri, java.lang.String localName) Find out if the root element is correct for this format type.
protected abstract GMLMap	read(org.dom4j.Document doc) Read a Document and return a GMLMap.
GMLMap	read(java.io.File file) Read a File and return a Map.
GMLMap	read(java.io.Reader reader) Read a GMLMap from a Reader.
protected abstract org.dom4j.Document	write(GMLMap map) Turn a GMLMap into an xml document.
void	write(Map map, java.io.File file) Write a map to a file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GMLMapFormat

public GMLMapFormat()

Method Detail

read

public GMLMap read(java.io.File file)
            throws MapException

Description copied from interface: MapFormat

Read a File and return a Map.

Specified by:

read in interface MapFormat

Parameters:

file - The file to read.

Returns:

A new Map.

Throws:

MapException - If there is a problem reading the map.

write

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

Description copied from interface: MapFormat

Write a map to a file.

Specified by:

write in interface MapFormat

Parameters:

map - The map to write.

file - The file to write to.

Throws:

MapException - If there is a problem writing the map.

canRead

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

Description copied from interface: MapFormat

Find out if a file looks valid to this format.

Specified by:

canRead in interface MapFormat

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.

read

public GMLMap read(java.io.Reader reader)
            throws org.dom4j.DocumentException,
                   MapException

Read a GMLMap from a Reader.

Parameters:

reader - The Reader to read.

Returns:

A new GMLMap.

Throws:

org.dom4j.DocumentException - If there is a problem parsing the XML.

MapException - If there is a problem reading the map.

isCorrectRootElement

protected abstract boolean isCorrectRootElement(java.lang.String uri,
                                                java.lang.String localName)

Find out if the root element is correct for this format type.

Parameters:

uri - The URI of the root element.

localName - The local name of the root element.

Returns:

True if the uri and localName are correct for this format's root element, false otherwise.

read

protected abstract GMLMap read(org.dom4j.Document doc)
                        throws MapException

Read a Document and return a GMLMap.

Parameters:

doc - The document to read.

Returns:

A new GMLMap.

Throws:

MapException - If there is a problem reading the map.

write

protected abstract org.dom4j.Document write(GMLMap map)

Turn a GMLMap into an xml document.

Parameters:

map - The map to write.

Returns:

A new document.

getNamespaces

protected abstract java.util.Map<java.lang.String,java.lang.String> getNamespaces()

Get the uris and preferred prefixes for all namespaces this format cares about.

Returns:

A map from prefix to uri for all relevant namespaces.