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

public class SearchGenerator
extends AbstractSearchGenerator

Generates the results of a search performed on front office

Nested Class Summary

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

AbstractSearchGenerator.Criterion

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONTENT_TYPE_CHOICE_CHECKBOX Constants for content type's choice : checkbox then filter
protected static String	CONTENT_TYPE_CHOICE_CHECKBOX_AND_FILTER Constants for content type's choice : checkbox then filter
protected static String	CONTENT_TYPE_CHOICE_FILTER Constants for content type's choice : filter
protected static String	CONTENT_TYPE_CHOICE_LIST Constants for content type's choice : list
protected static String	CONTENT_TYPE_CHOICE_NONE Constants for content type's choice : none

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

_contentHelper, _contentTypesHelper, _context, _cTypeExtPt, _dcProvider, _metadataManager, _parser, _resolver, _searcherFactory, _siteManager, _tagExtPt, _TEXTFIELD_PATTERN, _uriResolverEP

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.ametys.web.indexing.solr.SolrWebFieldNames

ANCESTOR_IDS, CONTENT_IDS, CONTENT_INTERESTING_DATES, DATE_FOR_SORTING, DATES_FACET, LASTNAME_FOR_SORTING, LONG_TITLE, ORPHAN, PAGE_DEPTH, PAGE_ID, PAGE_IDS, PAGE_TYPE, PRIVACY, SECTION_PAGE_TITLE, SERVICE_IDS, SHARED, SITE_NAME, SITEMAP_NAME, TEMPLATE, TITLE, TITLE_FOR_SORTING, TYPE_PAGE, TYPE_PAGE_RESOURCE

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

ACL_READ_ALLOW_ANONYMOUS, ACL_READ_ALLOW_ANY_CONNECTED_USER, ACL_READ_ALLOWED_GROUPS, ACL_READ_ALLOWED_USERS, ACL_READ_DENIED_GROUPS, ACL_READ_DENIED_USERS, ALL_CONTENT_TYPES, ALL_MIXIN_TYPES, ALL_TAGS, CONTENT_COMMENTS, CONTENT_COMMENTS_NONVALIDATED, CONTENT_COMMENTS_VALIDATED, CONTENT_CREATOR, CONTENT_LANGUAGE, CONTENT_LANGUAGES, CONTENT_LAST_CONTRIBUTOR, CONTENT_NAME, CONTENT_TITLES, CONTENT_TYPE_RESOURCE, CONTENT_TYPES, 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, EXCERPT, FILENAME, FULL_EXACT_WS, FULL_GENERAL, FULL_PREFIX, FULL_STEMMED_PREFIX, ID, LAST_MAJOR_VALIDATION, LAST_MODIFIED, LAST_VALIDATION, LENGTH, MIME_TYPES, MIXIN_TYPES, PATH, REPEATER_ENTRY_POSITION, RESOURCE_CREATOR, RESOURCE_DATE, RESOURCE_LAST_MODIFIED, RESOURCE_ROOT_ID, SUB_CONTENT, TAGS, TITLE_SORT, TYPE_CONTENT, 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, 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.apache.cocoon.generation.Generator

ROLE

Constructor Summary

Constructors

Constructor and Description
SearchGenerator()

Method Summary

Modifier and Type	Method and Description
private void	_addAllWordsTextFieldQuery(Collection<Query> queries, String language, Request request)
private void	_addContentTypeQuery(Collection<Query> queries, Request request)
private void	_addDateQuery(Collection<Query> queries, Request request)
private void	_addExactWordingTextFieldQuery(Collection<Query> queries, String language, Request request)
private void	_addNoWordsTextFieldQuery(Collection<Query> queries, String language, Request request)
private void	_addPagesQuery(Collection<Query> queries, Request request)
private void	_addTagsQuery(Collection<Query> queries, Request request)
private void	_addTextFieldQuery(Collection<Query> queries, String language, Request request)
private String	_escapeQueryCharsButNotQuotes(String text)
private Set<String>	_getAllContentTypes()
private Collection<String>	_getAvailableContentTypes()
private void	_saxAllWords(Request request)
private void	_saxContentType(Request request)
private void	_saxContentTypeCriteria()
private void	_saxDates(Request request)
private void	_saxExactWording(Request request)
private void	_saxMetadataCriteria(Request request)
private void	_saxMetadataValues(Request request)
private void	_saxMultisite(Request request)
private void	_saxNoWords(Request request)
private void	_saxPages(Request request)
private void	_saxSitemapCriteria()
private void	_saxTag(Tag tag, boolean recursive)
private void	_saxTags(Request request)
private void	_saxTagsCriteria(String siteName)
private void	_saxTextField(Request request)
private Date	_toDate(String dateStr)
protected void	addMetadataQuery(Collection<Query> queries, String language, Request request) Add query for each metadata
protected String	getContentTypeFilterValue(Request request) Get the content type's filter value
protected Collection<String>	getContentTypes(Request request) Get the content type's
protected Map<String,AbstractSearchGenerator.Criterion>	getCriteria(Request request, String siteName, String lang) Get the criteria with their value list.
protected Collection<String>	getDocumentTypes(Request request) Get the document types.
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<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 Sort	getSortField(Request request) Get the sort field
protected void	saxEnumeratorValueForMetadata(MetadataDefinition metadataDef, String metadataPath) Sax enumeration value for enum metadata
protected void	saxFormFields(Request request, SearchResults<AmetysObject> searchResults, String siteName, String lang) SAX the form search criteria
protected void	saxFormValues(Request request, SearchResults<AmetysObject> searchResults, 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 void	saxMetadataDef(MetadataDefinition metadataDef, String metadataPath) Sax metadata set information for metadata
protected SearchResults<AmetysObject>	search(Request request, Collection<String> siteNames, String language, int pageIndex, int start, int maxResults) Search

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

_additionalSearchProcessing, contextualize, generate, getCriteriaValues, getDocumentTypesQuery, getPageIndex, getSearchMode, isInputValid, saxAdditionalInfos, saxAdditionalInfosOnPageHit, saxContent, saxCriteria, saxCriterion, saxFormParameters, saxPageHit, saxPagination, saxResourceHit, saxServiceIdentifiers, search, service

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 Detail

CONTENT_TYPE_CHOICE_FILTER

protected static final String CONTENT_TYPE_CHOICE_FILTER

Constants for content type's choice : filter

See Also:

Constant Field Values

CONTENT_TYPE_CHOICE_LIST

protected static final String CONTENT_TYPE_CHOICE_LIST

Constants for content type's choice : list

See Also:

Constant Field Values

CONTENT_TYPE_CHOICE_CHECKBOX

protected static final String CONTENT_TYPE_CHOICE_CHECKBOX

Constants for content type's choice : checkbox then filter

See Also:

Constant Field Values

CONTENT_TYPE_CHOICE_CHECKBOX_AND_FILTER

protected static final String CONTENT_TYPE_CHOICE_CHECKBOX_AND_FILTER

Constants for content type's choice : checkbox then filter

See Also:

Constant Field Values

CONTENT_TYPE_CHOICE_NONE

protected static final String CONTENT_TYPE_CHOICE_NONE

Constants for content type's choice : none

See Also:

Constant Field Values

Constructor Detail

SearchGenerator

public SearchGenerator()

Method Detail

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

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.

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.

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

getCriteria

protected Map<String,AbstractSearchGenerator.Criterion> getCriteria(Request request,
                                                                    String siteName,
                                                                    String lang)

Description copied from class: AbstractSearchGenerator

Get the criteria with their value list.

Specified by:

getCriteria in class AbstractSearchGenerator

Parameters:

request - the request.

siteName - the site name.

lang - the language

Returns:

the criteria list.

saxHits

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

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

IOException - If there is a low-level IO error

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,
                             SearchResults<AmetysObject> searchResults,
                             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

searchResults - The search results

siteName - The current site name

lang - The current language

Throws:

SAXException - if an error occurs while SAXing

_saxMetadataCriteria

private void _saxMetadataCriteria(Request request)
                           throws SAXException

Throws:

SAXException

saxMetadataDef

protected void saxMetadataDef(MetadataDefinition metadataDef,
                              String metadataPath)
                       throws SAXException

Sax metadata set information for metadata

Parameters:

metadataDef - The metadata definition.

metadataPath - The metadata path

Throws:

SAXException - If an error occurred while saxing

saxEnumeratorValueForMetadata

protected void saxEnumeratorValueForMetadata(MetadataDefinition metadataDef,
                                             String metadataPath)
                                      throws SAXException

Sax enumeration value for enum metadata

Parameters:

metadataDef - The metadata definition.

metadataPath - The metadata path

Throws:

SAXException - If an error occurred while saxing

saxFormValues

protected void saxFormValues(Request request,
                             SearchResults<AmetysObject> searchResults,
                             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

searchResults - The search results

start - The start index

offset - The number of results

Throws:

SAXException - if an error occurs while SAXing

_saxDates

private void _saxDates(Request request)
                throws SAXException

Throws:

SAXException

_saxTextField

private void _saxTextField(Request request)
                    throws SAXException

Throws:

SAXException

_saxMetadataValues

private void _saxMetadataValues(Request request)
                         throws SAXException

Throws:

SAXException

_saxAllWords

private void _saxAllWords(Request request)
                   throws SAXException

Throws:

SAXException

_saxExactWording

private void _saxExactWording(Request request)
                       throws SAXException

Throws:

SAXException

_saxNoWords

private void _saxNoWords(Request request)
                  throws SAXException

Throws:

SAXException

_saxContentType

private void _saxContentType(Request request)
                      throws SAXException

Throws:

SAXException

_saxTags

private void _saxTags(Request request)
               throws SAXException

Throws:

SAXException

_saxPages

private void _saxPages(Request request)
                throws SAXException

Throws:

SAXException

_saxMultisite

private void _saxMultisite(Request request)
                    throws SAXException

Throws:

SAXException

getContentTypes

protected Collection<String> getContentTypes(Request request)

Get the content type's

Parameters:

request - The request

Returns:

the content type's

_getAvailableContentTypes

private Collection<String> _getAvailableContentTypes()

_getAllContentTypes

private Set<String> _getAllContentTypes()

_saxContentTypeCriteria

private void _saxContentTypeCriteria()
                              throws SAXException

Throws:

SAXException

_saxTagsCriteria

private void _saxTagsCriteria(String siteName)
                       throws SAXException

Throws:

SAXException

_saxTag

private void _saxTag(Tag tag,
                     boolean recursive)
              throws SAXException

Throws:

SAXException

_saxSitemapCriteria

private void _saxSitemapCriteria()
                          throws SAXException

Throws:

SAXException

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

private void _addTextFieldQuery(Collection<Query> queries,
                                String language,
                                Request request)
                         throws IllegalArgumentException

Throws:

IllegalArgumentException

_escapeQueryCharsButNotQuotes

private String _escapeQueryCharsButNotQuotes(String text)

addMetadataQuery

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

Add query for each metadata

Parameters:

queries - The list of query

language - The lang

request - The request

Throws:

IllegalArgumentException - If an error occurred

_addAllWordsTextFieldQuery

private void _addAllWordsTextFieldQuery(Collection<Query> queries,
                                        String language,
                                        Request request)
                                 throws IllegalArgumentException

Throws:

IllegalArgumentException

_addExactWordingTextFieldQuery

private void _addExactWordingTextFieldQuery(Collection<Query> queries,
                                            String language,
                                            Request request)
                                     throws IllegalArgumentException

Throws:

IllegalArgumentException

_addNoWordsTextFieldQuery

private void _addNoWordsTextFieldQuery(Collection<Query> queries,
                                       String language,
                                       Request request)
                                throws IllegalArgumentException

Throws:

IllegalArgumentException

_addContentTypeQuery

private void _addContentTypeQuery(Collection<Query> queries,
                                  Request request)

_addTagsQuery

private void _addTagsQuery(Collection<Query> queries,
                           Request request)

_addPagesQuery

private void _addPagesQuery(Collection<Query> queries,
                            Request request)

_addDateQuery

private void _addDateQuery(Collection<Query> queries,
                           Request request)

_toDate

private Date _toDate(String dateStr)