com.sapportals.wcm.service.indexmanagement.retrieval.classification
Interface IQBClassificationIndex

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

public interface IQBClassificationIndex

This kind of classification index offers functionality working with query based taxonomies

Method Summary

void	deleteQueryFolderExternal(IQueryFolder queryFolder) Deletes a query folder on the external classification engine
IRidList	getAffectedCategories(IQueryFolder queryFolder, IResourceContext context) Gets a list of categories of a taxonomy that are affected if the query of the query folder has changed.
ISearchResultList	getQueryDocuments(IQueryFolder queryFolder, IResourceContext context) Documents of the index that match the query of the folder.
ISearchSession	getQueryDocumentsPreview(IQueryFolder queryFolder, IResourceContext context) Deprecated. as of NW04. Do not use
IQueryFolder	getQueryFolder(RID taxonomyClassRid) Gets a query folder instance
void	moveQueryFolderExternal(IQueryFolder queryFolder, RID destination) Moves the query folder on the external classification engine
void	setQueryFolderExternal(IQueryFolder queryFolder, IQueryEntryList query) Sets the query on the external classification engine.
void	setQueryFolderExternalFast(IQueryFolder queryFolder, IQueryEntryList query) Sets the query on the external classification engine.
void	updateCategoryContents(java.lang.String taxonomyName, boolean dirtyOnly, IResourceContext context) Starts a process that checks and updates categories of a taxonomy where the query is not in sync with the documents of category.

Method Detail

getQueryFolder

public IQueryFolder getQueryFolder(RID taxonomyClassRid)
                            throws WcmException

Gets a query folder instance

Parameters:

taxonomyClassRid - rid of the taxonomy class that is the query folder

Returns:

the query folder instance

deleteQueryFolderExternal

public void deleteQueryFolderExternal(IQueryFolder queryFolder)
                               throws WcmException

Deletes a query folder on the external classification engine

Parameters:

queryFolder - query folder to delete

setQueryFolderExternal

public void setQueryFolderExternal(IQueryFolder queryFolder,
                                   IQueryEntryList query)
                            throws WcmException

Sets the query on the external classification engine. If the query folder doesn't exist on the external engine it is also created

Parameters:

queryFolder - the query folder to set

query - the new query for the folder

setQueryFolderExternalFast

public void setQueryFolderExternalFast(IQueryFolder queryFolder,
                                       IQueryEntryList query)
                                throws WcmException

Sets the query on the external classification engine. If the query folder doesn't exist on the external engine it is also created. This is a faster version for Trex than setQueryFolderExternal.

Parameters:

queryFolder - the query folder to set

query - the new query for the folder

moveQueryFolderExternal

public void moveQueryFolderExternal(IQueryFolder queryFolder,
                                    RID destination)
                             throws WcmException

Moves the query folder on the external classification engine

Parameters:

queryFolder - the query folder to move

destination - the new rid of the query folder

updateCategoryContents

public void updateCategoryContents(java.lang.String taxonomyName,
                                   boolean dirtyOnly,
                                   IResourceContext context)
                            throws WcmException

Starts a process that checks and updates categories of a taxonomy where the query is not in sync with the documents of category.

Parameters:

taxonomyName - name of the taxonomy to check

dirtyOnly - if false all categories are checked, if false only categories that are out of sync (dirty) are updated.

context - user context

Throws:

IndexNotReadyException - if not all documents of the classification index can be updated because some documents are still beiing processed on the index server.

getQueryDocuments

public ISearchResultList getQueryDocuments(IQueryFolder queryFolder,
                                           IResourceContext context)
                                    throws WcmException

Documents of the index that match the query of the folder.
Since the queries are hierarchical the returned documents also match the queries of the parent folders.

Parameters:

queryFolder - query folder for that the document have to be returned

context - user context

Returns:

list of documents with their rank values that match the query of the folder.

getQueryDocumentsPreview

public ISearchSession getQueryDocumentsPreview(IQueryFolder queryFolder,
                                               IResourceContext context)
                                        throws WcmException

Deprecated. as of NW04. Do not use

Documents of the index that match the query of the folder.
Since the queries are hierarchical the returned documents also match the queries of the parent folders. The call should only be used to get a preview of the query result.

Parameters:

queryFolder - query folder for that the document have to be returned

context - user context

Returns:

search session object including document IDs with their rank values that match the query of the folder.

getAffectedCategories

public IRidList getAffectedCategories(IQueryFolder queryFolder,
                                      IResourceContext context)
                               throws WcmException

Gets a list of categories of a taxonomy that are affected if the query of the query folder has changed.

Parameters:

queryFolder - query folder that has changed

context - user context

Returns:

list of resource IDs of categories that have changed after the query has been changed