maps.gml.formats

Class RobocupFormat

java.lang.Object

maps.gml.GMLMapFormat

maps.gml.formats.RobocupFormat

All Implemented Interfaces:

MapFormat

public final class RobocupFormat
extends GMLMapFormat

A MapFormat that can handle Robocup Rescue GML maps.

Field Summary

Fields

Modifier and Type	Field and Description
static RobocupFormat	INSTANCE Singleton instance.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getNamespaces() Get the uris and preferred prefixes for all namespaces this format cares about.
boolean	isCorrectRootElement(java.lang.String uri, java.lang.String localName) Find out if the root element is correct for this format type.
GMLMap	read(org.dom4j.Document doc) Read a Document and return a GMLMap.
java.lang.String	toString()
org.dom4j.Document	write(GMLMap map) Turn a GMLMap into an xml document.

Methods inherited from class maps.gml.GMLMapFormat

canRead, read, read, write

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final RobocupFormat INSTANCE

Singleton instance.

Method Detail

getNamespaces

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

Description copied from class: GMLMapFormat

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

Specified by:

getNamespaces in class GMLMapFormat

Returns:

A map from prefix to uri for all relevant namespaces.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isCorrectRootElement

public boolean isCorrectRootElement(java.lang.String uri,
                                    java.lang.String localName)

Description copied from class: GMLMapFormat

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

Specified by:

isCorrectRootElement in class GMLMapFormat

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

public GMLMap read(org.dom4j.Document doc)
            throws MapException

Description copied from class: GMLMapFormat

Read a Document and return a GMLMap.

Specified by:

read in class GMLMapFormat

Parameters:

doc - The document to read.

Returns:

A new GMLMap.

Throws:

MapException - If there is a problem reading the map.

write

public org.dom4j.Document write(GMLMap map)

Description copied from class: GMLMapFormat

Turn a GMLMap into an xml document.

Specified by:

write in class GMLMapFormat

Parameters:

map - The map to write.

Returns:

A new document.