com.sapportals.wcm.service.indexmanagement.retrieval.search
Class AbstractSearchIndexCollection

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

java.lang.Object
  |
  +--java.util.AbstractCollection
        |
        +--com.sapportals.wcm.service.indexmanagement.AbstractIndexCollection
              |
              +--com.sapportals.wcm.service.indexmanagement.retrieval.search.AbstractSearchIndexCollection

All Implemented Interfaces:

java.util.Collection, ISearchIndexCollection

public abstract class AbstractSearchIndexCollection

extends AbstractIndexCollection

implements ISearchIndexCollection

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

Inner Class Summary

class

AbstractSearchIndexCollection.PropertyInput

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(java.util.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, java.util.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, java.util.Set languages) Executes the search
ISearchSession	executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults, IRidList searchFromHereList, ISortPropertyName sortProperty, java.util.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, java.util.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, java.util.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.
java.util.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.
java.util.Collection	getPropertyValues(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, java.util.Collection indexes) Returns the distinct property values of the indexes for the specified property, only considering the documents fullfilling the search restriction.
java.util.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.
java.lang.String	getQueryAsString() Returns the momentary query as a string, ready to be saved as a .properties file
abstract ISearchResultList	getSearchResults(java.util.List rawSearchResults, IResourceContext context)
void	loadQuery(java.util.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 java.util.Collection	searchSimilarTerms(java.util.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(java.util.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

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.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

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

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.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

executeQuery

public abstract ISearchResultList executeQuery(IQueryEntryList queryEntryList,
                                               IResourceContext context,
                                               int maxResults,
                                               ICollection searchFromHere,
                                               java.util.Set languages)
                                        throws WcmException

Description copied from interface: ISearchIndexCollection

Executes the search

Specified by:

executeQuery in interface ISearchIndexCollection

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.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

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

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.ISearchIndexCollection

Parameters:

queryEntryList - - list of query entries for the search

context - - user context

Returns:

search session result

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

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.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

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

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.ISearchIndexCollection

Parameters:

queryEntryList - - list of query entries for the search

context - - user context

initNumberResults - initial maximum number of raw results. The number is increased automatically when the result session requests more raw results.

Returns:

search session result

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

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.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

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

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.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

executeQueryWithSession

public ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                              IResourceContext context,
                                              int initNumberMaxRawResults,
                                              ICollection searchFromHere,
                                              ISortPropertyName sortProperty,
                                              java.util.Set languages)
                                       throws WcmException

Description copied from interface: ISearchIndexCollection

Executes the search

Specified by:

executeQueryWithSession in interface ISearchIndexCollection

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.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

executeQueryWithSession

public ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                              IResourceContext context,
                                              int initNumberMaxRawResults,
                                              IRidList searchFromHereList,
                                              ISortPropertyName sortProperty,
                                              java.util.Set languages)
                                       throws WcmException

Description copied from interface: ISearchIndexCollection

Executes the search

Specified by:

executeQueryWithSession in interface ISearchIndexCollection

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.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

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

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.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

searchSimilarDocumentsWithSession

public abstract ISearchSession searchSimilarDocumentsWithSession(IResourceList searchDocuments)
                                                          throws WcmException

Description copied from interface: ISearchIndexCollection

searches similar documents

Specified by:

searchSimilarDocumentsWithSession in interface ISearchIndexCollection

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.ISearchIndexCollection

Parameters:

searchDocuments - - list of documents for that similar documents have to be found

Returns:

search session result

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

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.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

searchSimilarTerms

public abstract java.util.Collection searchSimilarTerms(java.util.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

Following copied from interface: com.sapportals.wcm.service.indexmanagement.retrieval.search.ISearchIndexCollection

Parameters:

terms - Collection of terms (Strings)

maxTerms - - maximum number of returned similar terms

Returns:

Collection of ITextminingTerm

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 java.lang.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

loadQuery

public void loadQuery(java.util.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

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(java.util.List rawSearchResults,
                                                   IResourceContext context)
                                            throws ResourceException

Specified by:

getSearchResults in interface ISearchIndexCollection

Parameters:

rawSearchResults - list of IRawSearchResult

Returns:

list of search results

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

See Also:

ISearchIndexCollection

getPropertyDistributionOverview

public IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList,
                                                                 ICollection searchFromHere,
                                                                 IResourceContext context,
                                                                 java.util.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

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

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

See Also:

ISearchIndexCollection

getPropertyRanges

public IPropertyRangeList getPropertyRanges(IPropertyName propertyName,
                                            IQueryEntryList queryEntryList,
                                            ICollection searchFromHere,
                                            IResourceContext context,
                                            java.util.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

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

See Also:

ISearchIndexCollection

getPropertyValues

public java.util.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

See Also:

ISearchIndexCollection

getPropertyValues

public java.util.Collection getPropertyValues(IPropertyName propertyName,
                                              IQueryEntryList queryEntryList,
                                              ICollection searchFromHere,
                                              IResourceContext context,
                                              java.util.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

See Also:

ISearchIndexCollection

getPropertyValues

public java.util.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

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

searchFromHere - collection to search from here (can be null)

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

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 -

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

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

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