| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.help.FlatMap
A FlatMap is a simple implementation of a Map. It is used to represent a Map for a single file.
| Nested Class Summary | 
| Nested classes inherited from class javax.help.Map | 
| Map.ID | 
| Field Summary | |
| static java.lang.String | publicIDStringPublicID (known to this XML processor) to the DTD for version 1.0 of the Map | 
| static java.lang.String | publicIDString_V2PublicID (known to this XML processor) to the DTD for version 1.0 of the Map | 
| Constructor Summary | |
| FlatMap(java.net.URL base,
        HelpSet hs)Create a FlatMap from a given URL. | |
| Method Summary | |
|  java.util.Enumeration | getAllIDs()Gets an enumeration of all the IDs in a Map. | 
|  Map.ID | getClosestID(java.net.URL url)Determines the ID that is "closest" to this URL (with a given anchor). | 
|  HelpSet | getHelpSet()The HelpSet for this Map. | 
|  Map.ID | getIDFromURL(java.net.URL url)Gets the ID for this URL. | 
|  java.util.Enumeration | getIDs(java.net.URL url)Determines the IDs related to this URL. | 
|  java.net.URL | getURLFromID(Map.ID iden)Gets the URL that corresponds to a given ID in the map. | 
|  boolean | isID(java.net.URL url)Determines if the URL corresponds to an ID in the Map. | 
|  boolean | isValidID(java.lang.String id,
          HelpSet hs)Determines whether the given ID is valid. | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
public static final java.lang.String publicIDString
public static final java.lang.String publicIDString_V2
| Constructor Detail | 
public FlatMap(java.net.URL base,
               HelpSet hs)
        throws java.io.IOException
hs - The HelpSet providing "context" for this Map.
java.lang.IllegalArgumentException - if hs doesn't have nested HelpSets.
java.io.IOException| Method Detail | 
public HelpSet getHelpSet()
public boolean isValidID(java.lang.String id,
                         HelpSet hs)
isValidID in interface Mapid - The String ID.hs - The HelpSet against which to resolve the string.
public java.util.Enumeration getAllIDs()
getAllIDs in interface Map
public java.net.URL getURLFromID(Map.ID iden)
                          throws java.net.MalformedURLException
getURLFromID in interface Mapiden - The iden to get the URL for. If iden is null it is
 treated as an unresolved ID and will return null.
java.net.MalformedURLException - if the URLspecification found  is malformedpublic boolean isID(java.net.URL url)
isID in interface Mapurl - The URL to check on.
public Map.ID getIDFromURL(java.net.URL url)
getIDFromURL in interface Mapurl - The URL to get the ID for.
public Map.ID getClosestID(java.net.URL url)
getClosestID in interface Mapurl - A URL
public java.util.Enumeration getIDs(java.net.URL url)
getIDs in interface Map| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||