atg.search.query.filters
Class SampleRepositoryItemCollectionFilter

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.service.collections.filter.CachedCollectionFilter
              atg.search.query.filters.RepositoryItemResultCollectionFilter
                  atg.search.query.filters.SampleRepositoryItemCollectionFilter

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class SampleRepositoryItemCollectionFilter
extends RepositoryItemResultCollectionFilter

A sample RepositoryItemResultCollectionFilter which rejects any search Result object which does not refer to a valid repository item.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.service.collections.filter.CachedCollectionFilter

FILTER_CACHE_COMPONENT, mCache, mCacheEnabled

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

SampleRepositoryItemCollectionFilter()

Method Summary

protected boolean

accept(Result pResult, RepositoryItem pUserProfile) Filter that rejects any search result that does not refer to a repository item

Methods inherited from class atg.search.query.filters.RepositoryItemResultCollectionFilter

generateContextKey, generateFilteredCollection, getInitialContextPool, getRepositoryItem, setInitialContextPool, shouldApplyFilter

Methods inherited from class atg.service.collections.filter.CachedCollectionFilter

dumpCache, filterCollection, filterCollection, flushCache, generateCacheKey, generateNewCollectionObject, getCache, getDefaultProfile, isCacheEnabled, setCache, setCacheEnabled, stringIt

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

SampleRepositoryItemCollectionFilter

public SampleRepositoryItemCollectionFilter()

Method Detail

accept

protected boolean accept(Result pResult,
                         RepositoryItem pUserProfile)
                  throws atg.service.collections.filter.FilterException

Filter that rejects any search result that does not refer to a repository item

Specified by:

accept in class RepositoryItemResultCollectionFilter

Parameters:

pResult - a search result object

pRepositoryItem - the associated repository item or null if the search result object does not refer to a repository item

Returns:

true to accept this item, false otherwise

Throws:

atg.service.collections.filter.FilterException