atg.commerce.csr.catalog.endeca

Class ContentItemResultsDroplet

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.nucleus.TimedOperationService

atg.nucleus.servlet.ServletService

atg.nucleus.servlet.HttpServletService

atg.servlet.DynamoServlet

atg.droplet.ForEach

atg.commerce.csr.catalog.endeca.ContentItemResultsDroplet

All Implemented Interfaces:

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

public class ContentItemResultsDroplet
extends atg.droplet.ForEach

This droplet is used to iterate over a Collection of objects referenced by a ContentItem and provide the rendering PageFragment for each object in the collection.

PageFragments are mapped by type. There is also a default PageFragment for cases where the type is not known or the type is not mapped to a specific PageFragment.

There is a PageFragment Map and default PageFragment configuratio for both Endeca records and repository items. The RepositoryItem type is determined by its repository type. Record type is determined from a property on the record itself. That property name is configurable using recordTypePropertyName. A type property is not required to be on the Endeca record. If all records are homogenous(i.e. without a type), only one renderer (the default) is necessary.

The ContentItem property containing the Collection is specified by content item type using the collectionPropertyName Map.

See Also:

Configuration

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	CONTENT_ITEM The input param name used for providing a ContentItem
protected Configuration	mConfiguration
static java.lang.String	OBJECT_TYPE The output parameter name for returning the class type for the object in the Collection
static java.lang.String	RECORD_OBJECTTYPE
static java.lang.String	RENDERING_PAGE_FRAGMENT The output parameter name for returning the PageFragment for rendering the object in the collection
static java.lang.String	REPOSITORYITEM_OBJECTTYPE

Fields inherited from class atg.droplet.ForEach

ARRAY, COUNT, DEBUG, ELEMENT, ELEMENT_NAME, EMPTY, INDEX, INDEX_NAME, KEY, OUTPUT, OUTPUT_END, OUTPUT_START, REVERSE_ORDER, SIZE, SORT_PROPERTIES

Fields inherited from class atg.servlet.DynamoServlet

mAllowCleanupRequest, mParameters

Fields inherited from class atg.nucleus.servlet.ServletService

SERVLET_INFO_KEY

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

Constructors

Constructor and Description
ContentItemResultsDroplet()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getArray(atg.servlet.DynamoHttpServletRequest pRequest) Returns the collection property from the content item
protected java.util.Collection	getCollection(com.endeca.infront.assembler.ContentItem pContentItem, atg.servlet.DynamoHttpServletRequest pRequest) Called to return the Collection on the given ContentItem based on the configured property name.
Configuration	getConfiguration() Returns the main configuration component that contains the configurable values used by this droplet to identify the collection and page fragments for each content item.
protected atg.web.PageFragment	getPageFragment(java.lang.Object pObjectInCollection, atg.servlet.DynamoHttpServletRequest pRequest) Returns the appropriate rendering page fragment for the given object in the collection.
void	setConfiguration(Configuration pConfiguration)
protected void	setElementParameter(atg.servlet.DynamoHttpServletRequest pRequest, java.lang.String pElementName, java.lang.Object pValue) Sets the rendering page fragment output parameter before calling super.
protected void	setObjectTypeParameter(atg.servlet.DynamoHttpServletRequest pRequest, java.lang.Object pObjectValue) Sets the object type output parameter value based on the given object value.

Methods inherited from class atg.droplet.ForEach

getSortedArray, service, serviceArray, serviceCollection, serviceDictionary, serviceEnumeration, serviceIndexedList, serviceIterator, serviceMap, serviceMapArray, servicePrimitiveArray

Methods inherited from class atg.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, setServletInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

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

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

CONTENT_ITEM

public static final java.lang.String CONTENT_ITEM

The input param name used for providing a ContentItem

See Also:

Constant Field Values

RENDERING_PAGE_FRAGMENT

public static final java.lang.String RENDERING_PAGE_FRAGMENT

The output parameter name for returning the PageFragment for rendering the object in the collection

See Also:

Constant Field Values

OBJECT_TYPE

public static final java.lang.String OBJECT_TYPE

The output parameter name for returning the class type for the object in the Collection

See Also:

Constant Field Values

REPOSITORYITEM_OBJECTTYPE

public static final java.lang.String REPOSITORYITEM_OBJECTTYPE

See Also:

Constant Field Values

RECORD_OBJECTTYPE

public static final java.lang.String RECORD_OBJECTTYPE

See Also:

Constant Field Values

mConfiguration

protected Configuration mConfiguration

Constructor Detail

ContentItemResultsDroplet

public ContentItemResultsDroplet()

Method Detail

getConfiguration

public Configuration getConfiguration()

Returns the main configuration component that contains the configurable values used by this droplet to identify the collection and page fragments for each content item.

Returns:

setConfiguration

public void setConfiguration(Configuration pConfiguration)

getCollection

protected java.util.Collection getCollection(com.endeca.infront.assembler.ContentItem pContentItem,
                                             atg.servlet.DynamoHttpServletRequest pRequest)

Called to return the Collection on the given ContentItem based on the configured property name.

Parameters:

pContentItem -

pRequest -

Returns:

Collection

See Also:

Configuration.getCollectionPropertyNames()

getPageFragment

protected atg.web.PageFragment getPageFragment(java.lang.Object pObjectInCollection,
                                               atg.servlet.DynamoHttpServletRequest pRequest)

Returns the appropriate rendering page fragment for the given object in the collection.

Parameters:

pObjectInCollection -

pRequest -

Returns:

PageFragment

See Also:

Configuration.getObjectRenderingPageFragmentsByType(), Configuration.getDefaultObjectRenderingPageFragment()

getArray

public java.lang.Object getArray(atg.servlet.DynamoHttpServletRequest pRequest)

Returns the collection property from the content item

Overrides:

getArray in class atg.droplet.ForEach

setElementParameter

protected void setElementParameter(atg.servlet.DynamoHttpServletRequest pRequest,
                                   java.lang.String pElementName,
                                   java.lang.Object pValue)

Sets the rendering page fragment output parameter before calling super.

Overrides:

setElementParameter in class atg.droplet.ForEach

setObjectTypeParameter

protected void setObjectTypeParameter(atg.servlet.DynamoHttpServletRequest pRequest,
                                      java.lang.Object pObjectValue)

Sets the object type output parameter value based on the given object value. \

By default, this implementation will return "RepositoryItem" or "Record" depending on the instance type of pObjectValue.

Parameters:

pRequest -

pObjectValue -