com.ibm.commerce.catalog.facade.server.services.search.metadata

Class SearchCatalogNavigationViewSEOTitleMetaDataFilter

java.lang.Object

com.ibm.commerce.foundation.server.services.search.metadata.AbstractSearchResultFilter

com.ibm.commerce.catalog.facade.server.services.search.metadata.SearchCatalogEntryViewDescriptionResultFilter

com.ibm.commerce.catalog.facade.server.services.search.metadata.SearchCatalogNavigationViewSEOTitleMetaDataFilter

All Implemented Interfaces:

SearchResultFilter

public class SearchCatalogNavigationViewSEOTitleMetaDataFilter
extends SearchCatalogEntryViewDescriptionResultFilter
implements SearchResultFilter

This command populate the tile,meta description, meta keyword and alternate image description for catalog entry and catalog group in the CatalogNavigationView noun. The catalog entry title and meta description fields will be populated only if the catalog entry Id is present in the request or search criteria. The catalog group title and meta description fields will be populated only if the catalog group Id is present in the request or search criteria.

SearchCatalogEntryViewDescriptionResultFilter should be run before running this filter. If eSite has overridden the description / product Keyword, then SearchCatalogEntryViewDescriptionResultFilter will set the overridden data in the CatalogNavigationView noun. To make sure that SEO Filter gets access to right data ( either from Asset store or from eSite store) SearchCatalogEntryViewDescriptionResultFilter should be run before running this filter. Hence SearchCatalogNavigationViewSEOTitleMetaDataFilter extends from SearchCatalogEntryViewDescriptionResultFilter

• The information is retrieved based on the SEOPAGEDEF & SEOPAGEDEFDESC tables
• The information is stored under Title,MetaDescription, MetaKeyword and FullImageAltdescription in the CatalogNavigationView noun

Constructor Summary

Constructors

Constructor and Description
SearchCatalogNavigationViewSEOTitleMetaDataFilter()

Method Summary

Modifier and Type	Method and Description
void	filter(SelectionCriteria selectionCriteria, commonj.sdo.DataObject dataObject) The filter method is used to populate catalog entry override fields for an eSite store
java.util.List	getLanguageList(SelectionCriteria selectionCriteria) This method will get the list of languages which are specified in the control languages of the selection criteria.
java.util.Map	getTitleAndMetaDescription(java.lang.String objectId, java.lang.String objectType, java.lang.String storeId, java.util.List languageList, java.lang.String parentObjectId) This method will get the Title and meta description defined for the given object id and language.

Methods inherited from class com.ibm.commerce.foundation.server.services.search.metadata.AbstractSearchResultFilter

getControlParameterValue, getControlParameterValues

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchCatalogNavigationViewSEOTitleMetaDataFilter

public SearchCatalogNavigationViewSEOTitleMetaDataFilter()

Method Detail

filter

public void filter(SelectionCriteria selectionCriteria,
                   commonj.sdo.DataObject dataObject)
            throws java.lang.RuntimeException

Description copied from class: SearchCatalogEntryViewDescriptionResultFilter

The filter method is used to populate catalog entry override fields for an eSite store

Specified by:

filter in interface SearchResultFilter

Overrides:

filter in class SearchCatalogEntryViewDescriptionResultFilter

Parameters:

selectionCriteria - The search expression object represents.

dataObject - The object passed to filter.

Throws:

java.lang.RuntimeException - Could be thrown if any error occurred.

getLanguageList

public java.util.List getLanguageList(SelectionCriteria selectionCriteria)

This method will get the list of languages which are specified in the control languages of the selection criteria. If nothing is specified in the control languages then it will get the list of languages from the global context.

Parameters:

selectionCriteria - The search expression object represents the information that can be extracted from the Expression elements of the Get verb.

Returns:

List of languages.

getTitleAndMetaDescription

public java.util.Map getTitleAndMetaDescription(java.lang.String objectId,
                                                java.lang.String objectType,
                                                java.lang.String storeId,
                                                java.util.List languageList,
                                                java.lang.String parentObjectId)

This method will get the Title and meta description defined for the given object id and language.

Parameters:

objectId - The catalog entry identifier or the catalog group identifier.

objectType - The catalog entry type or the catalog group type.

storeId - The store identifier.

languageList - The language list.

parentObjectId - The parent catalog entry identifier or the parent catalog group identifier

Returns:

Result the map which contains the title and meta description for the given object identifier.