com.portal.web.comp

Class EventSearchHelper

java.lang.Object

com.portal.web.comp.EventSearchHelper

public class EventSearchHelper
extends Object

The UsageReport JSPs use this class to read the resource bundle and properties files to retrieve event-related information. This class retrieves the following event information:

• A map of URLs that have page titles.
• A localized page title.
• A localized list of column names.
• A map containing the following details used for the event search:
• Event name, for example, "wap"
• Event type, for example, /event/activity/wap/interactive
• Localized event description, for example, Mobile Internet
• Event URL, for example, UsageReportWapView.jsp
• Event fields to retrieve from Infranet
• Localized column name for each of the fields retrieved

Constructor Summary

Constructors

Constructor and Description
EventSearchHelper(ResourceBundle res, Properties props, List serList) Given a resource bundle and properties, initializes a services list with the account's service usage events and constructs an EventSearchHelper.

Method Summary

Modifier and Type	Method and Description
List	getColumnNames(String event) Gets a list of column names for the event, using properties and resource file entries to construct the fieldSpecification.
Map	getDetails(String eventName) Gets an event's details, using properties and resource file entries to construct the fieldSpecification.
String	getPageTitle(String event) Gets the URL's page title for the event, using properties and resource file entries to construct the returned String.
Map	getURLs() Gets the URLs that have page titles, using properties and resource file entries to put the titles in viewing order.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventSearchHelper

public EventSearchHelper(ResourceBundle res,
                         Properties props,
                         List serList)

Given a resource bundle and properties, initializes a services list with the account's service usage events and constructs an EventSearchHelper.

Parameters:

res - the resource bundle (WebKitResources.properties)

props - the properties (WebKit.properties)

serList - the services list

Method Detail

getDetails

public Map getDetails(String eventName)
               throws MissingResourceException

Gets an event's details, using properties and resource file entries to construct the fieldSpecification. If the event name is "general," includes the list of event types to exclude.

Parameters:

eventName - the event.eventName entries in the WebKit.properties file

Returns:

A Map containing the event details.

Throws:

MissingResourceException

getURLs

public Map getURLs()
            throws MissingResourceException

Gets the URLs that have page titles, using properties and resource file entries to put the titles in viewing order.

Returns:

A Map containing the page titles as keys and the URLs as values.

Throws:

MissingResourceException

getColumnNames

public List getColumnNames(String event)

Gets a list of column names for the event, using properties and resource file entries to construct the fieldSpecification.

Parameters:

event - the event entry in the WebKit.properties file

Returns:

A List of column names for the event.

getPageTitle

public String getPageTitle(String event)
                    throws MissingResourceException

Gets the URL's page title for the event, using properties and resource file entries to construct the returned String.

Parameters:

event - the event entry in the WebKit.properties file

Returns:

A String that contains the page's title.

Throws:

MissingResourceException - thrown for a null event String