| java.lang.Object
 com.salmonllc.sitemap.SiteMap
| SiteMap | | public class SiteMap (Code) | | SOFIA site map implementation
|
| Method Summary | |
| public void | addActionEntry(String entryName, String actionName, String actionEntry)
| | public String | addJavaScriptToUrl(String logicalName, String url)
| | public String | generateConstants(String className)
| | public String[] | getActionEntries(String entryName)
Returns a string array of all the action names for an entry. | | public String | getActionEntry(String entryName, String actionName)
| | public String | getContext(String logicalName)
| | public String | getEntryName(String URI)
| | public Enumeration | getEntryNames()
| | public String | getPopupFeatures(String logicalName)
| | public static SiteMap | getSiteMap(String applicationName)
| | public String | getSiteMapURL(HttpServletRequest req, String logicalName)
| | public String | getSiteMapURL(HttpServletRequest req, String logicalName, String additionalParms)
| | public String | getSiteMapURL(HttpServletRequest req, String logicalName, String additionalParms, boolean javaScriptOK)
| | public String | getSiteMapURL(HttpServletRequest req, String logicalName, String additionalParms, boolean javaScriptOK, boolean doForwardOK)
| | public String | getURI(String logicalName)
| | public boolean | isSecure(String logicalName)
| | public synchronized void | putEntry(String logicalName, String uri, String popupFeatures, boolean useForward, boolean secure, String context)
Puts an entry into the site map. | | public synchronized void | removeEntry(String logicalName)
| | public void | setContext(String logicalName, String context)
| | public void | setPopupFeatures(String logicalName, String popupFeatures)
| | public void | setSecure(String logicalName, boolean secure)
| | public void | setURI(String logicalName, String URI)
| | public void | setUseForward(String logicalName, boolean useForward)
| | public synchronized void | update()
| | public boolean | useForward(String logicalName)
| | public boolean | useJavascript(String logicalName)
|
| SiteMap | | public SiteMap(String applicationName)(Code) | | Creates an empty SiteMap Object pointing to a particular application
|
| addActionEntry | | public void addActionEntry(String entryName, String actionName, String actionEntry)(Code) | | Adds an action to a site map entry
Parameters:
entryName - The name of the entry to add the action for
Parameters:
actionName - The identifier for the action
Parameters:
actionEntry - Another site map entry that this action will invoke |
| addJavaScriptToUrl | | public String addJavaScriptToUrl(String logicalName, String url)(Code) | | Adds popup window javascript to a url entry if it indicates so in the site map
|
| generateConstants | | public String generateConstants(String className)(Code) | | Generates a Java source code final class with constants for each sitemap entry
|
| getActionEntries | | public String[] getActionEntries(String entryName)(Code) | | Returns a string array of all the action names for an entry.
|
| getActionEntry | | public String getActionEntry(String entryName, String actionName)(Code) | | Returns the site map entry associated with a particular action
Parameters:
entryName - The name of the site map entry
Parameters:
actionName - The name of the action for that particular entry the name of the entry or null if not found |
| getContext | | public String getContext(String logicalName)(Code) | | Returns the Context relative to the web application root or null if there is no entry
|
| getEntryName | | public String getEntryName(String URI)(Code) | | Returns the logical name for the site map entry given the URI of a particulat page or null if that URI isn't found in the site map
Parameters:
URI - The URI for the page not including the servername and web application name |
| getPopupFeatures | | public String getPopupFeatures(String logicalName)(Code) | | Returns the Popup window features for the specified entry
|
| getSiteMap | | public static SiteMap getSiteMap(String applicationName)(Code) | | Returns the SiteMap object associated with a particular application
|
| getSiteMapURL | | public String getSiteMapURL(HttpServletRequest req, String logicalName)(Code) | | Returns the url for a specified logical site map entry
Parameters:
req - The HttpServletRequest used for this lookup
Parameters:
logicalName - The name of the entry in the site map The absolute url to the page |
| getSiteMapURL | | public String getSiteMapURL(HttpServletRequest req, String logicalName, String additionalParms)(Code) | | Returns the url for a specified logical site map entry
Parameters:
req - The HttpServletRequest used for this lookup
Parameters:
logicalName - The name of the entry in the site map
Parameters:
additionalParms - Any additional parameters that need to be appended to the url The absolute url to the page |
| getSiteMapURL | | public String getSiteMapURL(HttpServletRequest req, String logicalName, String additionalParms, boolean javaScriptOK)(Code) | | Returns the url for a specified logical site map entry
Parameters:
req - The HttpServletRequest used for this lookup
Parameters:
logicalName - The name of the entry in the site map
Parameters:
additionalParms - Any additional parameters that need to be appended to the url
Parameters:
javaScriptOK - True to allow JavaScript in the URL (for popup windows) The absolute url to the page |
| getSiteMapURL | | public String getSiteMapURL(HttpServletRequest req, String logicalName, String additionalParms, boolean javaScriptOK, boolean doForwardOK)(Code) | | Returns the url for a specified logical site map entry
Parameters:
req - The HttpServletRequest used for this lookup
Parameters:
logicalName - The name of the entry in the site map
Parameters:
additionalParms - Any additional parameters that need to be appended to the url
Parameters:
javaScriptOK - True to allow JavaScript in the URL (for popup windows)
Parameters:
doForwardOK - True or false, the url being generated is in a contect where a forward can be used The absolute url to the page |
| getURI | | public String getURI(String logicalName)(Code) | | Returns the URI relative to the web application root or null if there is no entry
|
| isSecure | | public boolean isSecure(String logicalName)(Code) | | Return true if the entry uses https
|
| putEntry | | public synchronized void putEntry(String logicalName, String uri, String popupFeatures, boolean useForward, boolean secure, String context)(Code) | | Puts an entry into the site map. If the entry already exists it will be overwritten
Parameters:
logicalName - The logical name of the site map entry
Parameters:
uri - The URI of the page to go to when the entry is invoked
Parameters:
useForward - true if the site map entry should use a forward instead of a redirect
Parameters:
secure - true if the site map entry should jump to a secure url (https) |
| removeEntry | | public synchronized void removeEntry(String logicalName)(Code) | | Removes an entry from the list
Parameters:
logicalName - |
| setContext | | public void setContext(String logicalName, String context)(Code) | | Sets the context relative to the web application for the entry
|
| setPopupFeatures | | public void setPopupFeatures(String logicalName, String popupFeatures)(Code) | | Sets the Popup Features for the page or null to open in the same window
|
| setSecure | | public void setSecure(String logicalName, boolean secure)(Code) | | Sets whether the URI entry is secure
|
| setURI | | public void setURI(String logicalName, String URI)(Code) | | Sets the URI relative to the web application for the entry
|
| setUseForward | | public void setUseForward(String logicalName, boolean useForward)(Code) | | Sets whether the URI entry uses a forward
|
| update | | public synchronized void update() throws IOException(Code) | | Writes out the sitemap object to an xml file in the properties path
|
| useForward | | public boolean useForward(String logicalName)(Code) | | Returns true if the entry uses a forward instead of a redirect
|
| useJavascript | | public boolean useJavascript(String logicalName)(Code) | | Returns true if the entry uses javascript to open a window as a popup
|
|
|