Package org.ametys.cms.search.ui.model

Class ReferenceTableSearchUIModel

java.lang.Object

org.ametys.cms.search.model.DefaultSearchModel

org.ametys.cms.search.ui.model.impl.DefaultSearchUIModel

org.ametys.cms.search.ui.model.ReferenceTableSearchUIModel

All Implemented Interfaces:

SearchModel, SearchUIModel, Model, ModelItemAccessor, ModelItemContainer, Configurable, Serviceable

public class ReferenceTableSearchUIModel
extends DefaultSearchUIModel
implements Serviceable, Configurable

Generic implementation of SearchUIModel for reference tables The search tool model automatically declares simple first level attributes as criteria and columns.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint	The content type extension point
protected HierarchicalReferenceTablesHelper	_hierarchicalReferenceTableContentsHelper	The helper component for hierarchical reference tables
protected SearchModelCriterionViewItemHelper	_searchModelCriterionViewItemHelper	The helper for SearchUIModel criterion definition
protected SystemPropertyExtensionPoint	_systemPropertyExtensionPoint	The systemPropertyExtension point

Fields inherited from class org.ametys.cms.search.ui.model.impl.DefaultSearchUIModel

__DEFAULT_EXPORT_CSV_URL, __DEFAULT_EXPORT_DOC_URL, __DEFAULT_EXPORT_PDF_URL, __DEFAULT_EXPORT_XML_URL, __DEFAULT_PRINT_URL, __DEFAULT_SEARCH_URL, __DEFAULT_URL_PLUGIN

Constructor Summary

Constructors

Constructor	Description
ReferenceTableSearchUIModel()

Method Summary

Modifier and Type	Method	Description
protected List<ViewItem>	_copyAndFilterViewItemsForColumns(List<ViewItem> viewItems)	Copy the given view items and filter to keep only items that can be used in SearchUIColumns.
protected List<ViewItem>	_createReferencingCriteria(ContentType contentType, List<ViewItem> viewItems)	Copy the given view items and filter to keep only items that can be used in SearchUIColumns.
protected boolean	_filterModelItemForColumn(ModelItem modelItem)	Returns true if model item can be used as column search UI
protected boolean	_filterModelItemForCriteria(ModelItem modelItem)	Returns true if the model item can be used as criteria
protected ViewItemContainer	_getCriteria(ContentType contentType)	Retrieves the criteria for the given content type
protected ViewItemContainer	_getResultItems(ContentType contentType)	Retrieves the result items for the given content type
void	configure(Configuration configuration)
protected SearchModelCriterionViewItem	createContentLanguageCriterion()	Retrieves the criteria for content language
protected SearchModelCriterionViewItem	createExcludeCandidateCriterion()	Retrieves the criteria used to exclude candidates
protected SearchModelCriterionViewItem	createLikeTitleCriterion(ElementDefinition titleReference)	Retrieves the title attribute criterion, with a 'LIKE' operator and an hidden widget
protected SearchModelCriterionViewItem	createReferencingCriterionViewItem(ContentType contentType, ElementDefinition reference)	Retrieves a SearchModelCriterionViewItem for referencing the given definition
ViewItemContainer	getAdvancedCriteria(Map<String,Object> contextualParameters)	Retrieves the criteria in advanced mode
ViewItemContainer	getCriteria(Map<String,Object> contextualParameters)	Retrieves the criteria in simple mode
Set<String>	getExcludedContentTypes(Map<String,Object> contextualParameters)	Get the list of excluded content types.
ViewItemContainer	getFacetedCriteria(Map<String,Object> contextualParameters)	Retrieves the faceted criteria.
ViewItemContainer	getResultItems(Map<String,Object> contextualParameters)	Retrieves the search result items
void	service(ServiceManager manager)

Methods inherited from class org.ametys.cms.search.ui.model.impl.DefaultSearchUIModel

_getAdvancedCriteriaListInfo, addAdvancedCriteria, allowSortOnMultipleJoin, getExportCSVUrl, getExportCSVUrlPlugin, getExportDOCUrl, getExportDOCUrlPlugin, getExportPDFUrl, getExportPDFUrlPlugin, getExportXMLUrl, getExportXMLUrlPlugin, getPageSize, getPrintUrl, getPrintUrlPlugin, getSearchUrl, getSearchUrlPlugin, getSummaryView, setAdvancedCriteria, setAllowSortOnMultipleJoin, setExportCSVUrl, setExportCSVUrlPlugin, setExportDOCUrl, setExportDOCUrlPlugin, setExportPDFUrl, setExportPDFUrlPlugin, setExportXMLUrl, setExportXMLUrlPlugin, setPageSize, setPrintUrl, setPrintUrlPlugin, setSearchUrl, setSearchUrlPlugin, setSummaryView, toJSON

Methods inherited from class org.ametys.cms.search.model.DefaultSearchModel

_resultItemsToJSON, addCriteria, addFacetedCriteria, getContentTypes, getWorkspace, resultItemsToJSON, setContentTypes, setCriteria, setExcludedContentTypes, setFacetedCriteria, setResultItems, setWorkspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.runtime.model.ModelItemAccessor

getChild, getModelItem, hasModelItem

Methods inherited from interface org.ametys.cms.search.model.SearchModel

getContentTypes, getCriterion, getFacetedCriterion, getFamilyId, getId, getModelItems, getResultItem, getWorkspace, resultItemsToJSON

Methods inherited from interface org.ametys.cms.search.ui.model.SearchUIModel

addAdvancedCriterion, addAdvancedCriterion, addCriterion, addCriterion, addFacetedCriterion, addFacetedCriterion, getAdvancedCriterion

Field Details

_hierarchicalReferenceTableContentsHelper

protected HierarchicalReferenceTablesHelper _hierarchicalReferenceTableContentsHelper

The helper component for hierarchical reference tables

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

The content type extension point

_systemPropertyExtensionPoint

protected SystemPropertyExtensionPoint _systemPropertyExtensionPoint

The systemPropertyExtension point

_searchModelCriterionViewItemHelper

protected SearchModelCriterionViewItemHelper _searchModelCriterionViewItemHelper

The helper for SearchUIModel criterion definition

Constructor Details

ReferenceTableSearchUIModel

public ReferenceTableSearchUIModel()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getExcludedContentTypes

public Set<String> getExcludedContentTypes(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the list of excluded content types.

Specified by:

getExcludedContentTypes in interface SearchModel

Overrides:

getExcludedContentTypes in class DefaultSearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

The list of excluded content types.

getCriteria

public ViewItemContainer getCriteria(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Retrieves the criteria in simple mode

Specified by:

getCriteria in interface SearchModel

Overrides:

getCriteria in class DefaultSearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the criteria in simple mode

getFacetedCriteria

public ViewItemContainer getFacetedCriteria(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Retrieves the faceted criteria.

Specified by:

getFacetedCriteria in interface SearchModel

Overrides:

getFacetedCriteria in class DefaultSearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the faceted criteria.

getAdvancedCriteria

public ViewItemContainer getAdvancedCriteria(Map<String,Object> contextualParameters)

Description copied from interface: SearchUIModel

Retrieves the criteria in advanced mode

Specified by:

getAdvancedCriteria in interface SearchUIModel

Overrides:

getAdvancedCriteria in class DefaultSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the criteria in advanced mode

getResultItems

public ViewItemContainer getResultItems(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Retrieves the search result items

Specified by:

getResultItems in interface SearchModel

Overrides:

getResultItems in class DefaultSearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the search result items

_getCriteria

protected ViewItemContainer _getCriteria(ContentType contentType)

Retrieves the criteria for the given content type

Parameters:

contentType - The content type

Returns:

the criteria

_createReferencingCriteria

protected List<ViewItem> _createReferencingCriteria(ContentType contentType,
 List<ViewItem> viewItems)

Copy the given view items and filter to keep only items that can be used in SearchUIColumns. Also copy the children of view item accessors

Parameters:

contentType - the content type

viewItems - the view items to copy

Returns:

the view items copies

createExcludeCandidateCriterion

protected SearchModelCriterionViewItem createExcludeCandidateCriterion()

Retrieves the criteria used to exclude candidates

Returns:

the criteria used to exclude candidates

_filterModelItemForCriteria

protected boolean _filterModelItemForCriteria(ModelItem modelItem)

Returns true if the model item can be used as criteria

Parameters:

modelItem - the model item

Returns:

true if the model item can be used as criteria

createLikeTitleCriterion

protected SearchModelCriterionViewItem createLikeTitleCriterion(ElementDefinition titleReference)

Retrieves the title attribute criterion, with a 'LIKE' operator and an hidden widget

Parameters:

titleReference - the title reference

Returns:

the like title criterion

createReferencingCriterionViewItem

protected SearchModelCriterionViewItem createReferencingCriterionViewItem(ContentType contentType,
 ElementDefinition reference)

Retrieves a SearchModelCriterionViewItem for referencing the given definition

Parameters:

contentType - the simple content type.

reference - the referenced definition.

Returns:

the criterion

createContentLanguageCriterion

protected SearchModelCriterionViewItem createContentLanguageCriterion()

Retrieves the criteria for content language

Returns:

the criteria for content language

_getResultItems

protected ViewItemContainer _getResultItems(ContentType contentType)

Retrieves the result items for the given content type

Parameters:

contentType - The content type

Returns:

the result items

_copyAndFilterViewItemsForColumns

protected List<ViewItem> _copyAndFilterViewItemsForColumns(List<ViewItem> viewItems)

Copy the given view items and filter to keep only items that can be used in SearchUIColumns. Also copy the children of view item accessors

Parameters:

viewItems - the view items to copy

Returns:

the view items copies

_filterModelItemForColumn

protected boolean _filterModelItemForColumn(ModelItem modelItem)

Returns true if model item can be used as column search UI

Parameters:

modelItem - the model item

Returns:

true if model item can be used as column search UI