atg.endeca.assembler.navigation.filter

Class SiteFilterBuilder

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.endeca.assembler.navigation.filter.RecordFilterBuilderImpl

atg.endeca.assembler.navigation.filter.SiteFilterBuilder

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, RecordFilterBuilder, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class SiteFilterBuilder
extends RecordFilterBuilderImpl

Builds a record filter that filters by site.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_SITES_SCOPE All Sites Search Scope
static java.lang.String	ANY_SITE_SCOPE Any Site Search Scope
protected static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	CURRENT_SITE_SCOPE Current Site Search Scope
static java.lang.String	NONE_SITE_SCOPE None Site Search Scope

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.endeca.assembler.navigation.filter.RecordFilterBuilder

EMPTY_FILTER

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

Constructors

Constructor and Description
SiteFilterBuilder()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	buildCurrentSiteFilter() Returns record filter for the current site
protected java.lang.String	buildExcludeSitesFilter(java.lang.String[] pSiteIds) Allow only items not from the given sites
java.lang.String	buildRecordFilter() Generates the record filter to filter the query based on the sites.
java.lang.String[]	determineSharableSiteIds(java.lang.String pScope)
java.lang.String[]	determineSiteIds()
java.lang.String[]	filterSiteList(java.lang.String[] pSites) Filters the site array used in generateSiteFilter().
java.lang.String[]	getAllSites() Returns Ids of all sites from SiteManager
Site	getCurrentSite()
protected static java.lang.String[]	getRepositoryIds(RepositoryItem[] pRepositoryItems) Utility method to get repository item ids
SiteGroupManager	getSiteGroupManager() Gets the SiteGroupManager
java.lang.String[]	getSiteIds() Gets an array of site IDs to filter the search by.
SiteManager	getSiteManager() Gets the SiteManager
java.lang.String	getSitePropertyName() Returns the name of site ID property in Endeca records.
java.lang.String	getSiteScope() Gets the search's site scope.
boolean	isIncludeDisabledSites() Returns the mIncludeDisabledSites property.
boolean	isIncludeInactiveSites() Whether or not the site filter should include inactive sites.
void	setIncludeDisabledSites(boolean pIncludeDisabledSites) Sets the mIncludeDisabledSites property.
void	setIncludeInactiveSites(boolean pIncludeInactiveSites) Sets whether or not the site filter should include inactive sites.
void	setSiteGroupManager(SiteGroupManager pSiteGroupManager) Sets the SiteGroupManager
void	setSiteIds(java.lang.String[] pSiteIds) Sets the array of site IDs to filter the search by.
void	setSiteManager(SiteManager pSiteManager)
void	setSitePropertyName(java.lang.String pSitePropertyName) Sets then name of site ID property in Endeca records.
void	setSiteScope(java.lang.String pSiteScope) Sets the search's site scope.

Methods inherited from class atg.endeca.assembler.navigation.filter.RecordFilterBuilderImpl

isSecurityFilter, setSecurityFilter

Methods inherited from class atg.nucleus.GenericService

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

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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, wait, wait, wait

Field Detail

CLASS_VERSION

protected static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

CURRENT_SITE_SCOPE

public static final java.lang.String CURRENT_SITE_SCOPE

Current Site Search Scope

See Also:

Constant Field Values

ALL_SITES_SCOPE

public static final java.lang.String ALL_SITES_SCOPE

All Sites Search Scope

See Also:

Constant Field Values

ANY_SITE_SCOPE

public static final java.lang.String ANY_SITE_SCOPE

Any Site Search Scope

See Also:

Constant Field Values

NONE_SITE_SCOPE

public static final java.lang.String NONE_SITE_SCOPE

None Site Search Scope

See Also:

Constant Field Values

Constructor Detail

SiteFilterBuilder

public SiteFilterBuilder()

Method Detail

getCurrentSite

public Site getCurrentSite()

Returns:

the currentSite

getSiteManager

public SiteManager getSiteManager()

Gets the SiteManager

Returns:

the siteManager

setSiteManager

public void setSiteManager(SiteManager pSiteManager)

Parameters:

pSiteManager - the siteManager to set

getSiteGroupManager

public SiteGroupManager getSiteGroupManager()

Gets the SiteGroupManager

Returns:

the siteGroupManager

setSiteGroupManager

public void setSiteGroupManager(SiteGroupManager pSiteGroupManager)

Sets the SiteGroupManager

Parameters:

pSiteGroupManager - the siteGroupManager to set

getSiteIds

public java.lang.String[] getSiteIds()

Gets an array of site IDs to filter the search by.

Returns:

the sites

setSiteIds

public void setSiteIds(java.lang.String[] pSiteIds)

Sets the array of site IDs to filter the search by.

Parameters:

pSiteIds - the site IDs to set

getSiteScope

public java.lang.String getSiteScope()

Gets the search's site scope. Null defaults to current. This property is ignored if the siteIds property is set. If the value isn't "current" or "all", the searchScope will be interpreted as a ShareableType ID.

Returns:

the siteScope

setSiteScope

public void setSiteScope(java.lang.String pSiteScope)

Sets the search's site scope. Null defaults to current. This property is ignored if the siteIds property is set. If the value isn't "current" or "all", the searchScope will be interpreted as a ShareableType ID.

Parameters:

pSiteScope - the siteScope to set

getSitePropertyName

public java.lang.String getSitePropertyName()

Returns the name of site ID property in Endeca records.

Returns:

the sitePropertyName site id property name

setSitePropertyName

public void setSitePropertyName(java.lang.String pSitePropertyName)

Sets then name of site ID property in Endeca records.

Parameters:

pSitePropertyName - the sitePropertyName to set

isIncludeInactiveSites

public boolean isIncludeInactiveSites()

Whether or not the site filter should include inactive sites.

Returns:

if includeInactiveSites is false, only active sites should be used, true otherwise.

setIncludeInactiveSites

public void setIncludeInactiveSites(boolean pIncludeInactiveSites)

Sets whether or not the site filter should include inactive sites.

Parameters:

pIncludeInactiveSites - the includeInactiveSites to set

isIncludeDisabledSites

public boolean isIncludeDisabledSites()

Returns the mIncludeDisabledSites property.

Returns:

the mIncludeDisabledSites property.

setIncludeDisabledSites

public void setIncludeDisabledSites(boolean pIncludeDisabledSites)

Sets the mIncludeDisabledSites property.

Parameters:

pIncludeDisabledSites - whether or not to include disabled sites in the matching process

determineSiteIds

public java.lang.String[] determineSiteIds()

determineSharableSiteIds

public java.lang.String[] determineSharableSiteIds(java.lang.String pScope)

buildRecordFilter

public java.lang.String buildRecordFilter()

Generates the record filter to filter the query based on the sites. Uses the siteIds property as a list of sites. If siteIds is null, siteScope is used. If siteScope is null or "current", filter for current site will be returned. If siteScope is "all", the filter will be set to use ALL sites. If siteScope is any, the filter will be set to ANY. If siteScope is "none", the filter will be set to NONE. All other values of siteScope will be used as a ShareableType id. The list of sites sharing that id will be used to filter the query. If no sites are found sharing that ShareableType id with the current site, the query will be filtered to use ANY site. If includeInactiveSites is false, the site list will be filtered to only contain active sites. This filtering will occur if the sites property is used or if the siteScope is "any" or a shareable id.

Returns:

the record filter string.

filterSiteList

public java.lang.String[] filterSiteList(java.lang.String[] pSites)

Filters the site array used in generateSiteFilter(). This method is called when the sites property is set or a ShareableType id is used to get a list of sites. If includeInactiveSites is false, all inactive sites will be removed from the list. Also, if includeInactiveSites is false, this method will be called for a scope of ANY.

Parameters:

pSites - The array of site ids

Returns:

The filtered site id array

getAllSites

public java.lang.String[] getAllSites()

Returns Ids of all sites from SiteManager

buildCurrentSiteFilter

protected java.lang.String buildCurrentSiteFilter()

Returns record filter for the current site

Returns:

current site record filter

buildExcludeSitesFilter

protected java.lang.String buildExcludeSitesFilter(java.lang.String[] pSiteIds)

Allow only items not from the given sites

Parameters:

pSiteIds - site ids array

Returns:

Endeca filter for items not from the given sites

getRepositoryIds

protected static java.lang.String[] getRepositoryIds(RepositoryItem[] pRepositoryItems)

Utility method to get repository item ids

Parameters:

pRepositoryItems - repository items to extract ids from

Returns:

array of repository item ids