Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.sapportals.wcm.service.indexmanagement.retrieval.search

Class AbstractSearchIndexCollection

java.lang.Object
  extended byjava.util.AbstractCollection
      extended bycom.sapportals.wcm.service.indexmanagement.AbstractIndexCollection
          extended bycom.sapportals.wcm.service.indexmanagement.retrieval.search.AbstractSearchIndexCollection
All Implemented Interfaces:
Collection, ISearchIndexCollection
public abstract class AbstractSearchIndexCollection
extends AbstractIndexCollection
implements ISearchIndexCollection

Collection of search indexes to perform search and other retrieval operations on them.

Nested Class Summary
 class AbstractSearchIndexCollection.PropertyInput
           
 
Field Summary
 
Fields inherited from class com.sapportals.wcm.service.indexmanagement.AbstractIndexCollection
m_indexes
 
Fields inherited from interface com.sapportals.wcm.service.indexmanagement.retrieval.search.ISearchIndexCollection
DEFAULT_INIT_MAX_RAW_RESULTS
 
Constructor Summary
AbstractSearchIndexCollection(Collection indexes)
           
 
Method Summary
protected  IProperty createInitialProperty(IPropertyName propName)
          Creates a property with initial value for a property name.
static ISearchResult createNewSearchResultObject(IResource resource, float rankValue)
          Creates a new search result object containing the resource and rank values of the parameters.
protected  ISearchResult createSearchResultObject(IResource resource, float rankValue)
          Gets a search result object initialized with the given resource and rank value.
abstract  ISearchResultList executeQuery(IQueryEntryList queryEntryList, IResourceContext context, int maxResults)
          Executes the search
abstract  ISearchResultList executeQuery(IQueryEntryList queryEntryList, IResourceContext context, int maxResults, ICollection searchFromHere)
          Executes the search
abstract  ISearchResultList executeQuery(IQueryEntryList queryEntryList, IResourceContext context, int maxResults, ICollection searchFromHere, Set languages)
          Executes the search
abstract  ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context)
          Executes the search
abstract  ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, ICollection searchFromHere)
          Executes the search
abstract  ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults)
          Executes the search
abstract  ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults, ICollection searchFromHere)
          Executes the search
abstract  ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults, ICollection searchFromHere, ISortPropertyName sortProperty)
          Executes the search
 ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults, ICollection searchFromHere, ISortPropertyName sortProperty, Set languages)
          Executes the search
 ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults, IRidList searchFromHereList, ISortPropertyName sortProperty, Set languages)
          Executes the search
 int getMaxSnippetWords()
          Sets the number of snippet words returned for documents in a search.
 IQueryEntry getNewQueryEntry()
           
 IQueryEntryList getNewQueryEntryList()
           
protected  ISearchSession getNewSearchSession(IQueryEntryList queryEntries, IRidList searchFromHereList, ISearchIndexCollection searchIndexCollection, IResourceContext context, int initMaxRawResults, ISortPropertyName sortProperty)
          Gets a new search session instance
protected  ISearchSession getNewSearchSession(IResourceList similarDocsInput, ISearchIndexCollection searchIndexCollection, IResourceContext context, int initMaxRawResults, ISortPropertyName sortProperty)
          Gets a new search session instance
 IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context)
          Returns basic information about the distribution of the properties of the indexes, of the SearchIndexCollection only considering the documents fullfilling the search restriction.
 IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, Collection indexList)
          Returns basic information about the distribution of the properties of the indexes, only considering the documents fullfilling the search restriction.
 IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, ISearchIndex index)
          Returns basic information about the distribution of the properties of an index, only considering the documents fullfilling the search restriction.
 IPropertyRangeList getPropertyRanges(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context)
          Returns the ranges of the properties of the indexes of the ISearchIndexCollection, only considering the documents fullfilling the search restriction.
 IPropertyRangeList getPropertyRanges(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, Collection indexList)
          Returns the ranges of the properties of the indexes, only considering the documents fullfilling the search restriction.
 IPropertyRangeList getPropertyRanges(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, ISearchIndex index)
          Returns the ranges of the properties of an index, only considering the documents fullfilling the search restriction.
protected  PropertyType getPropertyType(IPropertyName propName)
          Determines the property type using the property config service.
 Collection getPropertyValues(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context)
          Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified property, only considering the documents fullfilling the search restriction.
 Collection getPropertyValues(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, Collection indexes)
          Returns the distinct property values of the indexes for the specified property, only considering the documents fullfilling the search restriction.
 Collection getPropertyValues(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, ISearchIndex index)
          Returns the distinct property values of an index, only considering the documents fullfilling the search restriction.
 String getQueryAsString()
          Returns the momentary query as a string, ready to be saved as a .properties file
abstract  ISearchResultList getSearchResults(List rawSearchResults, IResourceContext context)
           
 void loadQuery(Properties props)
          Deprecated. as of NW04.
abstract  ISearchResultList searchSimilarDocuments(IResourceList searchDocuments, int maxResults)
          searches similar documents
abstract  ISearchSession searchSimilarDocumentsWithSession(IResourceList searchDocuments)
          searches similar documents
abstract  ISearchSession searchSimilarDocumentsWithSession(IResourceList searchDocuments, int initNumberMaxRawResults)
          searches similar documents
abstract  Collection searchSimilarTerms(Collection terms, int maxTerms)
          searches similar terms to a collection of terms
 void setMaxSnippetWords(int numOfWords)
          Sets the number of snippet words returned for documents in a search.
 
Methods inherited from class com.sapportals.wcm.service.indexmanagement.AbstractIndexCollection
addIndex, getIndex, iterator, size
 
Methods inherited from class java.util.AbstractCollection
add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.sapportals.wcm.service.indexmanagement.retrieval.search.ISearchIndexCollection
addIndex, searchSimilarDocumentsWithSession
 
Methods inherited from interface java.util.Collection
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
 

Constructor Detail

AbstractSearchIndexCollection

public AbstractSearchIndexCollection(Collection indexes)
Method Detail

executeQuery

public abstract ISearchResultList executeQuery(IQueryEntryList queryEntryList,
                                               IResourceContext context,
                                               int maxResults)
                                        throws WcmException
Description copied from interface: ISearchIndexCollection
Executes the search

Specified by:
executeQuery in interface ISearchIndexCollection
Parameters:
queryEntryList - - list of query entries for the search
context - - user context
maxResults - - maximum number of search results
Returns:
search result list with the found documents
Throws:
WcmException

executeQuery

public abstract ISearchResultList executeQuery(IQueryEntryList queryEntryList,
                                               IResourceContext context,
                                               int maxResults,
                                               ICollection searchFromHere)
                                        throws WcmException
Description copied from interface: ISearchIndexCollection
Executes the search

Specified by:
executeQuery in interface ISearchIndexCollection
Parameters:
queryEntryList - - list of query entries for the search
context - - user context
maxResults - - maximum number of search results
searchFromHere - - folder from where search results must be direct or indirect children
Returns:
search result list with the found documents
Throws:
WcmException

executeQuery

public abstract ISearchResultList executeQuery(IQueryEntryList queryEntryList,
                                               IResourceContext context,
                                               int maxResults,
                                               ICollection searchFromHere,
                                               Set languages)
                                        throws WcmException
Description copied from interface: ISearchIndexCollection
Executes the search

Specified by:
executeQuery in interface ISearchIndexCollection
Parameters:
queryEntryList - - list of query entries for the search
context - - user context
maxResults - - maximum number of search results
searchFromHere - - folder from where search results must be direct or indirect children
languages - - set of strings, representing languages on which the search is restricted
Returns:
search result list with the found documents
Throws:
WcmException

executeQueryWithSession

public abstract ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                                       IResourceContext context)
                                                throws WcmException
Description copied from interface: ISearchIndexCollection
Executes the search

Specified by:
executeQueryWithSession in interface ISearchIndexCollection
Parameters:
queryEntryList - - list of query entries for the search
context - - user context
Returns:
search session result
Throws:
WcmException

executeQueryWithSession

public abstract ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                                       IResourceContext context,
                                                       ICollection searchFromHere)
                                                throws WcmException
Description copied from interface: ISearchIndexCollection
Executes the search

Specified by:
executeQueryWithSession in interface ISearchIndexCollection
Parameters:
queryEntryList - - list of query entries for the search
context - - user context
searchFromHere - - folder from where search results must be direct or indirect children
Returns:
search session result
Throws:
WcmException

executeQueryWithSession

public abstract ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                                       IResourceContext context,
                                                       int initNumberMaxRawResults)
                                                throws WcmException
Description copied from interface: ISearchIndexCollection
Executes the search

Specified by:
executeQueryWithSession in interface ISearchIndexCollection
Parameters:
queryEntryList - - list of query entries for the search
context - - user context
Returns:
search session result
Throws:
WcmException

executeQueryWithSession

public abstract ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                                       IResourceContext context,
                                                       int initNumberMaxRawResults,
                                                       ICollection searchFromHere)
                                                throws WcmException
Description copied from interface: ISearchIndexCollection
Executes the search

Specified by:
executeQueryWithSession in interface ISearchIndexCollection
Parameters:
queryEntryList - - list of query entries for the search
context - - user context
initNumberMaxRawResults - initial maximum number of raw results. The number is increased automatically when the result session requests more raw results.
searchFromHere - - folder from where search results must be direct or indirect children
Returns:
search session result
Throws:
WcmException

executeQueryWithSession

public abstract ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                                       IResourceContext context,
                                                       int initNumberMaxRawResults,
                                                       ICollection searchFromHere,
                                                       ISortPropertyName sortProperty)
                                                throws WcmException
Description copied from interface: ISearchIndexCollection
Executes the search

Specified by:
executeQueryWithSession in interface ISearchIndexCollection
Parameters:
queryEntryList - - list of query entries for the search
context - - user context
initNumberMaxRawResults - initial maximum number of raw results. The number is increased automatically when the result session requests more raw results.
searchFromHere - - folder from where search results must be direct or indirect children
sortProperty - property name for sorting the results
Returns:
search session result
Throws:
WcmException

executeQueryWithSession

public ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                              IResourceContext context,
                                              int initNumberMaxRawResults,
                                              ICollection searchFromHere,
                                              ISortPropertyName sortProperty,
                                              Set languages)
                                       throws WcmException
Description copied from interface: ISearchIndexCollection
Executes the search

Specified by:
executeQueryWithSession in interface ISearchIndexCollection
Parameters:
queryEntryList - - list of query entries for the search
context - - user context
initNumberMaxRawResults - initial maximum number of raw results. The number is increased automatically when the result session requests more raw results.
searchFromHere - - folder from where search results must be direct or indirect children
languages - - restricts the search on the languages contained (as strings)
sortProperty - property name for sorting the results
Returns:
search session result
Throws:
WcmException

executeQueryWithSession

public ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                              IResourceContext context,
                                              int initNumberMaxRawResults,
                                              IRidList searchFromHereList,
                                              ISortPropertyName sortProperty,
                                              Set languages)
                                       throws WcmException
Description copied from interface: ISearchIndexCollection
Executes the search

Specified by:
executeQueryWithSession in interface ISearchIndexCollection
Parameters:
queryEntryList - - list of query entries for the search
context - - user context
initNumberMaxRawResults - initial maximum number of raw results. The number is increased automatically when the result session requests more raw results.
searchFromHereList - - folder with ICollections from where search results must be a direct or indirect children
languages - - restricts the search on the languages contained (as strings)
sortProperty - property name for sorting the results
Returns:
search session result
Throws:
WcmException

searchSimilarDocuments

public abstract ISearchResultList searchSimilarDocuments(IResourceList searchDocuments,
                                                         int maxResults)
                                                  throws WcmException
Description copied from interface: ISearchIndexCollection
searches similar documents

Specified by:
searchSimilarDocuments in interface ISearchIndexCollection
Parameters:
searchDocuments - - list of documents for that similar documents have to be found
maxResults - - maximum number of similar documents
Returns:
search result list with the found similar documents
Throws:
WcmException

searchSimilarDocumentsWithSession

public abstract ISearchSession searchSimilarDocumentsWithSession(IResourceList searchDocuments)
                                                          throws WcmException
Description copied from interface: ISearchIndexCollection
searches similar documents

Specified by:
searchSimilarDocumentsWithSession in interface ISearchIndexCollection
Parameters:
searchDocuments - - list of documents for that similar documents have to be found
Returns:
search session result
Throws:
WcmException

searchSimilarDocumentsWithSession

public abstract ISearchSession searchSimilarDocumentsWithSession(IResourceList searchDocuments,
                                                                 int initNumberMaxRawResults)
                                                          throws WcmException
Description copied from interface: ISearchIndexCollection
searches similar documents

Specified by:
searchSimilarDocumentsWithSession in interface ISearchIndexCollection
Parameters:
searchDocuments - - list of documents for that similar documents have to be found
initNumberMaxRawResults - initial maximum number of raw results. The number is increased automatically when the result session requests more raw results.
Returns:
search session result
Throws:
WcmException

searchSimilarTerms

public abstract Collection searchSimilarTerms(Collection terms,
                                              int maxTerms)
                                       throws WcmException
Description copied from interface: ISearchIndexCollection
searches similar terms to a collection of terms

Specified by:
searchSimilarTerms in interface ISearchIndexCollection
Parameters:
terms - Collection of terms (Strings)
maxTerms - - maximum number of returned similar terms
Returns:
Collection of ITextminingTerm
Throws:
WcmException

setMaxSnippetWords

public void setMaxSnippetWords(int numOfWords)
Sets the number of snippet words returned for documents in a search. If not set, a default value is used.

Specified by:
setMaxSnippetWords in interface ISearchIndexCollection
Parameters:
numOfWords -

getMaxSnippetWords

public int getMaxSnippetWords()
Sets the number of snippet words returned for documents in a search.

Specified by:
getMaxSnippetWords in interface ISearchIndexCollection
Returns:
number of snippt et words

getQueryAsString

public String getQueryAsString()
                        throws WcmException
Deprecated. as of NW04.

Description copied from interface: ISearchIndexCollection
Returns the momentary query as a string, ready to be saved as a .properties file

Specified by:
getQueryAsString in interface ISearchIndexCollection
Throws:
WcmException

loadQuery

public void loadQuery(Properties props)
               throws WcmException
Deprecated. as of NW04.

Fills the collection of queryEntries, sortAttrs, indexes, to and from with data read from a file or database input format is java.util.Properties. For information on structure please refer to the String-Export of method getQueryAsString();

Specified by:
loadQuery in interface ISearchIndexCollection
Throws:
WcmException

getNewQueryEntry

public IQueryEntry getNewQueryEntry()
Specified by:
getNewQueryEntry in interface ISearchIndexCollection
Returns:
a new, empty query entry object

getNewQueryEntryList

public IQueryEntryList getNewQueryEntryList()
Specified by:
getNewQueryEntryList in interface ISearchIndexCollection
Returns:
a new, empty query entry list object

getSearchResults

public abstract ISearchResultList getSearchResults(List rawSearchResults,
                                                   IResourceContext context)
                                            throws ResourceException
Specified by:
getSearchResults in interface ISearchIndexCollection
Parameters:
rawSearchResults - list of IRawSearchResult
Returns:
list of search results
Throws:
ResourceException

getPropertyDistributionOverview

public IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList,
                                                                 ICollection searchFromHere,
                                                                 IResourceContext context,
                                                                 ISearchIndex index)
                                                          throws WcmException
Description copied from interface: ISearchIndexCollection
Returns basic information about the distribution of the properties of an index, only considering the documents fullfilling the search restriction.

Specified by:
getPropertyDistributionOverview in interface ISearchIndexCollection
Parameters:
queryEntryList - restricts the considered documents to those fullfilling this expression
searchFromHere - restricts the considered documents to those located under this collection
context - resource context, not used to filter the result applying the access rights to the documents.
Returns:
list of search results
Throws:
WcmException
See Also:
ISearchIndexCollection

getPropertyDistributionOverview

public IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList,
                                                                 ICollection searchFromHere,
                                                                 IResourceContext context,
                                                                 Collection indexList)
                                                          throws WcmException
Description copied from interface: ISearchIndexCollection
Returns basic information about the distribution of the properties of the indexes, only considering the documents fullfilling the search restriction.

Specified by:
getPropertyDistributionOverview in interface ISearchIndexCollection
Parameters:
queryEntryList - restricts the considered documents to those fullfilling this expression
searchFromHere - restricts the considered documents to those located under this collection
context - resource context, not used to filter the result applying the access rights to the documents.
indexList - list of ISearchIndex of one type, e.g. AbstractTrexSearchIndex
Returns:
list of search results
Throws:
WcmException
See Also:
ISearchIndexCollection

getPropertyDistributionOverview

public IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList,
                                                                 ICollection searchFromHere,
                                                                 IResourceContext context)
                                                          throws WcmException
Description copied from interface: ISearchIndexCollection
Returns basic information about the distribution of the properties of the indexes, of the SearchIndexCollection only considering the documents fullfilling the search restriction.

Specified by:
getPropertyDistributionOverview in interface ISearchIndexCollection
Parameters:
queryEntryList - restricts the considered documents to those fullfilling this expression
searchFromHere - restricts the considered documents to those located under this collection
context - resource context, not used to filter the result applying the access rights to the documents.
Throws:
WcmException
See Also:
ISearchIndexCollection

getPropertyRanges

public IPropertyRangeList getPropertyRanges(IPropertyName propertyName,
                                            IQueryEntryList queryEntryList,
                                            ICollection searchFromHere,
                                            IResourceContext context,
                                            ISearchIndex index)
                                     throws WcmException
Description copied from interface: ISearchIndexCollection
Returns the ranges of the properties of an index, only considering the documents fullfilling the search restriction.

Specified by:
getPropertyRanges in interface ISearchIndexCollection
Parameters:
propertyName - the property for which the ranges are extracted
queryEntryList - restricts the considered documents to those fullfilling this expression
searchFromHere - restricts the considered documents to those located under this collection
context - resource context, not used to filter the result applying the access rights to the documents.
index -
Returns:
list of search results
Throws:
WcmException - in case of an error
See Also:
ISearchIndexCollection

getPropertyRanges

public IPropertyRangeList getPropertyRanges(IPropertyName propertyName,
                                            IQueryEntryList queryEntryList,
                                            ICollection searchFromHere,
                                            IResourceContext context,
                                            Collection indexList)
                                     throws WcmException
Description copied from interface: ISearchIndexCollection
Returns the ranges of the properties of the indexes, only considering the documents fullfilling the search restriction.

Specified by:
getPropertyRanges in interface ISearchIndexCollection
Parameters:
propertyName - the property for which the ranges are extracted
queryEntryList - restricts the considered documents to those fullfilling this expression
searchFromHere - restricts the considered documents to those located under this collection
context - resource context, not used to filter the result applying the access rights to the documents.
indexList -
Returns:
list of search results
Throws:
WcmException - in case of an error
See Also:
ISearchIndexCollection

getPropertyRanges

public IPropertyRangeList getPropertyRanges(IPropertyName propertyName,
                                            IQueryEntryList queryEntryList,
                                            ICollection searchFromHere,
                                            IResourceContext context)
                                     throws WcmException
Description copied from interface: ISearchIndexCollection
Returns the ranges of the properties of the indexes of the ISearchIndexCollection, only considering the documents fullfilling the search restriction.

Specified by:
getPropertyRanges in interface ISearchIndexCollection
Parameters:
propertyName - the property for which the ranges are extracted
queryEntryList - restricts the considered documents to those fullfilling this expression
searchFromHere - restricts the considered documents to those located under this collection
context - resource context, not used to filter the result applying the access rights to the documents.
Returns:
list of search results
Throws:
WcmException - in case of an error
See Also:
ISearchIndexCollection

getPropertyValues

public Collection getPropertyValues(IPropertyName propertyName,
                                    IQueryEntryList queryEntryList,
                                    ICollection searchFromHere,
                                    IResourceContext context,
                                    ISearchIndex index)
                             throws WcmException
Description copied from interface: ISearchIndexCollection
Returns the distinct property values of an index, only considering the documents fullfilling the search restriction.

Specified by:
getPropertyValues in interface ISearchIndexCollection
Parameters:
propertyName - the property for which the values are extracted
queryEntryList - restricts the considered documents to those fullfilling this expression
searchFromHere - restricts the considered documents to those located under this collection
context - resource context, not used to filter the result applying the access rights to the documents.
index -
Returns:
list of IProperty objects
Throws:
WcmException - in case of an error
See Also:
ISearchIndexCollection

getPropertyValues

public Collection getPropertyValues(IPropertyName propertyName,
                                    IQueryEntryList queryEntryList,
                                    ICollection searchFromHere,
                                    IResourceContext context,
                                    Collection indexes)
                             throws WcmException
Description copied from interface: ISearchIndexCollection
Returns the distinct property values of the indexes for the specified property, only considering the documents fullfilling the search restriction.

Specified by:
getPropertyValues in interface ISearchIndexCollection
Parameters:
propertyName - the property for which the values are extracted
queryEntryList - restricts the considered documents to those fullfilling this expression
searchFromHere - restricts the considered documents to those located under this collection
context - resource context, not used to filter the result applying the access rights to the documents.
indexes -
Returns:
list of IProperty objects
Throws:
WcmException - in case of an error
See Also:
ISearchIndexCollection

getPropertyValues

public Collection getPropertyValues(IPropertyName propertyName,
                                    IQueryEntryList queryEntryList,
                                    ICollection searchFromHere,
                                    IResourceContext context)
                             throws WcmException
Description copied from interface: ISearchIndexCollection
Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified property, only considering the documents fullfilling the search restriction.

Specified by:
getPropertyValues in interface ISearchIndexCollection
Parameters:
propertyName - the property for which the values are extracted
queryEntryList - restricts the considered documents to those fullfilling this expression
searchFromHere - restricts the considered documents to those located under this collection
context - resource context, not used to filter the result applying the access rights to the documents.
Returns:
list of IProperty objects
Throws:
WcmException - in case of an error
See Also:
ISearchIndexCollection

getNewSearchSession

protected ISearchSession getNewSearchSession(IQueryEntryList queryEntries,
                                             IRidList searchFromHereList,
                                             ISearchIndexCollection searchIndexCollection,
                                             IResourceContext context,
                                             int initMaxRawResults,
                                             ISortPropertyName sortProperty)
                                      throws WcmException
Gets a new search session instance

Parameters:
queryEntries - the query entry list of the query
searchIndexCollection - the search index collection to address for researching
context - the user context
initMaxRawResults - initial maximum number of raw results
sortProperty - property name for sorting the results
Returns:
the search session instance
Throws:
WcmException

createSearchResultObject

protected ISearchResult createSearchResultObject(IResource resource,
                                                 float rankValue)
                                          throws WcmException
Gets a search result object initialized with the given resource and rank value.

Parameters:
resource - search result resource
rankValue -
Throws:
WcmException

createNewSearchResultObject

public static ISearchResult createNewSearchResultObject(IResource resource,
                                                        float rankValue)
                                                 throws WcmException
Creates a new search result object containing the resource and rank values of the parameters.

Parameters:
resource - contained in the search result
rankValue - contained in the search result
Returns:
search result object
Throws:
WcmException - in case of a failure

getNewSearchSession

protected ISearchSession getNewSearchSession(IResourceList similarDocsInput,
                                             ISearchIndexCollection searchIndexCollection,
                                             IResourceContext context,
                                             int initMaxRawResults,
                                             ISortPropertyName sortProperty)
                                      throws WcmException
Gets a new search session instance

Parameters:
similarDocsInput - the basis for similar document search
searchIndexCollection - the search index collection to address for researching
context - the user context
initMaxRawResults - initial maximum number of raw results
sortProperty - property name for sorting the results
Returns:
the search session instance
Throws:
WcmException

createInitialProperty

protected IProperty createInitialProperty(IPropertyName propName)
                                   throws ResourceException
Creates a property with initial value for a property name.

Parameters:
propName - name of the property
Returns:
property with initial value
Throws:
ResourceException

getPropertyType

protected PropertyType getPropertyType(IPropertyName propName)
                                throws ResourceException
Determines the property type using the property config service. If a ISortPropertyName is used as parameter and no meta model is available for the property the property type of the sort property name is used.

Parameters:
propName - name of the property
Returns:
determined property type
Throws:
ResourceException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. 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.