Package org.ametys.web.frontoffice

Class SearchGenerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.generation.AbstractGenerator

org.apache.cocoon.generation.ServiceableGenerator

org.ametys.web.frontoffice.AbstractSearchGenerator

org.ametys.web.frontoffice.SearchGenerator

All Implemented Interfaces:

SolrFieldNames, SolrWebFieldNames, Poolable, Recyclable, Disposable, Component, Contextualizable, LogEnabled, Serviceable, Generator, SitemapModelComponent, XMLProducer

Direct Known Subclasses:

FrontODFSearch

public class SearchGenerator
extends AbstractSearchGenerator

Generates the results of a search performed on front office

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	SearchGenerator.ContentTypeSearch	Enumeration for content type search

Nested classes/interfaces inherited from class org.ametys.web.frontoffice.AbstractSearchGenerator

AbstractSearchGenerator.AttributeFacetField, AbstractSearchGenerator.ContentTypeFacetField, AbstractSearchGenerator.FacetField

Field Summary

Fields

Modifier and Type	Field	Description
protected QueryAdapterFOSearchExtensionPoint	_queryAdapterFOSearchEP	The query adapter extension point
protected SiteTypesExtensionPoint	_siteTypeEP	The site type manager

Fields inherited from class org.ametys.web.frontoffice.AbstractSearchGenerator

_contentTypesHelper, _context, _cTypeExtPt, _resolver, _searcherFactory, _searchHelper, _siteManager, _tagExtPt, _TEXTFIELD_PATTERN, _uriResolverEP, DOCUMENT_TYPE_IS_PAGE_RESOURCE_FACET_NAME

Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator

manager

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Fields inherited from interface org.ametys.cms.content.indexing.solr.SolrFieldNames

ACL_INIT_VALUE_ALLOWED_GROUPS, ACL_INIT_VALUE_ALLOWED_USERS, ACL_INIT_VALUE_ANONYMOUS, ACL_INIT_VALUE_ANYCONNECTED, ACL_INIT_VALUE_DENIED_GROUPS, ACL_INIT_VALUE_DENIED_USERS, ALL_CONTENT_TYPES, ALL_MIXIN_TYPES, ALL_TAGS, ATTACHMENT_CONTENT_ID, CONTENT_COMMENTS_NONVALIDATED, CONTENT_COMMENTS_VALIDATED, CONTENT_CREATOR, CONTENT_FIRST_VALIDATOR, CONTENT_LANGUAGE, CONTENT_LANGUAGES, CONTENT_LAST_CONTRIBUTOR, CONTENT_LAST_MAJOR_VALIDATOR, CONTENT_LAST_VALIDATOR, CONTENT_NAME, CONTENT_OUTGOING_REFEERENCES_RESOURCE_IDS, CONTENT_TITLES, CONTENT_TYPE_RESOURCE, CONTENT_TYPES, CONTENT_VISIBLE_ATTACHMENT_RESOURCE_IDS, CREATION_DATE, DC_CONTRIBUTOR, DC_COVERAGE, DC_CREATOR, DC_DATE, DC_DESCRIPTION, DC_FORMAT, DC_IDENTIFIER, DC_LANGUAGE, DC_PUBLISHER, DC_RELATION, DC_RIGHTS, DC_SOURCE, DC_SUBJECT, DC_TITLE, DC_TYPE, DOCUMENT_TYPE, EXACT_WS_OPERATOR, EXCERPT, FILENAME, FULL, ID, IS_AMETYS_OBJECT, LANGUAGE_SEPARATOR, LAST_MODIFIED, LENGTH, MIME_TYPES, MIXIN_TYPES, PATH, PSEUDO_CONTENT_TYPE_VALUE_RESOURCE, PSEUDO_CONTENT_TYPES, REPEATER_ENTRY_POSITION, RESOURCE_ANCESTOR_AND_SELF_IDS, RESOURCE_ANCESTOR_IDS, RESOURCE_CREATOR, RESOURCE_DATE, RESOURCE_LAST_MODIFIED, RESOURCE_MIME_TYPE_GROUP, RESOURCE_ROOT_ID, SIMPLE_CONTENT_PARENTS, STEMMED_OPERATOR, SUB_CONTENT, SYSTEM_FULL, TAGS, TITLE, TITLE_SORT, TYPE_CONTENT, TYPE_CONTENT_ATTACHMENT_RESOURCE, TYPE_CONTENT_ATTRIBUTE_RESOURCE, TYPE_REPEATER, TYPE_RESOURCE, TYPE_WF_ENTRY, TYPE_WF_STEP, WORKFLOW_CURRENT_STEPS, WORKFLOW_CURRENT_STEPS_DV, WORKFLOW_ENTRY_STATE, WORKFLOW_HISTORY_STEPS, WORKFLOW_HISTORY_STEPS_DV, WORKFLOW_NAME, WORKFLOW_REF, WORKFLOW_REF_DV, WORKFLOW_STEP_ACTIONID, WORKFLOW_STEP_CALLER, WORKFLOW_STEP_DUEDATE, WORKFLOW_STEP_FINISHDATE, WORKFLOW_STEP_ID, WORKFLOW_STEP_OWNER, WORKFLOW_STEP_STARTDATE, WORKFLOW_STEP_STATUS

Fields inherited from interface org.ametys.web.indexing.solr.SolrWebFieldNames

ATTACHMENT_PAGE_ID, CONTENT_IDS, CONTENT_INTERESTING_DATES, DATE_FOR_SORTING, DATES_FACET, FACETABLE_CONTENT_FIELD_PREFIX, LASTNAME_FOR_SORTING, PAGE_ANCESTOR_IDS, PAGE_CONTENT_TYPES, PAGE_DEPTH, PAGE_IDS, PAGE_LONG_TITLE, PAGE_OUTGOING_REFEERENCES_RESOURCE_IDS, PAGE_PARENT_ID, PAGE_TITLE, PAGE_TYPE, PAGE_VISIBLE_ATTACHMENT_RESOURCE_IDS, SECTION_PAGE_TITLE, SERVICE_IDS, SHARED, SITE_NAME, SITE_TYPE, SITEMAP_NAME, TEMPLATE, TYPE_PAGE, TYPE_PAGE_RESOURCE

Constructor Summary

Constructors

Constructor	Description
SearchGenerator()

Method Summary

Modifier and Type	Method	Description
protected void	_addAttributeFacet(Map<String,AbstractSearchGenerator.FacetField> facets, Collection<String> contentTypes, String attributePath)	Add attribute facet to facets map
protected void	_additionalSearchProcessing(SearcherFactory.Searcher searcher)	Allow to perform other searcher configuration
protected Query	_getStringAttributeQuery(String language, String attributePath, String value, ModelItem modelItem)	Get query from string attribute
protected void	addAllWordsTextFieldQuery(Collection<Query> queries, String language, Request request)	Add content query for "all words"
protected void	addAttributeQuery(Collection<Query> queries, String language, Request request)	Add query for each attribute
protected void	addContentTypeQuery(Collection<Query> queries, Request request)	Add the content type query
protected void	addDateQuery(Collection<Query> queries, Request request)	Add the query on start and end dates
protected void	addExactWordingTextFieldQuery(Collection<Query> queries, String language, Request request)	Add content query for exact wording or phrase
protected void	addNoWordsTextFieldQuery(Collection<Query> queries, String language, Request request)	Add content query for "none of these words"
protected void	addPagesQuery(Collection<Query> queries, Request request)	Add the pages query
protected void	addTagsQuery(Collection<Query> queries, Request request)	Add the tags query
protected void	addTextFieldQuery(Collection<Query> queries, String language, Request request)	Add the text field query
protected List<Query>	getContentQueries(Request request, Collection<String> siteNames, String language)	Get the queries to be apply on joined contents ONLY
protected List<Query>	getContentResourcesOrAttachmentQueries(Query subQuery)	Get the queries for content's attachments and resources
protected String	getContentTypeFilterValue(Request request)	Get the content type's filter value
protected Collection<String>	getContentTypes(Request request)	Get the content type's
protected SearchGenerator.ContentTypeSearch	getContentTypeSearch(Request request)	Return the type of content type's search
protected Map<String,String>	getContentValues(String cTypeId, String language)	Get values for contents enumeration
protected Collection<String>	getDocumentTypes(Request request)	Get the document types.
protected Map<String,AbstractSearchGenerator.FacetField>	getFacets(Request request)	Get the facets from request parameters
protected Map<String,List<String>>	getFacetValues(Request request, Collection<String> siteNames, String language)	Get the facet values
protected Collection<String>	getFields()	Get the searchable fields
protected Collection<Query>	getFilterQueries(Request request, Collection<String> siteNames, String language)	Get the filter queries from the request parameters.
protected Collection<Query>	getFixedCTypeFilterQueries(Request request, String cType, Collection<String> siteNames, String language)	Get the filter queries for a single fixed content type.
protected List<Query>	getPageQueries(Request request, Collection<String> siteNames, String language)	Get the queries to be apply on pages ONLY
protected List<Query>	getPageResourcesOrAttachmentQueries(Query subQuery)	Get the queries for page's attachments and resources
protected List<Sort>	getPrimarySortFields(Request request)	Get the primary sort fields
protected Query	getQuery(Request request, Collection<String> siteNames, String language)	Get the query from request parameters
protected Set<FrontOfficeSearcherFactory.QueryFacet>	getQueryFacets(Request request)	Get the facet.queries
protected Collection<String>	getQueryFacetValues(Request request)	Get the facet.query values
protected Sort	getSortField(Request request)	Get the sort field
protected List<Query>	getWordingQueries(Request request, Collection<String> siteNames, String language)	Get the queries on wording (keywords, no words, exact wording, no words)
protected void	saxAttributeDefinition(ModelItem modelItem, String attributePath, String language)	Generates SAX events for attribute definition
protected void	saxEnumeratorValueForAttribute(ModelItem modelItem, String attributePath, String language)	Sax enumeration value for enum or a content attribute
protected void	saxFormFields(Request request, String siteName, String lang)	SAX the form search criteria
protected void	saxFormValues(Request request, int start, int offset)	SAX the form search criteria values
protected void	saxHits(SearchResults<AmetysObject> results, int start, int maxResults)	SAX the result hits
protected SearchResults<AmetysObject>	search(Request request, Collection<String> siteNames, String language, int pageIndex, int start, int maxResults)	Search
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.web.frontoffice.AbstractSearchGenerator

_checkRights, contextualize, generate, getDocumentTypesQuery, getPageIndex, getSearchMode, getZoneItem, isInputValid, saxAdditionalInfos, saxAdditionalInfosOnPageHit, saxContent, saxFacets, saxFormParameters, saxPageHit, saxPagination, saxResourceHit, saxRichTextExcerpt, saxServiceIdentifiers, saxSort, search, useFacets

Methods inherited from class org.apache.cocoon.generation.ServiceableGenerator

dispose

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator

recycle, setup

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Details

_queryAdapterFOSearchEP

protected QueryAdapterFOSearchExtensionPoint _queryAdapterFOSearchEP

The query adapter extension point

_siteTypeEP

protected SiteTypesExtensionPoint _siteTypeEP

The site type manager

Constructor Details

SearchGenerator

public SearchGenerator()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSearchGenerator

Throws:

ServiceException

getContentTypeSearch

protected SearchGenerator.ContentTypeSearch getContentTypeSearch(Request request)

Return the type of content type's search

Parameters:

request - The request

Returns:

The type of search

search

protected SearchResults<AmetysObject> search(Request request,
 Collection<String> siteNames,
 String language,
 int pageIndex,
 int start,
 int maxResults)
                                      throws Exception

Description copied from class: AbstractSearchGenerator

Search

Overrides:

search in class AbstractSearchGenerator

Parameters:

request - the request

siteNames - The name of the sites to search in

language - The language code to search

pageIndex - the page index

start - The offset for search results

maxResults - The maximum number of results

Returns:

The search results

Throws:

Exception - If an error occurred during search

_additionalSearchProcessing

protected void _additionalSearchProcessing(SearcherFactory.Searcher searcher)

Description copied from class: AbstractSearchGenerator

Allow to perform other searcher configuration

Overrides:

_additionalSearchProcessing in class AbstractSearchGenerator

Parameters:

searcher - The searcher that will be used for the search operation

getQuery

protected Query getQuery(Request request,
 Collection<String> siteNames,
 String language)
                  throws IllegalArgumentException

Description copied from class: AbstractSearchGenerator

Get the query from request parameters

Specified by:

getQuery in class AbstractSearchGenerator

Parameters:

request - The request

siteNames - The site names.

language - The language

Returns:

The query object.

Throws:

IllegalArgumentException - If the search field is invalid.

getWordingQueries

protected List<Query> getWordingQueries(Request request,
 Collection<String> siteNames,
 String language)

Get the queries on wording (keywords, no words, exact wording, no words)

Parameters:

request - the request

siteNames - the site names

language - the language

Returns:

the queries on wording

getContentQueries

protected List<Query> getContentQueries(Request request,
 Collection<String> siteNames,
 String language)

Get the queries to be apply on joined contents ONLY

Parameters:

request - the request

siteNames - the site names

language - the language

Returns:

the queries for contents only

getPageQueries

protected List<Query> getPageQueries(Request request,
 Collection<String> siteNames,
 String language)

Get the queries to be apply on pages ONLY

Parameters:

request - the request

siteNames - the site names

language - the language

Returns:

the queries for pages only

getFilterQueries

protected Collection<Query> getFilterQueries(Request request,
 Collection<String> siteNames,
 String language)
                                      throws IllegalArgumentException

Description copied from class: AbstractSearchGenerator

Get the filter queries from the request parameters.

Specified by:

getFilterQueries in class AbstractSearchGenerator

Parameters:

request - The request.

siteNames - The site names.

language - The language.

Returns:

A collection of filter queries.

Throws:

IllegalArgumentException - If a search field is invalid.

getFacetValues

protected Map<String,List<String>> getFacetValues(Request request,
 Collection<String> siteNames,
 String language)
                                           throws IllegalArgumentException

Description copied from class: AbstractSearchGenerator

Get the facet values

Specified by:

getFacetValues in class AbstractSearchGenerator

Parameters:

request - The request

siteNames - The site names

language - The language

Returns:

The facet values

Throws:

IllegalArgumentException

getQueryFacetValues

protected Collection<String> getQueryFacetValues(Request request)

Description copied from class: AbstractSearchGenerator

Get the facet.query values

Specified by:

getQueryFacetValues in class AbstractSearchGenerator

Parameters:

request - The request

Returns:

The facet.query values

getFacets

protected Map<String,AbstractSearchGenerator.FacetField> getFacets(Request request)
                                                            throws IllegalArgumentException

Description copied from class: AbstractSearchGenerator

Get the facets from request parameters

Specified by:

getFacets in class AbstractSearchGenerator

Parameters:

request - The request

Returns:

The facet fields

Throws:

IllegalArgumentException - If the search field is invalid.

_addAttributeFacet

protected void _addAttributeFacet(Map<String,AbstractSearchGenerator.FacetField> facets,
 Collection<String> contentTypes,
 String attributePath)

Add attribute facet to facets map

Parameters:

facets - the facets map

contentTypes - the content types

attributePath - the attribute path

getQueryFacets

protected Set<FrontOfficeSearcherFactory.QueryFacet> getQueryFacets(Request request)

Description copied from class: AbstractSearchGenerator

Get the facet.queries

Specified by:

getQueryFacets in class AbstractSearchGenerator

Parameters:

request - The request

Returns:

The facet.queries

getFixedCTypeFilterQueries

protected Collection<Query> getFixedCTypeFilterQueries(Request request,
 String cType,
 Collection<String> siteNames,
 String language)

Get the filter queries for a single fixed content type.

Parameters:

request - The request.

cType - The fixed content type.

siteNames - the site names.

language - The language.

Returns:

The filter queries.

getDocumentTypes

protected Collection<String> getDocumentTypes(Request request)

Description copied from class: AbstractSearchGenerator

Get the document types.

Specified by:

getDocumentTypes in class AbstractSearchGenerator

Parameters:

request - The request.

Returns:

the document types to search.

getFields

protected Collection<String> getFields()

Description copied from class: AbstractSearchGenerator

Get the searchable fields

Specified by:

getFields in class AbstractSearchGenerator

Returns:

The fields

saxHits

protected void saxHits(SearchResults<AmetysObject> results,
 int start,
 int maxResults)
                throws SAXException

Description copied from class: AbstractSearchGenerator

SAX the result hits

Specified by:

saxHits in class AbstractSearchGenerator

Parameters:

results - The search results.

start - The start index

maxResults - The number of results to generate.

Throws:

SAXException - If an error occurs while SAXing

getSortField

protected Sort getSortField(Request request)

Description copied from class: AbstractSearchGenerator

Get the sort field

Specified by:

getSortField in class AbstractSearchGenerator

Parameters:

request - The request

Returns:

The sort field or null to sort by score

getPrimarySortFields

protected List<Sort> getPrimarySortFields(Request request)

Description copied from class: AbstractSearchGenerator

Get the primary sort fields

Specified by:

getPrimarySortFields in class AbstractSearchGenerator

Parameters:

request - The request

Returns:

the list additional sort fields or empty list.

saxFormFields

protected void saxFormFields(Request request,
 String siteName,
 String lang)
                      throws SAXException

Description copied from class: AbstractSearchGenerator

SAX the form search criteria

Specified by:

saxFormFields in class AbstractSearchGenerator

Parameters:

request - The request

siteName - The current site name

lang - The current language

Throws:

SAXException - if an error occurs while SAXing

saxAttributeDefinition

protected void saxAttributeDefinition(ModelItem modelItem,
 String attributePath,
 String language)
                               throws SAXException

Generates SAX events for attribute definition

Parameters:

modelItem - The attribute definition.

attributePath - The attribute path

language - The current language

Throws:

SAXException - If an error occurred while generating SAX events

saxEnumeratorValueForAttribute

protected void saxEnumeratorValueForAttribute(ModelItem modelItem,
 String attributePath,
 String language)
                                       throws SAXException

Sax enumeration value for enum or a content attribute

Parameters:

modelItem - The attribute definition.

attributePath - The attribute path

language - The current language

Throws:

SAXException - If an error occurred while saxing

getContentValues

protected Map<String,String> getContentValues(String cTypeId,
 String language)

Get values for contents enumeration

Parameters:

cTypeId - The id of content type

language - The current language

Returns:

The contents

saxFormValues

protected void saxFormValues(Request request,
 int start,
 int offset)
                      throws SAXException

Description copied from class: AbstractSearchGenerator

SAX the form search criteria values

Specified by:

saxFormValues in class AbstractSearchGenerator

Parameters:

request - The request

start - The start index

offset - The number of results

Throws:

SAXException - if an error occurs while SAXing

getContentTypes

protected Collection<String> getContentTypes(Request request)

Get the content type's

Parameters:

request - The request

Returns:

the content type's

getContentTypeFilterValue

protected String getContentTypeFilterValue(Request request)

Get the content type's filter value

Parameters:

request - The request

Returns:

the content type's filter value

addTextFieldQuery

protected void addTextFieldQuery(Collection<Query> queries,
 String language,
 Request request)

Add the text field query

Parameters:

queries - the queries

language - the language

request - the request

getContentResourcesOrAttachmentQueries

protected List<Query> getContentResourcesOrAttachmentQueries(Query subQuery)

Get the queries for content's attachments and resources

Parameters:

subQuery - the query for attachments and resources

Returns:

the join query for content's attachments and resources

getPageResourcesOrAttachmentQueries

protected List<Query> getPageResourcesOrAttachmentQueries(Query subQuery)

Get the queries for page's attachments and resources

Parameters:

subQuery - the query for attachments and resources

Returns:

the join query for content's attachments and resources

addAttributeQuery

protected void addAttributeQuery(Collection<Query> queries,
 String language,
 Request request)
                          throws IllegalArgumentException

Add query for each attribute

Parameters:

queries - The list of query

language - The lang

request - The request

Throws:

IllegalArgumentException - If an error occurred

_getStringAttributeQuery

protected Query _getStringAttributeQuery(String language,
 String attributePath,
 String value,
 ModelItem modelItem)

Get query from string attribute

Parameters:

language - the language

attributePath - the attribute path

value - the value

modelItem - the model item

Returns:

the query

addAllWordsTextFieldQuery

protected void addAllWordsTextFieldQuery(Collection<Query> queries,
 String language,
 Request request)

Add content query for "all words"

Parameters:

queries - The queries

language - The current language

request - the request

addExactWordingTextFieldQuery

protected void addExactWordingTextFieldQuery(Collection<Query> queries,
 String language,
 Request request)

Add content query for exact wording or phrase

Parameters:

queries - The queries

language - The current language

request - the request

addNoWordsTextFieldQuery

protected void addNoWordsTextFieldQuery(Collection<Query> queries,
 String language,
 Request request)

Add content query for "none of these words"

Parameters:

queries - The queries

language - The current language

request - the request

addContentTypeQuery

protected void addContentTypeQuery(Collection<Query> queries,
 Request request)

Add the content type query

Parameters:

queries - The queries

request - The request

addTagsQuery

protected void addTagsQuery(Collection<Query> queries,
 Request request)

Add the tags query

Parameters:

queries - The queries

request - The request

addPagesQuery

protected void addPagesQuery(Collection<Query> queries,
 Request request)

Add the pages query

Parameters:

queries - The queries

request - The request

addDateQuery

protected void addDateQuery(Collection<Query> queries,
 Request request)

Add the query on start and end dates

Parameters:

queries - The queries

request - The request