org.grinvin.help

Class DefaultMap

Implemented Interfaces:
Map
Known Direct Subclasses:
GeneratorMap, GraphFactoryMap, InvariantMap

public class DefaultMap
extends java.lang.Object
implements Map

Provides the mapping of context-sensitive help IDs and URLs for help page. This class is a common superclass of GraphFactoryMap and InvariantMap.

Constructor Summary

DefaultMap()
creates new DefaultMap with empty list of ids.
DefaultMap(List ids)
creates new DefaultMap with given list of ids.

Method Summary

Enumeration
getAllIDs()
Map.ID
getClosestID(URL uRL)
Map.ID
getIDFromURL(URL uRL)
Enumeration
getIDs(URL uRL)
URL
getURLFromID(Map.ID iD)
boolean
isID(URL uRL)
boolean
isValidID(String string, HelpSet helpSet)
protected void
setIDList(List ids)
allows superclasses to set the list of IDs when this can not be done in the constructor.
protected void
setURLPrefix(String urlPrefix)
method for superclasses to set the prefix for URLs.

Constructor Details

DefaultMap

protected DefaultMap()
creates new DefaultMap with empty list of ids. Use setIDList to set the ids.

DefaultMap

protected DefaultMap(List ids)
creates new DefaultMap with given list of ids.

Method Details

getAllIDs

public Enumeration getAllIDs()

getClosestID

public Map.ID getClosestID(URL uRL)

getIDFromURL

public Map.ID getIDFromURL(URL uRL)

getIDs

public Enumeration getIDs(URL uRL)

getURLFromID

public URL getURLFromID(Map.ID iD)
            throws MalformedURLException

isID

public boolean isID(URL uRL)

isValidID

public boolean isValidID(String string,
                         HelpSet helpSet)

setIDList

protected void setIDList(List ids)
allows superclasses to set the list of IDs when this can not be done in the constructor.

setURLPrefix

protected void setURLPrefix(String urlPrefix)
method for superclasses to set the prefix for URLs.