com.stratelia.silverpeas.pdcPeas.control
Class PdcSearchSessionController

java.lang.Object
  extended by com.stratelia.silverpeas.peasCore.AbstractComponentSessionController
      extended by com.stratelia.silverpeas.pdcPeas.control.PdcSearchSessionController
All Implemented Interfaces:
ComponentSessionController

public class PdcSearchSessionController
extends AbstractComponentSessionController


Field Summary
static String ALL_COMPONENTS
           
static String ALL_DATA_TYPE
           
static String ALL_SPACES
           
static int SEARCH_ADVANCED
           
static int SEARCH_EXPERT
           
static int SEARCH_FULLTEXT
           
static int SEARCH_MIXED
           
static int SEARCH_PDC
           
static int SEARCH_SIMPLE
           
static int SEARCH_XML
           
static int SHOWRESULTS_ALL
           
static int SHOWRESULTS_OnlyPDC
           
static String SORT_ORDER_ASC
           
static String SORT_ORDER_DESC
           
 
Fields inherited from class com.stratelia.silverpeas.peasCore.AbstractComponentSessionController
CHARACTER_ENCODING, context
 
Constructor Summary
PdcSearchSessionController(MainSessionController mainSessionCtrl, ComponentContext componentContext, String multilangBundle, String iconBundle)
           
 
Method Summary
 SearchContext addCriteriaToSearchContext(SearchCriteria criteria)
           
 void buildComponentListWhereToSearch(String space, String component)
          ******************************************************************************************
 void buildCustomComponentListWhereToSearch(String space, List<String> components)
          This method allow user to search over multiple component selection
 void clearFilteredSR()
           
 void clearQueryParameters()
           
 void clearXmlTemplateAndData()
           
 boolean getActiveThesaurus()
           
 List<AxisHeader> getAllAxis()
           
 List<ComponentInstLight> getAllowedComponents(String space)
          Returns the list of allowed components for the current user in the given space/domain.
 List<SpaceInstLight> getAllowedSpaces()
          Returns the list of allowed spaces/domains for the current user.
 List<SearchAxis> getAxis(String viewType)
           
 List<SearchAxis> getAxis(String viewType, AxisFilter filter)
           
 Axis getAxisDetail(String axisId)
           
 Axis getAxisDetail(String axisId, AxisFilter filter)
           
 AxisHeader getAxisHeader(String axisId)
           
 List<Value> getAxisResult()
           
 Value getAxisValue(String valueId, String treeId)
           
 Value getAxisValueAndFullPath(String valueId, String treeId)
           
 List<Value> getAxisValuesByFilter(String filter_by_name, String filter_by_description, boolean search_in_daughters, String instanceId)
           
 String getComponentLabel(String spaceId, String componentId)
          Returns the label of the given component
 ContainerPeas getContainerPeas()
           
 ContainerPositionInterface getContainerPosition()
           
 ContainerWorkspace getContainerWorkspace()
           
 ContentPeas getContentPeas()
           
 String getCurrentComponentId()
           
 List<String> getCurrentComponentIds()
           
 int getCurrentResultsDisplay()
           
 Value getCurrentValue()
           
 String getDataType()
           
 List<Value> getDaughterValues(String axisId, String valueId)
           
 List<Value> getDaughterValues(String axisId, String valueId, AxisFilter filter)
           
 String getDisplayParamChoices()
           
 Map<String,Facet> getFieldFacets()
           
 List<GlobalSilverResult> getFilteredSR()
           
 List<Value> getFirstLevelAxisValues(String axisId)
           
 List<Value> getFullPath(String valueId, String treeId)
           
 List<GlobalSilverResult> getGlobalSR()
           
 List<InterestCenter> getICenters()
           
 int getIndexOfFirstItemToDisplay()
           
 int getIndexOfFirstResultToDisplay()
           
 List<String> getInstanceIdsFromComponentName(String componentName)
           
 Jargon getJargon()
           
 List<String> getListChoiceNbResToDisplay()
           
 String getLocation(String instanceId)
          Get location of result
 int getNbItemsPerPage()
           
 int getNbResToDisplay()
           
 Pdc getPdc()
           
 List<AxisHeader> getPrimaryAxis()
           
 QueryParameters getQueryParameters()
           
 ResultGroupFilter getResultGroupFilter()
          Build the list of result group filter from current global search result
 String getResultPage()
           
 String getResultPageId()
           
 List<GlobalSilverResult> getResultsToDisplay()
           
 SearchContext getSearchContext()
           
 List<String[]> getSearchDomains()
          Get the search domains available for search The search domains are contained in a Vector of array of 3 String (String[0]=domain name, String[1]=domain url page, String[2]=internal Id)
 String getSearchPage()
           
 String getSearchPageId()
           
 int getSearchScope()
           
 int getSearchType()
           
 List<SearchTypeConfigurationVO> getSearchTypeConfig()
          Retrieve configuration from properties file
 String getSecondaryAxis()
           
 ResultFilterVO getSelectedFacetEntries()
           
 List<GlobalSilverResult> getSelectedSilverContents()
           
 List<GlobalSilverResult> getSortedResultsToDisplay(int sortValue, String sortOrder, String xmlFormSortValue, String sortType, ResultFilterVO filter)
           
 String getSortImplemtor()
          Gets the keyword to retreive the implementation class name to realize sorting or filtering
 String getSortOrder()
           
 int getSortValue()
           
 String getSpaceLabel(String spaceId)
          Returns the label of the given domain/space
 List<String> getSpellingwords()
          gets suggestions or spelling words if a search doesn't return satisfying results.
 StatisticBm getStatisticBm()
           
 Map<String,Collection<String>> getSynonyms()
           
 int getTotalFilteredResults()
           
 int getTotalResults()
           
 String getUrl(String urlBase, MatchingIndexEntry indexEntry)
          ******************************************************************************************
 String getUrl(String urlBase, String componentId, String pageAndParams)
           
 List<Axis> getUsedAxisByAComponentInstance(String instanceId)
           
 List<AxisHeader> getUsedAxisHeaderByInstanceId(String instanceId)
           
 List<String> getUsedTreeIds(String instanceId)
           
 Value getValue(String axisId, String valueId)
           
 DataRecord getXmlData()
           
 String getXmlFormSortValue()
          Gets the XML form field used to realize sorting
 PublicationTemplateImpl getXmlTemplate()
           
 MatchingIndexEntry[] glossarySearch(String query)
           
 void initializeJargon()
           
 String initUserPanel()
          UserPanel methods / ****************************************************************************************************************
 boolean isDataTypeDefined()
           
 boolean isDataTypeSearch(String curComp)
          Add restriction on advanced search data type
 boolean isEnableExternalSearch()
           
 boolean isExportEnabled()
           
 boolean isMatchingIndexEntryAvailable(MatchingIndexEntry mie)
           
 boolean isPertinenceVisible()
           
 boolean isPlatformUsesPDC()
           
 boolean isRefreshEnabled()
           
 boolean isSelectionActivated()
           
 boolean isShowOnlyPertinentAxisAndValues()
           
 boolean isXmlSearchVisible()
           
 InterestCenter loadICenter(String icId)
           
 GlobalSilverResult matchingIndexEntry2GlobalSilverResult(MatchingIndexEntry matchingIndexEntry)
          Converts a MatchingIndexEntry to a GlobalSilverResult, mainly duplicate code from matchingIndexEntries2GlobalSilverResults, needs a Silverpeas Guru to refactor the two methods
 List<GlobalSilverResult> processResultsToDisplay(List<GlobalSilverContent> silverContents)
           
 List<GlobalSilverResult> processResultsToDisplay(MatchingIndexEntry[] indexEntries)
           
 void removeAllCriterias()
           
 SearchContext removeCriteriaFromSearchContext(SearchCriteria criteria)
           
 SearchContext removeCriteriaFromSearchContext(String axisId)
           
 void resetResultPage()
           
 void resetResultPageId()
           
 void resetSearchPage()
           
 void resetSearchPageId()
           
 int saveICenter(InterestCenter ic)
          Interest Center methods / ****************************************************************************************************************
 MatchingIndexEntry[] search()
           
 void setAxisResult(List<Value> result)
           
 void setContainerPeas(ContainerPeas containerGivenPeasPDC)
           
 void setContainerWorkspace(ContainerWorkspace givenContainerWorkspace)
           
 void setContentPeas(ContentPeas contentGivenPeasPDC)
           
 void setCurrentComponentIds(List<String> componentList)
           
 void setCurrentResultsDisplay(int currentResultsDisplay)
           
 void setCurrentResultsDisplay(String param)
           
 void setCurrentValue(Value value)
          search from DomainsBar methods / ****************************************************************************************************************
 void setDataType(String dataType)
           
 void setFilteredSR(List<GlobalSilverResult> filteredSR)
           
 void setIndexOfFirstItemToDisplay(String index)
           
 void setIndexOfFirstResultToDisplay(String index)
           
 void setNbResToDisplay(int nbResToDisplay)
           
 void setPDCResults(List<GlobalSilverContent> globalSilverContents)
          PDC search methods (via DomainsBar) /
 void setQueryParameters(QueryParameters query)
           
 void setResultPage(String resultPage)
           
 void setResultPageId(String resultPageId)
           
 void setResults(List<GlobalSilverContent> globalSilverResults)
          plain search methods / ****************************************************************************************************************
 void setSearchDomains()
          Set the search domains available for search The search domains are contained in a Vector of array of 3 String (String[0]=domain name, String[1]=domain url page, String[2]=internal Id)
 void setSearchPage(String searchPage)
           
 void setSearchPageId(String searchPageId)
           
 void setSearchScope(int i)
           
 void setSearchType(int i)
           
 void setSecondaryAxis(String secondAxis)
           
 void setSelectedFacetEntries(ResultFilterVO selectedFacetEntries)
           
 void setSelectedSilverContents(List<GlobalSilverResult> silverContents)
           
 void setSelectionActivated(boolean isSelectionActivated)
           
 void setShowOnlyPertinentAxisAndValues(boolean showOnlyPertinentAxisAndValues)
           
 void setSortImplemtor(String sortImplementor)
           
 void setSortOrder(String sortOrder)
           
 void setSortValue(int sortValue)
           
 void setXmlData(DataRecord xmlData)
           
 void setXmlFormSortValue(String xmlFormSortValue)
          Sets the XML form field used to realize sorting
 PublicationTemplateImpl setXmlTemplate(String fileName)
           
 boolean showAllAxisInGlossary()
           
 
Methods inherited from class com.stratelia.silverpeas.peasCore.AbstractComponentSessionController
addClipboardSelection, clipboardPasteDone, close, getAlertUser, getClipboardCount, getClipboardErrorMessage, getClipboardExceptionError, getClipboardName, getClipboardObjects, getClipboardSelectedObjects, getClipboardSize, getComponentAccessController, getComponentId, getComponentLabel, getComponentName, getComponentParameters, getComponentParameterValue, getComponentParameterValue, getComponentRootName, getComponentUrl, getFavoriteSpace, getGenericPanel, getHighestSilverpeasUserRole, getIcon, getLanguage, getLastResults, getLook, getMultilang, getOrganisationController, getPersonalization, getRSSUrl, getSelection, getServerNameAndPort, getSettings, getSilverpeasUserRoles, getSpaceId, getSpaceLabel, getString, getSubscriptionContext, getUrlEncodedParameter, getUserAccessLevel, getUserAvailComponentIds, getUserAvailSpaceIds, getUserDetail, getUserDetail, getUserId, getUserManageableGroupIds, getUserManageableSpaceIds, getUserRoleLevel, getUserRoles, isAppInMaintenance, isGroupManager, isPasswordChangeAllowed, isSpaceInMaintenance, removeClipboardElement, setAppModeMaintenance, setClipboardError, setClipboardSelectedElement, setComponentRootName, setFavoriteSpaceToMainSessionController, setGenericPanel, setIconFileName, setLastResults, setMultilangFileName, setResourceFileName, setSpaceModeMaintenance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALL_SPACES

public static final String ALL_SPACES
See Also:
Constant Field Values

ALL_COMPONENTS

public static final String ALL_COMPONENTS
See Also:
Constant Field Values

SORT_ORDER_ASC

public static final String SORT_ORDER_ASC
See Also:
Constant Field Values

SORT_ORDER_DESC

public static final String SORT_ORDER_DESC
See Also:
Constant Field Values

SEARCH_SIMPLE

public static final int SEARCH_SIMPLE
See Also:
Constant Field Values

SEARCH_ADVANCED

public static final int SEARCH_ADVANCED
See Also:
Constant Field Values

SEARCH_EXPERT

public static final int SEARCH_EXPERT
See Also:
Constant Field Values

SEARCH_XML

public static final int SEARCH_XML
See Also:
Constant Field Values

SEARCH_FULLTEXT

public static final int SEARCH_FULLTEXT
See Also:
Constant Field Values

SEARCH_PDC

public static final int SEARCH_PDC
See Also:
Constant Field Values

SEARCH_MIXED

public static final int SEARCH_MIXED
See Also:
Constant Field Values

SHOWRESULTS_ALL

public static final int SHOWRESULTS_ALL
See Also:
Constant Field Values

SHOWRESULTS_OnlyPDC

public static final int SHOWRESULTS_OnlyPDC
See Also:
Constant Field Values

ALL_DATA_TYPE

public static final String ALL_DATA_TYPE
See Also:
Constant Field Values
Constructor Detail

PdcSearchSessionController

public PdcSearchSessionController(MainSessionController mainSessionCtrl,
                                  ComponentContext componentContext,
                                  String multilangBundle,
                                  String iconBundle)
Method Detail

setContainerWorkspace

public void setContainerWorkspace(ContainerWorkspace givenContainerWorkspace)

getContainerWorkspace

public ContainerWorkspace getContainerWorkspace()

getContainerPosition

public ContainerPositionInterface getContainerPosition()

getSearchContext

public SearchContext getSearchContext()

setPDCResults

public void setPDCResults(List<GlobalSilverContent> globalSilverContents)
                   throws Exception
PDC search methods (via DomainsBar) /

Throws:
Exception - ****************************************************************************************************************

getNbItemsPerPage

public int getNbItemsPerPage()

getIndexOfFirstItemToDisplay

public int getIndexOfFirstItemToDisplay()

setIndexOfFirstItemToDisplay

public void setIndexOfFirstItemToDisplay(String index)

setResults

public void setResults(List<GlobalSilverContent> globalSilverResults)
plain search methods / ****************************************************************************************************************


getIndexOfFirstResultToDisplay

public int getIndexOfFirstResultToDisplay()

setIndexOfFirstResultToDisplay

public void setIndexOfFirstResultToDisplay(String index)

getDisplayParamChoices

public String getDisplayParamChoices()

getListChoiceNbResToDisplay

public List<String> getListChoiceNbResToDisplay()

getNbResToDisplay

public int getNbResToDisplay()

setNbResToDisplay

public void setNbResToDisplay(int nbResToDisplay)

getSortOrder

public String getSortOrder()

setSortOrder

public void setSortOrder(String sortOrder)

getSortValue

public int getSortValue()

setSortValue

public void setSortValue(int sortValue)

setQueryParameters

public void setQueryParameters(QueryParameters query)

getQueryParameters

public QueryParameters getQueryParameters()

clearQueryParameters

public void clearQueryParameters()

search

public MatchingIndexEntry[] search()
                            throws ParseException
Throws:
ParseException

isMatchingIndexEntryAvailable

public boolean isMatchingIndexEntryAvailable(MatchingIndexEntry mie)

getResultsToDisplay

public List<GlobalSilverResult> getResultsToDisplay()
                                             throws Exception
Throws:
Exception

getResultGroupFilter

public ResultGroupFilter getResultGroupFilter()
Build the list of result group filter from current global search result

Returns:
new ResultGroupFilter object which contains all data to filter result

getFieldFacets

public Map<String,Facet> getFieldFacets()

processResultsToDisplay

public List<GlobalSilverResult> processResultsToDisplay(MatchingIndexEntry[] indexEntries)
                                                 throws Exception
Throws:
Exception

processResultsToDisplay

public List<GlobalSilverResult> processResultsToDisplay(List<GlobalSilverContent> silverContents)
                                                 throws Exception
Throws:
Exception

getSortedResultsToDisplay

public List<GlobalSilverResult> getSortedResultsToDisplay(int sortValue,
                                                          String sortOrder,
                                                          String xmlFormSortValue,
                                                          String sortType,
                                                          ResultFilterVO filter)

getStatisticBm

public StatisticBm getStatisticBm()

getTotalResults

public int getTotalResults()

getTotalFilteredResults

public int getTotalFilteredResults()

getLocation

public String getLocation(String instanceId)
Get location of result

Parameters:
instanceId - - application id
Returns:
location as a String

matchingIndexEntry2GlobalSilverResult

public GlobalSilverResult matchingIndexEntry2GlobalSilverResult(MatchingIndexEntry matchingIndexEntry)
Converts a MatchingIndexEntry to a GlobalSilverResult, mainly duplicate code from matchingIndexEntries2GlobalSilverResults, needs a Silverpeas Guru to refactor the two methods

Parameters:
matchingIndexEntry -
Returns:
GlobalSilverResult or null if the MatchingIndexEntry was null
Throws:
Exception

setCurrentValue

public void setCurrentValue(Value value)
search from DomainsBar methods / ****************************************************************************************************************


getCurrentValue

public Value getCurrentValue()

getCurrentComponentId

public String getCurrentComponentId()
                             throws PdcException
Throws:
PdcException

isShowOnlyPertinentAxisAndValues

public boolean isShowOnlyPertinentAxisAndValues()

setShowOnlyPertinentAxisAndValues

public void setShowOnlyPertinentAxisAndValues(boolean showOnlyPertinentAxisAndValues)

setCurrentComponentIds

public void setCurrentComponentIds(List<String> componentList)

getCurrentComponentIds

public List<String> getCurrentComponentIds()

setSecondaryAxis

public void setSecondaryAxis(String secondAxis)

getSecondaryAxis

public String getSecondaryAxis()

getAllAxis

public List<AxisHeader> getAllAxis()
                            throws PdcException
Throws:
PdcException

getPrimaryAxis

public List<AxisHeader> getPrimaryAxis()
                                throws PdcException
Throws:
PdcException

getAxis

public List<SearchAxis> getAxis(String viewType)
                         throws PdcException
Throws:
PdcException

getAxis

public List<SearchAxis> getAxis(String viewType,
                                AxisFilter filter)
                         throws PdcException
Throws:
PdcException

getDaughterValues

public List<Value> getDaughterValues(String axisId,
                                     String valueId)
                              throws PdcException
Throws:
PdcException

getDaughterValues

public List<Value> getDaughterValues(String axisId,
                                     String valueId,
                                     AxisFilter filter)
                              throws PdcException
Throws:
PdcException

getFirstLevelAxisValues

public List<Value> getFirstLevelAxisValues(String axisId)
                                    throws PdcException
Throws:
PdcException

addCriteriaToSearchContext

public SearchContext addCriteriaToSearchContext(SearchCriteria criteria)

removeCriteriaFromSearchContext

public SearchContext removeCriteriaFromSearchContext(SearchCriteria criteria)

removeCriteriaFromSearchContext

public SearchContext removeCriteriaFromSearchContext(String axisId)

removeAllCriterias

public void removeAllCriterias()

getAxisDetail

public Axis getAxisDetail(String axisId)
                   throws PdcException
Throws:
PdcException

getAxisDetail

public Axis getAxisDetail(String axisId,
                          AxisFilter filter)
                   throws PdcException
Throws:
PdcException

getAxisHeader

public AxisHeader getAxisHeader(String axisId)
                         throws PdcException
Throws:
PdcException

getFullPath

public List<Value> getFullPath(String valueId,
                               String treeId)
                        throws PdcException
Throws:
PdcException

getAxisValue

public Value getAxisValue(String valueId,
                          String treeId)
                   throws PdcException
Throws:
PdcException

getValue

public Value getValue(String axisId,
                      String valueId)
               throws PdcException
Throws:
PdcException

setContainerPeas

public void setContainerPeas(ContainerPeas containerGivenPeasPDC)

getContainerPeas

public ContainerPeas getContainerPeas()

setContentPeas

public void setContentPeas(ContentPeas contentGivenPeasPDC)

getContentPeas

public ContentPeas getContentPeas()

getPdc

public Pdc getPdc()

setSelectionActivated

public void setSelectionActivated(boolean isSelectionActivated)

isSelectionActivated

public boolean isSelectionActivated()

setSelectedSilverContents

public void setSelectedSilverContents(List<GlobalSilverResult> silverContents)

getSelectedSilverContents

public List<GlobalSilverResult> getSelectedSilverContents()

getInstanceIdsFromComponentName

public List<String> getInstanceIdsFromComponentName(String componentName)

getActiveThesaurus

public boolean getActiveThesaurus()
                           throws PdcException
Throws:
PdcException

initializeJargon

public void initializeJargon()
                      throws PdcException
Throws:
PdcException

getJargon

public Jargon getJargon()

getSynonyms

public Map<String,Collection<String>> getSynonyms()

showAllAxisInGlossary

public boolean showAllAxisInGlossary()

glossarySearch

public MatchingIndexEntry[] glossarySearch(String query)
                                    throws PdcException
Throws:
PdcException

getAxisValuesByFilter

public List<Value> getAxisValuesByFilter(String filter_by_name,
                                         String filter_by_description,
                                         boolean search_in_daughters,
                                         String instanceId)
                                  throws PdcException
Throws:
PdcException

getUsedAxisHeaderByInstanceId

public List<AxisHeader> getUsedAxisHeaderByInstanceId(String instanceId)
                                               throws PdcException
Throws:
PdcException

getUsedTreeIds

public List<String> getUsedTreeIds(String instanceId)
                            throws PdcException
Throws:
PdcException

getAxisValueAndFullPath

public Value getAxisValueAndFullPath(String valueId,
                                     String treeId)
                              throws PdcException
Throws:
PdcException

getUsedAxisByAComponentInstance

public List<Axis> getUsedAxisByAComponentInstance(String instanceId)
                                           throws PdcException
Throws:
PdcException

setAxisResult

public void setAxisResult(List<Value> result)

getAxisResult

public List<Value> getAxisResult()

saveICenter

public int saveICenter(InterestCenter ic)
                throws PdcException
Interest Center methods / ****************************************************************************************************************

Throws:
PdcException

getICenters

public List<InterestCenter> getICenters()

loadICenter

public InterestCenter loadICenter(String icId)
                           throws PdcException
Throws:
PdcException

initUserPanel

public String initUserPanel()
                     throws RemoteException
UserPanel methods / ****************************************************************************************************************

Throws:
RemoteException

buildComponentListWhereToSearch

public void buildComponentListWhereToSearch(String space,
                                            String component)
******************************************************************************************


buildCustomComponentListWhereToSearch

public void buildCustomComponentListWhereToSearch(String space,
                                                  List<String> components)
This method allow user to search over multiple component selection

Parameters:
space -
components - a list of selected components

getAllowedSpaces

public List<SpaceInstLight> getAllowedSpaces()
Returns the list of allowed spaces/domains for the current user.


getAllowedComponents

public List<ComponentInstLight> getAllowedComponents(String space)
Returns the list of allowed components for the current user in the given space/domain.


getSpaceLabel

public String getSpaceLabel(String spaceId)
Returns the label of the given domain/space


getComponentLabel

public String getComponentLabel(String spaceId,
                                String componentId)
Returns the label of the given component


getSearchDomains

public List<String[]> getSearchDomains()
Get the search domains available for search The search domains are contained in a Vector of array of 3 String (String[0]=domain name, String[1]=domain url page, String[2]=internal Id)


setSearchDomains

public void setSearchDomains()
Set the search domains available for search The search domains are contained in a Vector of array of 3 String (String[0]=domain name, String[1]=domain url page, String[2]=internal Id)


getUrl

public String getUrl(String urlBase,
                     MatchingIndexEntry indexEntry)
******************************************************************************************


getUrl

public String getUrl(String urlBase,
                     String componentId,
                     String pageAndParams)

isExportEnabled

public boolean isExportEnabled()
Returns:
true if export is enabled

getSearchType

public int getSearchType()
Returns:
type of search (Simple, Advanced or Expert)

setSearchType

public void setSearchType(int i)
Parameters:
i - - type of the current search

getSearchScope

public int getSearchScope()
Returns:

setSearchScope

public void setSearchScope(int i)
Parameters:
i -

isRefreshEnabled

public boolean isRefreshEnabled()

isXmlSearchVisible

public boolean isXmlSearchVisible()

isPertinenceVisible

public boolean isPertinenceVisible()

getXmlTemplate

public PublicationTemplateImpl getXmlTemplate()

setXmlTemplate

public PublicationTemplateImpl setXmlTemplate(String fileName)
                                       throws PdcPeasRuntimeException
Throws:
PdcPeasRuntimeException

clearXmlTemplateAndData

public void clearXmlTemplateAndData()

getXmlData

public DataRecord getXmlData()

setXmlData

public void setXmlData(DataRecord xmlData)

getSearchPage

public String getSearchPage()

setSearchPage

public void setSearchPage(String searchPage)

resetSearchPage

public void resetSearchPage()

getSearchPageId

public String getSearchPageId()

setSearchPageId

public void setSearchPageId(String searchPageId)

resetSearchPageId

public void resetSearchPageId()

getResultPage

public String getResultPage()

setResultPage

public void setResultPage(String resultPage)

resetResultPage

public void resetResultPage()

getResultPageId

public String getResultPageId()

setResultPageId

public void setResultPageId(String resultPageId)

resetResultPageId

public void resetResultPageId()

getSpellingwords

public List<String> getSpellingwords()
gets suggestions or spelling words if a search doesn't return satisfying results. A minimal score trigger the suggestions search (0.5 by default)

Returns:
array that contains suggestions.

getGlobalSR

public List<GlobalSilverResult> getGlobalSR()
Returns:
the list of current global silver result

setFilteredSR

public void setFilteredSR(List<GlobalSilverResult> filteredSR)

getFilteredSR

public List<GlobalSilverResult> getFilteredSR()

clearFilteredSR

public void clearFilteredSR()

getCurrentResultsDisplay

public int getCurrentResultsDisplay()

setCurrentResultsDisplay

public void setCurrentResultsDisplay(String param)

setCurrentResultsDisplay

public void setCurrentResultsDisplay(int currentResultsDisplay)

getXmlFormSortValue

public String getXmlFormSortValue()
Gets the XML form field used to realize sorting

Returns:
the xmlFormSortValue

setXmlFormSortValue

public void setXmlFormSortValue(String xmlFormSortValue)
Sets the XML form field used to realize sorting

Parameters:
xmlFormSortValue - the xmlFormSortValue to set

getSortImplemtor

public String getSortImplemtor()
Gets the keyword to retreive the implementation class name to realize sorting or filtering

Returns:
the sortImplemtor

setSortImplemtor

public void setSortImplemtor(String sortImplementor)
Parameters:
sortImplementor - the sortImplementor to set

isEnableExternalSearch

public boolean isEnableExternalSearch()
Returns:
the isEnableExternalSearch attribute

getSearchTypeConfig

public List<SearchTypeConfigurationVO> getSearchTypeConfig()
Retrieve configuration from properties file

Returns:
a list of search type configuration value object

getDataType

public String getDataType()
Returns:
the dataType search

setDataType

public void setDataType(String dataType)
Parameters:
dataType - the dataType search to set

isDataTypeDefined

public boolean isDataTypeDefined()

isDataTypeSearch

public boolean isDataTypeSearch(String curComp)
Add restriction on advanced search data type

Parameters:
curComp - the current component identifier
Returns:
true if search engine must search through this component, false else if

setSelectedFacetEntries

public void setSelectedFacetEntries(ResultFilterVO selectedFacetEntries)

getSelectedFacetEntries

public ResultFilterVO getSelectedFacetEntries()

isPlatformUsesPDC

public boolean isPlatformUsesPDC()


Copyright © 2016 Silverpeas. All Rights Reserved.