com.plumtree.portalpages.browsing.search.network
Class NetworkSearchModel

java.lang.Object
  com.plumtree.uiinfrastructure.activityspace.AClearModel
      com.plumtree.portalpages.browsing.search.network.NetworkSearchModel

All Implemented Interfaces:

INetworkSearchModel, INetworkSearchModelRO, IManagedObject, IModel, IModelRO, IMVCObject

public class NetworkSearchModel
extends AClearModel
implements INetworkSearchModelRO, INetworkSearchModel

"network source" and "outgoing federated portal" are used interchangeably in these comments. Upon initialization, the model queries for available outgoing federated portals. They can be accessed through GetNumSources(), GetSourceID(), and GetSourceName().

Author:

JosephSi

Nested Class Summary

static class	NetworkSearchModel.FedPortal Inner helper class to hold info about outgoing federated portals
static class	NetworkSearchModel.SearchResultSet Inner helper class to hold info about search results
static class	NetworkSearchModel.TempDataClass

Field Summary

static java.lang.String	CACHEDPREFS_KEY key for cache used to store prefs so we don't hit the db unnecessarily
static java.lang.String	INCOMING_SWS_CLSID Intrinsic search provider CLSID used to identify inbound federated portals, stored in the search provider registry table PTFEDSEARCHREG.
protected static java.lang.String	LOCATIONPREF_DELIMITER
AActivitySpace	m_asOwner Owning activity space
protected boolean	m_isPathwaysEnabled
protected boolean	m_isPathwaysSearch
protected int	m_numPathwaysResults
protected int	m_pageSize
protected java.lang.String	m_pathwaysFormat
protected XPArrayList	m_pathwaysObjectTypes
protected java.lang.String	m_pathwaysOrder
protected java.lang.String	m_pathwaysOrderBy
PathwaysQueryArguments	m_pathwaysQueryArgument
protected int	m_pathwaysStartAt
protected int	m_pathwaysTotalCount
protected java.lang.String	m_pathwaysViewId
protected IPTSearchRequest	m_searchRequest
boolean	m_tmpAlwaysDoLocalSearch TMP set this flag to true to make all searches run against the local portal.
static int	MAX_SEARCHSTRING_LENGTH
static java.lang.String	NETSEARCHPREF_LOCATIONIDS key used for storing user pref for locations to be checked automatically on the launch page
static java.lang.String	NUM_RESULTS_PREFS_KEY
static java.lang.String	OUTGOING_SWS_CLSID Outbound search SWS provider CLSID, stored in the search provider registry table PTFEDSEARCHREG.
static java.lang.String	SPACE_COLON_SPACE
static java.lang.String	STR_MVC_CLASS_NAME
static int	THISPORTAL_ID Integer id to distinguish local portal searching from searching a particular network source.

Constructor Summary

NetworkSearchModel()

Method Summary

boolean	AreAllResultSetsValid()
protected boolean	CheckIfDisabled(int objectIDintgr) returns true if the outbound fed portals associated web service is disabled
void	CleanupAllData() This method is called when an ActivitySpace is removed from the cache.
void	CleanupTempData() This method is called at the end of every HTTP request by the Interpreter.
void	ClearSearchedSourceList() reset searched source list to be empty
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
protected NetworkSearchModel.SearchResultSet	doLocalPathwaysSearch(java.lang.String searchString, int startIndex, int endIndex) This function sets up a pathways integrated federated search request
protected NetworkSearchModel.SearchResultSet	doLocalSearch(java.lang.String searchString, int startIndex, int endIndex) Perform a search against the local portal.
protected NetworkSearchModel.SearchResultSet	doSearch(int sourceID, java.lang.String searchString, int startIndex, int endIndex) Perform an actual search for the indicated source.
protected int	GetAndSaveOutgoingFederatedPortals(IPTObjectManager ptOM) Get and save the id, name, providerclsid, and thisportalidentity of all available federated portals (inbound and outbound).
java.lang.String	GetDescriptionForResultFromSource(int sourceId, int resultId) Returns null if we hold no result info for the given source or if an error occurred while searching the given source.
java.lang.String	GetErrorFromSource(int sourceID) Return any error message for a given source, used when the results for the source were invalid.
HTMLElement	GetErrorLinkFromSource(int sourceID) certain errors lead to the generation of a link to a config page where the problem can be fixed, in which case this returns the link.
int	GetFirstDisplayedResultFromSource(int sourceId)
int	GetFirstDisplayedResultOverall() Overall rank of first result on page to be displayed.
java.lang.String	GetFormattedError(int sourceId)
HTMLImg	GetImageForResultFromSource(int fedPortalID, int rank) Returns null if we hold no result info for the given source or if an error occurred while searching the given source.
XPHashtable	GetLocationPreferencesForUser() check to see if the user has any stored preferences regarding which sources to check.
java.lang.String	GetName() Return the name of the MVC object.
java.lang.Object	GetNewTempData() This method returns a new temporary data object.
int	GetNumberResults()
int	GetNumDisplayedResultsFromSource(int sourceId) Number of results actually returned in the search response from this source, i.e., the number of results shown on the page at the moment.
int	GetNumDisplayedResultsOverall() Overall number of results on displayed page.
int	GetNumResultsFromSource(int sourceID) Returns -1 if we hold no result info for the given source or if an error occurred while searching the given source.
int	GetNumResultsOverall() Overall number of results.
int	GetNumSources() Return the number of available outbound federated portals NOTE: total does *not* include the local portal (i.e, the first check box on the launch page)
int	GetPageNum() Get the page number for the current results page being displayed
IXPList	GetSearchedSources() Return the object ids for the network sources which will be/were searched by this model.
java.lang.String	GetSearchString() Return the search string from the latest call to Prepare().
boolean	GetSearchStringTruncated() A flag indicating whether we had to truncate the user's search string to NetworkSearchModel.MAX_SEARCHSTRING_LENGTH characters
int	GetSourceID(int id) Return the objectid of the ith available outbound federated portal.
java.lang.String	GetSourceName(int id) Return the name of the ith available outbound federated portal.
java.lang.String	GetTitleForResultFromSource(int sourceId, int resultId) Returns null if we hold no result info for the given source or if an error occurred while searching the given source.
java.lang.String	GetUnencodedSearchString() Return the raw, unencoded search string from the latest call to Prepare()
HTMLAnchor	GetURLForResultFromSource(int fedPortalID, int rank, boolean popup) Returns null if we hold no result info for the given source or if an error occurred while searching the given source.
java.lang.String	GetViewMode() Get the mode in which we are displaying results (collated or parallel)
void	Init(AActivitySpace parent) This method initializes the model.
boolean	IsDisabled(int objectId) returns true if the fed portal's associated web service is currently disabled
protected boolean	isOutgoingFedPortal(java.lang.String clsid) Return true if the given portal is an outgoing portal.
boolean	isResultSetValid(int sourceID) Return true if the model holds a valid result set for a given source.
void	LoadNumberResults()
protected void	LocalPathwaysSearchInit() Initialization code for constructing a pathways search request, much like in SearchResultsModel.PathwaysReinit()
protected HTMLElement	makeErrorLink(int sourceID, boolean userConfig, IPTFederatedSearch ptFedSearch) For certain errors, we want to provide a link leading the user to a page where config info must be set up.
void	Prepare(java.lang.String searchString, IXPList sourceIDs, int pageNum) Call this before using the model to retrieve search results for any results Section page.
void	SaveLocationPreferences(java.lang.String[] locationIDStrings) if the user has checked "always check these locations for me" on the launch page, then here we save the checked locations as user preferences
void	SaveNumberResults()
void	SetAlwaysDoLocalSearch(boolean flag) TMP A debugging method which will go away when the code is complete
protected void	SetLocalSearchSettings(java.lang.String searchString, int startIndex, int endIndex) This function handles the settings of the local portal search
void	SetNumberResults(int num)
void	SetPageNum(int pageNum) Set the page number for the current results page being displayed
void	SetSearchStringTruncated(boolean flag) Set a flag indicating whether we had to truncate the user's search string to NetworkSearchModel.MAX_SEARCHSTRING_LENGTH characters
void	SetViewMode(java.lang.String viewMode) Set the mode in which we are displaying results (collated or parallel)

Methods inherited from class com.plumtree.uiinfrastructure.activityspace.AClearModel

GetTempData

Methods inherited from class java.lang.Object

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

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

See Also:

Constant Field Values

NETSEARCHPREF_LOCATIONIDS

public static final java.lang.String NETSEARCHPREF_LOCATIONIDS

key used for storing user pref for locations to be checked automatically on the launch page

See Also:

Constant Field Values

CACHEDPREFS_KEY

public static final java.lang.String CACHEDPREFS_KEY

key for cache used to store prefs so we don't hit the db unnecessarily

See Also:

Constant Field Values

LOCATIONPREF_DELIMITER

protected static final java.lang.String LOCATIONPREF_DELIMITER

See Also:

Constant Field Values

MAX_SEARCHSTRING_LENGTH

public static final int MAX_SEARCHSTRING_LENGTH

See Also:

Constant Field Values

SPACE_COLON_SPACE

public static final java.lang.String SPACE_COLON_SPACE

See Also:

Constant Field Values

OUTGOING_SWS_CLSID

public static final java.lang.String OUTGOING_SWS_CLSID

Outbound search SWS provider CLSID, stored in the search provider registry table PTFEDSEARCHREG. Objects of type PTFederatedPortal which have this value as their CLSID correspond to remote targets that we can search.

See Also:

Constant Field Values

INCOMING_SWS_CLSID

public static final java.lang.String INCOMING_SWS_CLSID

Intrinsic search provider CLSID used to identify inbound federated portals, stored in the search provider registry table PTFEDSEARCHREG. Objects of type PTFederatedPortal which have this value as their CLSID correspond to portals providing SWS services to the rest of the world.

See Also:

Constant Field Values

THISPORTAL_ID

public static final int THISPORTAL_ID

Integer id to distinguish local portal searching from searching a particular network source.

See Also:

Constant Field Values

m_tmpAlwaysDoLocalSearch

public boolean m_tmpAlwaysDoLocalSearch

TMP set this flag to true to make all searches run against the local portal. For debugging only.

m_asOwner

public AActivitySpace m_asOwner

Owning activity space

m_isPathwaysSearch

protected boolean m_isPathwaysSearch

m_isPathwaysEnabled

protected boolean m_isPathwaysEnabled

m_pathwaysFormat

protected java.lang.String m_pathwaysFormat

m_pathwaysStartAt

protected int m_pathwaysStartAt

m_pathwaysViewId

protected java.lang.String m_pathwaysViewId

m_numPathwaysResults

protected int m_numPathwaysResults

m_pathwaysOrder

protected java.lang.String m_pathwaysOrder

m_pathwaysOrderBy

protected java.lang.String m_pathwaysOrderBy

m_pathwaysTotalCount

protected int m_pathwaysTotalCount

m_pathwaysObjectTypes

protected XPArrayList m_pathwaysObjectTypes

m_pathwaysQueryArgument

public PathwaysQueryArguments m_pathwaysQueryArgument

m_searchRequest

protected IPTSearchRequest m_searchRequest

m_pageSize

protected int m_pageSize

NUM_RESULTS_PREFS_KEY

public static final java.lang.String NUM_RESULTS_PREFS_KEY

See Also:

Constant Field Values

Constructor Detail

NetworkSearchModel

public NetworkSearchModel()

Method Detail

SetNumberResults

public void SetNumberResults(int num)

Specified by:

SetNumberResults in interface INetworkSearchModel

Specified by:

SetNumberResults in interface INetworkSearchModelRO

GetNumberResults

public int GetNumberResults()

Specified by:

GetNumberResults in interface INetworkSearchModel

Specified by:

GetNumberResults in interface INetworkSearchModelRO

SetAlwaysDoLocalSearch

public void SetAlwaysDoLocalSearch(boolean flag)

TMP A debugging method which will go away when the code is complete

Specified by:

SetAlwaysDoLocalSearch in interface INetworkSearchModel

isResultSetValid

public boolean isResultSetValid(int sourceID)

Return true if the model holds a valid result set for a given source. False if there was an error in getting results from the source. Use String GetErrorFromSource(int) to get the error message in the event of invalid results.

Specified by:

isResultSetValid in interface INetworkSearchModelRO

Returns:

AreAllResultSetsValid

public boolean AreAllResultSetsValid()

Specified by:

AreAllResultSetsValid in interface INetworkSearchModelRO

Returns:

CleanupTempData

public void CleanupTempData()

Description copied from interface: IModel

This method is called at the end of every HTTP request by the Interpreter. The Interpreter calls AActivitySpace.CleanupTempData(), which calls this method on all IModels registered using AActivitySpace.RegisterModel(). This method is intended for cleaning up temporary data that is only used for the lifetime of a single request, like DB query results.

Specified by:

CleanupTempData in interface IModel

Overrides:

CleanupTempData in class AClearModel

See Also:

IModel.CleanupTempData()

CleanupAllData

public void CleanupAllData()

Description copied from interface: IModel

This method is called when an ActivitySpace is removed from the cache. The Interpreter calls AActivitySpace.CleanupAllData(), which calls this method on all IModels registered using AActivitySpace.RegisterModel(). This method is intended for releasing data stored in the server when the activity space is no longer needed, such as search objects that need to be maintained as long as the user is clicking through the search, but should be freed when the space can no longer be used. This can be used to prevent Java references to COM memory from hanging around in the long lived Java heap without cleaning up the underlying COM memory. The Java reference will still stay in the long lived heap until it gets garbage collected (which could be a while), but the COM memory should get released here. This method will not be called if an HTTPSession times out. CleanupTempData will be called before CleanupAllData.

Specified by:

CleanupAllData in interface IModel

Overrides:

CleanupAllData in class AClearModel

See Also:

IModel.CleanupAllData()

ClearSearchedSourceList

public void ClearSearchedSourceList()

Description copied from interface: INetworkSearchModel

reset searched source list to be empty

Specified by:

ClearSearchedSourceList in interface INetworkSearchModel

Create

public java.lang.Object Create()

Description copied from class: AClearModel

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Specified by:

Create in class AClearModel

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

GetDescriptionForResultFromSource

public java.lang.String GetDescriptionForResultFromSource(int sourceId,
                                                          int resultId)

Returns null if we hold no result info for the given source or if an error occurred while searching the given source.

Specified by:

GetDescriptionForResultFromSource in interface INetworkSearchModelRO

Returns:

GetErrorFromSource

public java.lang.String GetErrorFromSource(int sourceID)

Return any error message for a given source, used when the results for the source were invalid. !!! localization Can return null if there is no message. This error message was actually not localized in 4.5WS, just printed to the screen.

Specified by:

GetErrorFromSource in interface INetworkSearchModelRO

Returns:

GetErrorLinkFromSource

public HTMLElement GetErrorLinkFromSource(int sourceID)

Description copied from interface: INetworkSearchModelRO

certain errors lead to the generation of a link to a config page where the problem can be fixed, in which case this returns the link. Otherwise, this method will return null

Specified by:

GetErrorLinkFromSource in interface INetworkSearchModelRO

GetFormattedError

public java.lang.String GetFormattedError(int sourceId)

Specified by:

GetFormattedError in interface INetworkSearchModelRO

Returns:

GetFirstDisplayedResultFromSource

public int GetFirstDisplayedResultFromSource(int sourceId)

Specified by:

GetFirstDisplayedResultFromSource in interface INetworkSearchModelRO

Parameters:

sourceId -

Returns:

GetFirstDisplayedResultOverall

public int GetFirstDisplayedResultOverall()

Overall rank of first result on page to be displayed. We calculate this by summing the number of skipped results from each source

Specified by:

GetFirstDisplayedResultOverall in interface INetworkSearchModelRO

Returns:

GetImageForResultFromSource

public HTMLImg GetImageForResultFromSource(int fedPortalID,
                                           int rank)

Returns null if we hold no result info for the given source or if an error occurred while searching the given source.

Specified by:

GetImageForResultFromSource in interface INetworkSearchModelRO

Returns:

GetName

public java.lang.String GetName()

Description copied from interface: IMVCObject

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class AClearModel

Returns:

See Also:

IMVCObject.GetName()

GetNumDisplayedResultsFromSource

public int GetNumDisplayedResultsFromSource(int sourceId)

Number of results actually returned in the search response from this source, i.e., the number of results shown on the page at the moment. For instance, there might be a total of 8 results matching the query from the source. If we show 5 results per page, then this method will return 5 if we're on page 1 and 3 if we're on page 2.

Specified by:

GetNumDisplayedResultsFromSource in interface INetworkSearchModelRO

Returns:

GetNumDisplayedResultsOverall

public int GetNumDisplayedResultsOverall()

Overall number of results on displayed page. We calculate this by summing the number of displayed results from each source.

Specified by:

GetNumDisplayedResultsOverall in interface INetworkSearchModelRO

Returns:

GetNumResultsFromSource

public int GetNumResultsFromSource(int sourceID)

Returns -1 if we hold no result info for the given source or if an error occurred while searching the given source.

Specified by:

GetNumResultsFromSource in interface INetworkSearchModelRO

Returns:

GetNumResultsOverall

public int GetNumResultsOverall()

Overall number of results. Sum of the number of results from each source.

Specified by:

GetNumResultsOverall in interface INetworkSearchModelRO

Returns:

GetNumSources

public int GetNumSources()

Return the number of available outbound federated portals NOTE: total does *not* include the local portal (i.e, the first check box on the launch page)

Specified by:

GetNumSources in interface INetworkSearchModelRO

Returns:

GetPageNum

public int GetPageNum()

Get the page number for the current results page being displayed

Specified by:

GetPageNum in interface INetworkSearchModelRO

Returns:

GetSearchString

public java.lang.String GetSearchString()

Return the search string from the latest call to Prepare(). Note: we return an html-encoded version, rather than the original string

Specified by:

GetSearchString in interface INetworkSearchModelRO

Returns:

GetUnencodedSearchString

public java.lang.String GetUnencodedSearchString()

Return the raw, unencoded search string from the latest call to Prepare()

Specified by:

GetUnencodedSearchString in interface INetworkSearchModelRO

GetSearchedSources

public IXPList GetSearchedSources()

Return the object ids for the network sources which will be/were searched by this model.

Specified by:

GetSearchedSources in interface INetworkSearchModelRO

Returns:

GetSourceID

public int GetSourceID(int id)

Return the objectid of the ith available outbound federated portal.

Specified by:

GetSourceID in interface INetworkSearchModelRO

Returns:

GetSourceName

public java.lang.String GetSourceName(int id)

Return the name of the ith available outbound federated portal.

Specified by:

GetSourceName in interface INetworkSearchModelRO

Returns:

GetTitleForResultFromSource

public java.lang.String GetTitleForResultFromSource(int sourceId,
                                                    int resultId)

Returns null if we hold no result info for the given source or if an error occurred while searching the given source.

Specified by:

GetTitleForResultFromSource in interface INetworkSearchModelRO

Returns:

GetURLForResultFromSource

public HTMLAnchor GetURLForResultFromSource(int fedPortalID,
                                            int rank,
                                            boolean popup)

Returns null if we hold no result info for the given source or if an error occurred while searching the given source.

Specified by:

GetURLForResultFromSource in interface INetworkSearchModelRO

Returns:

GetViewMode

public java.lang.String GetViewMode()

Get the mode in which we are displaying results (collated or parallel)

Specified by:

GetViewMode in interface INetworkSearchModelRO

Returns:

Init

public void Init(AActivitySpace parent)

Description copied from interface: IModel

This method initializes the model. This is called automatically when AActivitySpace.RegisterModel() is called.

Specified by:

Init in interface IModel

Overrides:

Init in class AClearModel

Parameters:

parent - the parent Activity Space

See Also:

com.plumtree.portaluiinfrastructure.activityspace.IModel#Init(AActivitySpace)

Prepare

public void Prepare(java.lang.String searchString,
                    IXPList sourceIDs,
                    int pageNum)

Call this before using the model to retrieve search results for any results Section page. This method performs the necessary behind the scenes search requests needed to answer questions about results from the desired range and from the desired sources. !!! Needs language.

Specified by:

Prepare in interface INetworkSearchModel

SetPageNum

public void SetPageNum(int pageNum)

Set the page number for the current results page being displayed

Specified by:

SetPageNum in interface INetworkSearchModel

SetViewMode

public void SetViewMode(java.lang.String viewMode)

Set the mode in which we are displaying results (collated or parallel)

Specified by:

SetViewMode in interface INetworkSearchModel

isOutgoingFedPortal

protected boolean isOutgoingFedPortal(java.lang.String clsid)

Return true if the given portal is an outgoing portal. This logic was copied from the 4.5WS fedsearch.asp.

GetAndSaveOutgoingFederatedPortals

protected int GetAndSaveOutgoingFederatedPortals(IPTObjectManager ptOM)

Get and save the id, name, providerclsid, and thisportalidentity of all available federated portals (inbound and outbound). Returns the number of portals found. Use GetFedPortalXXX(id) to get info from a particular fedportal

IsDisabled

public boolean IsDisabled(int objectId)

returns true if the fed portal's associated web service is currently disabled

Specified by:

IsDisabled in interface INetworkSearchModelRO

CheckIfDisabled

protected boolean CheckIfDisabled(int objectIDintgr)

returns true if the outbound fed portals associated web service is disabled

LocalPathwaysSearchInit

protected void LocalPathwaysSearchInit()

Initialization code for constructing a pathways search request, much like in SearchResultsModel.PathwaysReinit()

SetLocalSearchSettings

protected void SetLocalSearchSettings(java.lang.String searchString,
                                      int startIndex,
                                      int endIndex)

This function handles the settings of the local portal search

Parameters:

searchString - the search text value

startIndex - the start of the search index value

endIndex - the end of the search index value

doLocalPathwaysSearch

protected NetworkSearchModel.SearchResultSet doLocalPathwaysSearch(java.lang.String searchString,
                                                                   int startIndex,
                                                                   int endIndex)

This function sets up a pathways integrated federated search request

Parameters:

searchString - the search term

startIndex - the start index number of the search

endIndex - the end index number of the search

Returns:

the SearchResultSet of the pathways search results

doLocalSearch

protected NetworkSearchModel.SearchResultSet doLocalSearch(java.lang.String searchString,
                                                           int startIndex,
                                                           int endIndex)

Perform a search against the local portal.

doSearch

protected NetworkSearchModel.SearchResultSet doSearch(int sourceID,
                                                      java.lang.String searchString,
                                                      int startIndex,
                                                      int endIndex)

Perform an actual search for the indicated source. !!! Needs to return some sort of error code?

makeErrorLink

protected HTMLElement makeErrorLink(int sourceID,
                                    boolean userConfig,
                                    IPTFederatedSearch ptFedSearch)

For certain errors, we want to provide a link leading the user to a page where config info must be set up. This method constructs that link

SaveLocationPreferences

public void SaveLocationPreferences(java.lang.String[] locationIDStrings)

if the user has checked "always check these locations for me" on the launch page, then here we save the checked locations as user preferences

Specified by:

SaveLocationPreferences in interface INetworkSearchModel

GetLocationPreferencesForUser

public XPHashtable GetLocationPreferencesForUser()

check to see if the user has any stored preferences regarding which sources to check. Note: returns null if there are no such preferences

Specified by:

GetLocationPreferencesForUser in interface INetworkSearchModelRO

SetSearchStringTruncated

public void SetSearchStringTruncated(boolean flag)

Set a flag indicating whether we had to truncate the user's search string to NetworkSearchModel.MAX_SEARCHSTRING_LENGTH characters

Specified by:

SetSearchStringTruncated in interface INetworkSearchModel

GetSearchStringTruncated

public boolean GetSearchStringTruncated()

A flag indicating whether we had to truncate the user's search string to NetworkSearchModel.MAX_SEARCHSTRING_LENGTH characters

Specified by:

GetSearchStringTruncated in interface INetworkSearchModelRO

LoadNumberResults

public void LoadNumberResults()

SaveNumberResults

public void SaveNumberResults()

GetNewTempData

public java.lang.Object GetNewTempData()

Description copied from class: AClearModel

This method returns a new temporary data object. It is called at the beginning of a new HTTP Request. This method can perform initialization on the data object if necessary.

Specified by:

GetNewTempData in class AClearModel

Returns:

Object the new temporary data object