Package org.ametys.plugins.userdirectory.service.search

Class UserReturnable.UserSaxer

java.lang.Object

org.ametys.web.frontoffice.search.metamodel.impl.PageSaxer

org.ametys.plugins.userdirectory.service.search.UserReturnable.UserSaxer

All Implemented Interfaces:

ReturnableSaxer

Enclosing class:

UserReturnable

public class UserReturnable.UserSaxer
extends PageSaxer

The ReturnableSaxer for user contents.
Their pages are SAXed.

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<String>	_allContentTypes	The user content types selected in the additional parameter of the current servicee instance (and their descendants)

Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.PageSaxer

_pageReturnable

Constructor Summary

Constructors

Constructor	Description
UserSaxer(AdditionalParameterValueMap additionalParameterValues)	Constructor

Method Summary

Modifier and Type	Method	Description
protected SearchContext	_getSearchContext(SearchComponentArguments args)	Gets the search context to use to determine site and sitemap as to resolve user pages from user contents
protected String	_getSitemapName(SearchComponentArguments args, SearchContext searchContext, Content userContent)	Gets the sitemap name
protected String	_getSiteName(SearchComponentArguments args, SearchContext searchContext)	Gets the site name
protected UserPage	_resolveUserPage(Content userContent, String siteName, String sitemapName)	Resolves the use page corresponding to the user content
protected void	_saxUserPage(ContentHandler contentHandler, UserPage userPage, Logger logger, SearchComponentArguments args)	Sax the user page
boolean	canSax(AmetysObject hit, Logger logger, SearchComponentArguments args)	Returns true if this saxer is able to SAX the given search hit
String	getIdentifier()	Gets this Saxer identifier.
void	sax(ContentHandler contentHandler, AmetysObject hit, Logger logger, SearchComponentArguments args)	SAX the given search hit

Methods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.PageSaxer

saxContent, saxRichTextExcerpt

Methods inherited from class java.lang.Object

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

Field Details

_allContentTypes

protected Collection<String> _allContentTypes

The user content types selected in the additional parameter of the current servicee instance (and their descendants)

Constructor Details

UserSaxer

public UserSaxer(AdditionalParameterValueMap additionalParameterValues)

Constructor

Parameters:

additionalParameterValues - The additional parameter values

Method Details

getIdentifier

public String getIdentifier()

Description copied from interface: ReturnableSaxer

Gets this Saxer identifier.
Most of the time you don't need to override this method and keep the default implementation which takes the runtime class name.
This identifier is used to match some XSL templates.
Thus, it does not have to be a unique identifier; for instance a ReturnableSaxer implementation can extend another Saxer and override ReturnableSaxer.getIdentifier() by returning its superclass name, in order to match the same XSL templates.

Returns:

this Saxer identifier

canSax

public boolean canSax(AmetysObject hit,
 Logger logger,
 SearchComponentArguments args)

Description copied from interface: ReturnableSaxer

Returns true if this saxer is able to SAX the given search hit

Specified by:

canSax in interface ReturnableSaxer

Overrides:

canSax in class PageSaxer

Parameters:

hit - The search hit

logger - A logger

args - The other arguments

Returns:

true if this saxer is able to SAX the given search hit

sax

public void sax(ContentHandler contentHandler,
 AmetysObject hit,
 Logger logger,
 SearchComponentArguments args)
         throws SAXException

Description copied from interface: ReturnableSaxer

SAX the given search hit

Specified by:

sax in interface ReturnableSaxer

Overrides:

sax in class PageSaxer

Parameters:

contentHandler - The content handler

hit - The search hit

logger - A logger

args - The other arguments

Throws:

SAXException - if a SAX error occured

_getSearchContext

protected SearchContext _getSearchContext(SearchComponentArguments args)

Gets the search context to use to determine site and sitemap as to resolve user pages from user contents

Parameters:

args - The search arguments

Returns:

The search context

_getSiteName

protected String _getSiteName(SearchComponentArguments args,
 SearchContext searchContext)

Gets the site name

Parameters:

args - The search arguments

searchContext - The search context

Returns:

the site name

_getSitemapName

protected String _getSitemapName(SearchComponentArguments args,
 SearchContext searchContext,
 Content userContent)

Gets the sitemap name

Parameters:

args - The search arguments

searchContext - The search context

userContent - The user content (current hit)

Returns:

the sitemap name

_resolveUserPage

protected UserPage _resolveUserPage(Content userContent,
 String siteName,
 String sitemapName)

Resolves the use page corresponding to the user content

Parameters:

userContent - The user content

siteName - The site name

sitemapName - The sitemap name

Returns:

The user page

_saxUserPage

protected void _saxUserPage(ContentHandler contentHandler,
 UserPage userPage,
 Logger logger,
 SearchComponentArguments args)
                     throws SAXException

Sax the user page

Parameters:

contentHandler - The content handler

userPage - The user page

logger - The logger

args - The search arguments

Throws:

SAXException - if a SAX error occured