Package de.hybris.platform.cms2.servicelayer.daos.impl

Class DefaultCMSComponentDao

java.lang.Object

de.hybris.platform.servicelayer.internal.dao.AbstractItemDao

de.hybris.platform.cms2.servicelayer.daos.impl.AbstractCMSItemDao

de.hybris.platform.cms2.servicelayer.daos.impl.DefaultCMSComponentDao

All Implemented Interfaces:

CMSComponentDao, Dao

Direct Known Subclasses:

DefaultMarketplaceCMSComponentDao

public class DefaultCMSComponentDao
extends AbstractCMSItemDao
implements CMSComponentDao

Default implementation of CMSComponentDao interface.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CATALOG_VERSIONS_QUERY_PARAM
protected static final String	QUERY_ALIAS

Fields inherited from class de.hybris.platform.servicelayer.internal.dao.AbstractItemDao

flexibleSearchService, modelService

Constructor Summary

Constructors

Constructor	Description
DefaultCMSComponentDao()

Method Summary

Modifier and Type	Method	Description
List<AbstractCMSComponentModel>	findAllCMSComponentsByCatalogVersion(CatalogVersionModel catalogVersion)	Find cms components that belong to a given catalog version.
<T extends AbstractCMSComponentModel> SearchPageData<T>	findAllCMSComponentsByCatalogVersions(Collection<CatalogVersionModel> catalogVersions, SearchPageData searchPageData)	Find cms components that belong to a given catalog version.
SearchResult<AbstractCMSComponentModel>	findByCatalogVersionAndMask(CatalogVersionModel catalogVersionModel, String mask, PageableData pageableData)	For a given mask used as filter and a PageableData query, will return a page object consisting of the content list of the requested page number and the total number of entities for the given mask
List<AbstractCMSComponentContainerModel>	findCMSComponentContainersByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion)	Find cms component containers by id and catalog version.
List<AbstractCMSComponentModel>	findCMSComponents(String id, String contentSlotId, Collection<CatalogVersionModel> catalogVersions)	Find cms components by id, contentSlotId and catalog versions.
List<AbstractCMSComponentModel>	findCMSComponentsById(String id)	Find cms components by id.
List<AbstractCMSComponentModel>	findCMSComponentsByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion)	Find cms components by id and catalog version.
List<AbstractCMSComponentModel>	findCMSComponentsByIdAndCatalogVersions(String id, Collection<CatalogVersionModel> catalogVersions)	Find cms components by id and catalog versions.
<T extends AbstractCMSComponentModel> SearchPageData<T>	findCMSComponentsByIdsAndCatalogVersions(Collection<String> ids, Collection<CatalogVersionModel> catalogVersions, SearchPageData searchPageDataInput)	Find cms components by list of IDs and catalog versions with pagination and sorting.
List<SimpleCMSComponentModel>	findCMSComponentsOfContainerByIdAndCatalogVersion(String id, CatalogVersionModel catalogVersion)	Find cms components of container by id and catalog version.
long	getComponentReferenceCountOutsidePage(AbstractCMSComponentModel componentModel, AbstractPageModel pageModel)	Finds the number of times the given component is used outside a given page (e.g., other pages or shared slots).
protected PaginatedFlexibleSearchService	getPaginatedFlexibleSearchService()
void	setPaginatedFlexibleSearchService(PaginatedFlexibleSearchService paginatedFlexibleSearchService)

Methods inherited from class de.hybris.platform.cms2.servicelayer.daos.impl.AbstractCMSItemDao

buildQuery, findSortQuery, getCmsSortQueryDataRegistry, setCmsSortQueryDataRegistry

Methods inherited from class de.hybris.platform.servicelayer.internal.dao.AbstractItemDao

getAllSources, getFlexibleSearchService, getModelService, getSource, load, loadAll, search, search, searchUnique, setFlexibleSearchService, setModelService

Methods inherited from class java.lang.Object

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

Field Details

CATALOG_VERSIONS_QUERY_PARAM

protected static final String CATALOG_VERSIONS_QUERY_PARAM

See Also:

• Constant Field Values

QUERY_ALIAS

protected static final String QUERY_ALIAS

See Also:

• Constant Field Values

Constructor Details

DefaultCMSComponentDao

public DefaultCMSComponentDao()

Method Details

findByCatalogVersionAndMask

public SearchResult<AbstractCMSComponentModel> findByCatalogVersionAndMask(CatalogVersionModel catalogVersionModel,
 String mask,
 PageableData pageableData)

Description copied from interface: CMSComponentDao

For a given mask used as filter and a PageableData query, will return a page object consisting of the content list of the requested page number and the total number of entities for the given mask

Specified by:

findByCatalogVersionAndMask in interface CMSComponentDao

Parameters:

catalogVersionModel - the catalog version to filter on

mask - the string value on which components will be filtered, implementations may choose to filter on the component name

pageableData - the PageableData object containing the page request details. PageableData may contain a String value for sort, this will be used by a sorting strategy to select the most appropriate query or resort to a default one.

Returns:

a page object

findCMSComponentsOfContainerByIdAndCatalogVersion

public List<SimpleCMSComponentModel> findCMSComponentsOfContainerByIdAndCatalogVersion(String id,
 CatalogVersionModel catalogVersion)

Find cms components of container by id and catalog version.

Specified by:

findCMSComponentsOfContainerByIdAndCatalogVersion in interface CMSComponentDao

Parameters:

id - the id of CMS component

catalogVersion - the catalog version

Returns:

the list of found simple CMS component objects or empty list when not found.

findCMSComponentsByIdAndCatalogVersions

public List<AbstractCMSComponentModel> findCMSComponentsByIdAndCatalogVersions(String id,
 Collection<CatalogVersionModel> catalogVersions)

Find cms components by id and catalog versions.

Specified by:

findCMSComponentsByIdAndCatalogVersions in interface CMSComponentDao

Parameters:

id - the id of CMS component

catalogVersions - the collection of catalog versions

Returns:

the list of found CMS component objects or empty list when not found.

findCMSComponentsByIdsAndCatalogVersions

public <T extends AbstractCMSComponentModel>
SearchPageData<T> findCMSComponentsByIdsAndCatalogVersions(Collection<String> ids,
 Collection<CatalogVersionModel> catalogVersions,
 SearchPageData searchPageDataInput)

Find cms components by list of IDs and catalog versions with pagination and sorting.

Specified by:

findCMSComponentsByIdsAndCatalogVersions in interface CMSComponentDao

Type Parameters:

T - the AbstractCMSComponentModel subclass type

Parameters:

ids - the collection of ids of CMS components

catalogVersions - the collection of catalog versions

searchPageDataInput - the searchPageData contains requested pagination and sorting information

Returns:

the list of found CMS component objects in SearchPageData

findCMSComponents

public List<AbstractCMSComponentModel> findCMSComponents(String id,
 String contentSlotId,
 Collection<CatalogVersionModel> catalogVersions)

Find cms components by id, contentSlotId and catalog versions.

Specified by:

findCMSComponents in interface CMSComponentDao

Parameters:

id - the id of CMS component.

contentSlotId - the if of content slot

catalogVersions - the collection of catalog versions

Returns:

the list of found CMS component objects or empty list when not found.

findCMSComponentsByIdAndCatalogVersion

public List<AbstractCMSComponentModel> findCMSComponentsByIdAndCatalogVersion(String id,
 CatalogVersionModel catalogVersion)

Find cms components by id and catalog version.

Specified by:

findCMSComponentsByIdAndCatalogVersion in interface CMSComponentDao

Parameters:

id - the id of CMS component

catalogVersion - the catalog version

Returns:

the list of found CMS component objects.

findCMSComponentsById

public List<AbstractCMSComponentModel> findCMSComponentsById(String id)

Find cms components by id.

Specified by:

findCMSComponentsById in interface CMSComponentDao

Parameters:

id - the id of CMS component

Returns:

the list of found CMS component objects or empty list when not found.

findCMSComponentContainersByIdAndCatalogVersion

public List<AbstractCMSComponentContainerModel> findCMSComponentContainersByIdAndCatalogVersion(String id,
 CatalogVersionModel catalogVersion)

Find cms component containers by id and catalog version.

Specified by:

findCMSComponentContainersByIdAndCatalogVersion in interface CMSComponentDao

Parameters:

id - the id of CMS component

catalogVersion - the catalog version

Returns:

the list of found CMS component container objects or empty list when not found.

findAllCMSComponentsByCatalogVersion

public List<AbstractCMSComponentModel> findAllCMSComponentsByCatalogVersion(CatalogVersionModel catalogVersion)

Description copied from interface: CMSComponentDao

Find cms components that belong to a given catalog version.

Specified by:

findAllCMSComponentsByCatalogVersion in interface CMSComponentDao

Parameters:

catalogVersion - - the catalog version

Returns:

the list of cms components belonging to the given catalog version or an empty list.

findAllCMSComponentsByCatalogVersions

public <T extends AbstractCMSComponentModel>
SearchPageData<T> findAllCMSComponentsByCatalogVersions(Collection<CatalogVersionModel> catalogVersions,
 SearchPageData searchPageData)

Description copied from interface: CMSComponentDao

Find cms components that belong to a given catalog version.

Specified by:

findAllCMSComponentsByCatalogVersions in interface CMSComponentDao

Parameters:

catalogVersions - - the collection of catalog versions

searchPageData - - the searchPageData contains requested pagination and sorting information

Returns:

the list of cms components belonging to the given catalog version and searchPageData; or an empty list.

getComponentReferenceCountOutsidePage

public long getComponentReferenceCountOutsidePage(AbstractCMSComponentModel componentModel,
 AbstractPageModel pageModel)

Description copied from interface: CMSComponentDao

Finds the number of times the given component is used outside a given page (e.g., other pages or shared slots).

Specified by:

getComponentReferenceCountOutsidePage in interface CMSComponentDao

Parameters:

componentModel - - The component whose references to count.

pageModel - - The page not to be included in the component references count.

Returns:

The number of times the given component is used outside the given page.

getPaginatedFlexibleSearchService

protected PaginatedFlexibleSearchService getPaginatedFlexibleSearchService()

setPaginatedFlexibleSearchService

public void setPaginatedFlexibleSearchService(PaginatedFlexibleSearchService paginatedFlexibleSearchService)