com.endeca.infront.assembler
Interface ContentItem

All Superinterfaces:

Map<String,Object>

All Known Implementing Classes:

BasicContentItem, Breadcrumbs, BreadcrumbsConfig, ContentInclude, ContentSlotConfig, ContentSlotListConfig, DimensionSearchResults, DimensionSearchResultsConfig, MediaBanner, MediaBannerConfig, NavigationContainer, NavigationContainerConfig, RecordDetails, RecordDetailsConfig, RecordSpotlight, RecordSpotlightConfig, RedirectAwareContentInclude, RefinementMenu, RefinementMenuConfig, RequestEvent, ResultsList, ResultsListConfig, SearchAdjustments, SearchAdjustmentsConfig

public interface ContentItem
extends Map<String,Object>

The interface that defines the data object (model) in the assembly process.

The ContentItem interface provides a Map view into the model and provides an accessor for the content item type. The content item type corresponds to the Experience Manager cartridge type (same as "template ID"). The type can also be accessed via the Map interface using the key, "@type". The type is used by the assembler to determine which configured cartridge handler should be used to process the content item.

A ContentItem may be nested in one of two ways.

1. A ContentItem may be added directly to another ContentItem as a value in the Map.
2. A ContentItem may be contained in a List that is added directly to another ContentItem as a value of the Map.

Endeca implementations represent data in one of the following categories:

1. XML document
2. Cartridge configuration model
3. Cartridge output model

See the implementing classes for more details.

Since the ContentItem is a Map, additional properties can be modified and added through the Map interface. This is especially useful for augmenting output data models without having to create another class. However, when removing, modifying or adding properties to Endeca implementations of ContentItem, care should be taken to not to use keys that start with the "@" character or any key that matches a bean property name.

ContentItem makes no guarantees about thread-safety.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

String

getType()

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

getType

String getType()

Returns:

the Experience Manager cartridge type (same as the 'template ID').