SAP NetWeaver '04

com.sapportals.wcm.service.indexmanagement.retrieval.search
Interface IExtendedSearchIndex

[contained in: com.sap.km.cm.service.par - km.shared.service.indexmanagement_api.jar]
public interface IExtendedSearchIndex

Extended interface for additional search and retrieval operations.


Method Summary
 java.util.Collection getDocumentAbstracts(ISearchResultList searchResults)
          gets the abstract of documents
 java.util.Collection getHighlightedContent(ISearchResultList searchResults, IQueryEntryList queryList)
          gets the hightlighted content of resources with respect to the queryList
 java.util.Collection getHighlightedSummary(ISearchResultList searchResults, IQueryEntryList queryList, int maxNumberOfWords)
          Returns a summary for all input documents.
 

Method Detail

getDocumentAbstracts

public java.util.Collection getDocumentAbstracts(ISearchResultList searchResults)
                                          throws WcmException
gets the abstract of documents
Parameters:
searchResults - search result list with resources for that abstracts have to be returned
Returns:
Collection of ITextminingResult

getHighlightedContent

public java.util.Collection getHighlightedContent(ISearchResultList searchResults,
                                                  IQueryEntryList queryList)
                                           throws WcmException
gets the hightlighted content of resources with respect to the queryList
Parameters:
searchResults - search result list with resources for which content have to be returned
queryList - the queries to be highlighted
Returns:
Collection of ITextminingResult

getHighlightedSummary

public java.util.Collection getHighlightedSummary(ISearchResultList searchResults,
                                                  IQueryEntryList queryList,
                                                  int maxNumberOfWords)
                                           throws WcmException
Returns a summary for all input documents. The summary is returned in a collection of ITextminingResult. Each of these elements contains the content in HTML format with words specified in the input query list highlighted.
Parameters:
searchResults - input search results
queryList - specifies the words which should be highlighted
maxNumberOfWords - maximum number of words in the summary
Returns:
Collection of ITextminingResult
Throws:
WcmException - Exception raised in failure situation

SAP NetWeaver '04

Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.