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

Class DefaultQueryExtender

java.lang.Object
  com.sapportals.wcm.service.indexmanagement.retrieval.search.DefaultQueryExtender

Direct Known Subclasses:

TestQueryExtender

public class DefaultQueryExtender
extends Object

Basic class to extend the query of particular indexes by implementing a subclass of this class.
Changes between major releases 7.0 and 7.X

• Added methods: buildAdditionalQuery(IQueryEntryList, IRidList, IResourceContext) indexSecurity() provideProperties(IResource)

Constructor Summary

DefaultQueryExtender()

DefaultQueryExtender(AbstractIndex index)
has to be implemented the following way public TestQueryExtender(AbstractIndex index){ super(index); }

Method Summary

IQueryEntryList	buildAdditionalQuery(IQueryEntryList qList, IResourceContext context) Return the query which is added to the search for the index
IQueryEntryList	buildAdditionalQuery(IQueryEntryList qList, com.sapportals.wcm.util.uri.IRidList searchFromHereList, IResourceContext context) Return the query which is added to the search for the index
AbstractIndex	getIndex() Returns the index.
boolean	indexSecurity() Has to be overwritten and should return true if the query extender rely on ACL infos.
IPropertyMap	provideProperties(IResource resource) Provides additional properties which might be indexed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultQueryExtender

public DefaultQueryExtender()

DefaultQueryExtender

public DefaultQueryExtender(AbstractIndex index)

has to be implemented the following way public TestQueryExtender(AbstractIndex index){ super(index); }

Parameters:

index -

Method Detail

buildAdditionalQuery

public IQueryEntryList buildAdditionalQuery(IQueryEntryList qList,
                                            IResourceContext context)
                                     throws com.sapportals.wcm.WcmException

Return the query which is added to the search for the index

Parameters:

qList - the stabdart query list, which will be extended.

context -

Returns:

Throws:

ResourceException

com.sapportals.wcm.WcmException

buildAdditionalQuery

public IQueryEntryList buildAdditionalQuery(IQueryEntryList qList,
                                            com.sapportals.wcm.util.uri.IRidList searchFromHereList,
                                            IResourceContext context)
                                     throws com.sapportals.wcm.WcmException

Return the query which is added to the search for the index

Parameters:

qList - the stabdart query list, which will be extended.

searchFromHereList - specified for the search

context -

Returns:

Throws:

com.sapportals.wcm.WcmException

provideProperties

public IPropertyMap provideProperties(IResource resource)
                               throws com.sapportals.wcm.WcmException

Provides additional properties which might be indexed.

Parameters:

resource -

Returns:

Throws:

com.sapportals.wcm.WcmException

getIndex

public AbstractIndex getIndex()

Returns the index.

Returns:

indexSecurity

public boolean indexSecurity()

Has to be overwritten and should return true if the query extender rely on ACL infos. If true is returned the crawler also recodnizes changes of the ACLs during an incremental update.

Returns:

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM