Package org.ametys.plugins.mobileapp

Class SearchModelWrapper

java.lang.Object

org.ametys.plugins.mobileapp.SearchModelWrapper

All Implemented Interfaces:

SearchModel, SearchUIModel, Model, ModelItemAccessor, ModelItemContainer, Labelable

public class SearchModelWrapper
extends Object
implements SearchUIModel

Wrapper for a SearchUIModel to force LastValidationSystemProperty to be in result fields

Field Summary

Fields

Modifier and Type	Field	Description
protected org.slf4j.Logger	_logger	The logger
protected ServiceManager	_manager	The service manager
protected SystemPropertyExtensionPoint	_systemPropertyExtensionPoint	The SystemProperty extension point

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

TAG_PUBLIC

Constructor Summary

Constructors

Constructor	Description
SearchModelWrapper(SearchUIModel model, ServiceManager manager, org.slf4j.Logger logger)	Constructor with the SearchUIModel to wrap

Method Summary

Modifier and Type	Method	Description
ViewItemContainer	getAdvancedCriteria(Map<String,Object> contextualParameters)	Retrieves the criteria in advanced mode
Set<String>	getContentTypes(Map<String,Object> contextualParameters)	Get the list of content types.
ViewItemContainer	getCriteria(Map<String,Object> contextualParameters)	Retrieves the criteria in simple mode
I18nizableText	getDescription()	Retrieves the description.
Set<String>	getExcludedContentTypes(Map<String,Object> contextualParameters)	Get the list of excluded content types.
String	getExportCSVUrl(Map<String,Object> contextualParameters)	Get the URL for CSV export of results
String	getExportCSVUrlPlugin(Map<String,Object> contextualParameters)	Get the plugin name for CSV export of results
ViewItemContainer	getFacetedCriteria(Map<String,Object> contextualParameters)	Retrieves the faceted criteria.
I18nizableText	getLabel()	Retrieves the label.
protected final org.slf4j.Logger	getLogger()	Get the logger.
String	getName()	Get the name.
int	getPageSize(Map<String,Object> contextualParameters)	Get the page size.
String	getPrintUrl(Map<String,Object> contextualParameters)	Get the URL for print results
String	getPrintUrlPlugin(Map<String,Object> contextualParameters)	Get the plugin name for print results
ViewItemContainer	getResultItems(Map<String,Object> contextualParameters)	Retrieves the search result items
String	getSearchUrl(Map<String,Object> contextualParameters)	Get the URL for search
String	getSearchUrlPlugin(Map<String,Object> contextualParameters)	Get the plugin name for search
String	getSummaryView()	Get the name of the view to use for summary of the content.
protected SystemPropertyExtensionPoint	getSystemPropertyExtensionPoint()	Retrieves the SystemPropertyExtensionPoint
Set<String>	getTags()	Get the registered tags for this search model
String	getWorkspace(Map<String,Object> contextualParameters)	Get the specific workspace to use.
boolean	hasTag(String tagName)	Determines if the search model has the given tag
List<Object>	resultItemsToJSON(Map<String,Object> contextualParameters)	Converts the search model's result items on a JSON list
Map<String,Object>	toJSON(Map<String,Object> contextualParameters)	Converts the search model in a JSON map

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

getCriterion, getFacetedCriterion, getFamilyId, getId, getModelItems, getResultItem

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

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

Field Details

_logger

protected org.slf4j.Logger _logger

The logger

_manager

protected ServiceManager _manager

The service manager

_systemPropertyExtensionPoint

protected SystemPropertyExtensionPoint _systemPropertyExtensionPoint

The SystemProperty extension point

Constructor Details

SearchModelWrapper

public SearchModelWrapper(SearchUIModel model,
 ServiceManager manager,
 org.slf4j.Logger logger)

Constructor with the SearchUIModel to wrap

Parameters:

model - the SearchUIModel to wrap

manager - The service manager

logger - The logger

Method Details

getResultItems

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

Description copied from interface: SearchModel

Retrieves the search result items

Specified by:

getResultItems in interface SearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the search result items

getSystemPropertyExtensionPoint

protected SystemPropertyExtensionPoint getSystemPropertyExtensionPoint()
                                                                throws ServiceException

Retrieves the SystemPropertyExtensionPoint

Returns:

The SystemPropertyExtensionPoint

Throws:

ServiceException - if an error occurs while looking to the extension point up

getContentTypes

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

Description copied from interface: SearchModel

Get the list of content types.

Specified by:

getContentTypes in interface SearchModel

Parameters:

contextualParameters - the contextual parameters.

Returns:

The list of content types.

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

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

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

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

Parameters:

contextualParameters - the contextual parameters

Returns:

the criteria in advanced mode

getPageSize

public int getPageSize(Map<String,Object> contextualParameters)

Description copied from interface: SearchUIModel

Get the page size.

Specified by:

getPageSize in interface SearchUIModel

Parameters:

contextualParameters - the contextual parameters.

Returns:

The page size, unlimited or default used when negative or 0.

getWorkspace

public String getWorkspace(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the specific workspace to use.

Specified by:

getWorkspace in interface SearchModel

Parameters:

contextualParameters - the contextual parameters.

Returns:

the workspace to use when searching, or null to use the default workspace.

getSearchUrl

public String getSearchUrl(Map<String,Object> contextualParameters)

Description copied from interface: SearchUIModel

Get the URL for search

Specified by:

getSearchUrl in interface SearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for search

getSearchUrlPlugin

public String getSearchUrlPlugin(Map<String,Object> contextualParameters)

Description copied from interface: SearchUIModel

Get the plugin name for search

Specified by:

getSearchUrlPlugin in interface SearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for search

getExportCSVUrl

public String getExportCSVUrl(Map<String,Object> contextualParameters)

Description copied from interface: SearchUIModel

Get the URL for CSV export of results

Specified by:

getExportCSVUrl in interface SearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for CSV export

getExportCSVUrlPlugin

public String getExportCSVUrlPlugin(Map<String,Object> contextualParameters)

Description copied from interface: SearchUIModel

Get the plugin name for CSV export of results

Specified by:

getExportCSVUrlPlugin in interface SearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for CSV export

getPrintUrl

public String getPrintUrl(Map<String,Object> contextualParameters)

Description copied from interface: SearchUIModel

Get the URL for print results

Specified by:

getPrintUrl in interface SearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for print results

getPrintUrlPlugin

public String getPrintUrlPlugin(Map<String,Object> contextualParameters)

Description copied from interface: SearchUIModel

Get the plugin name for print results

Specified by:

getPrintUrlPlugin in interface SearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for print results

getSummaryView

public String getSummaryView()

Description copied from interface: SearchUIModel

Get the name of the view to use for summary of the content.

Specified by:

getSummaryView in interface SearchUIModel

Returns:

the name of the view to use for summary of the content. Can be null.

toJSON

public Map<String,Object> toJSON(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Converts the search model in a JSON map

Specified by:

toJSON in interface SearchModel

Parameters:

contextualParameters - The contextual parameters

Returns:

the search model as a JSON map

resultItemsToJSON

public List<Object> resultItemsToJSON(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Converts the search model's result items on a JSON list

Specified by:

resultItemsToJSON in interface SearchModel

Parameters:

contextualParameters - The contextual parameters

Returns:

the result items as a JSON list

getLogger

protected final org.slf4j.Logger getLogger()

Get the logger.

Returns:

the logger.

getName

public String getName()

Description copied from interface: Labelable

Get the name.

Specified by:

getName in interface Labelable

Returns:

the name.

getLabel

public I18nizableText getLabel()

Description copied from interface: Labelable

Retrieves the label.

Specified by:

getLabel in interface Labelable

Returns:

the label.

getDescription

public I18nizableText getDescription()

Description copied from interface: Labelable

Retrieves the description.

Specified by:

getDescription in interface Labelable

Returns:

the description.

hasTag

public boolean hasTag(String tagName)

Description copied from interface: SearchUIModel

Determines if the search model has the given tag

Specified by:

hasTag in interface SearchUIModel

Parameters:

tagName - The tag name

Returns:

true if the search model is tagged with the given tag name

getTags

public Set<String> getTags()

Description copied from interface: SearchUIModel

Get the registered tags for this search model

Specified by:

getTags in interface SearchUIModel

Returns:

the tags