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

Class PageSaxer

java.lang.Object

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

All Implemented Interfaces:

ReturnableSaxer

Direct Known Subclasses:

CourseSaxer, ProgramSaxer

public class PageSaxer
extends Object
implements ReturnableSaxer

ReturnableSaxer for PageReturnable

Field Summary

Fields

Modifier and Type	Field and Description
protected PageReturnable	_pageReturnable The associated returnable on pages

Constructor Summary

Constructors

Constructor and Description
PageSaxer(PageReturnable pageReturnable) Constructor

Method Summary

Modifier and Type	Method and Description
private static Stream<Content>	_pageContents(Page page)
private void	_saxLastDate(Page page, Function<Content,Date> dateRetriever, ContentHandler handler, String tagName)
private void	_saxLastModifiedDate(Page page, ContentHandler handler)
private void	_saxLastValidationDate(Page page, ContentHandler handler)
private void	_saxPageContents(Page page, ContentHandler handler, Logger logger)
boolean	canSax(AmetysObject hit, Logger logger, SearchComponentArguments args) Returns true if this saxer is able to SAX the given search hit
void	sax(ContentHandler contentHandler, AmetysObject hit, Logger logger, SearchComponentArguments args) SAX the given search hit
protected void	saxContent(Content content, String metadataSetName, Locale defaultLocale, ContentHandler contentHandler, Logger logger) SAX the metadata set of a content if exists
protected void	saxRichTextExcerpt(String metadataPath, String contentId, Object richText, ContentHandler contentHandler, Logger logger) SAX excerpt for rich text

Methods inherited from class java.lang.Object

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

Field Detail

_pageReturnable

protected PageReturnable _pageReturnable

The associated returnable on pages

Constructor Detail

PageSaxer

public PageSaxer(PageReturnable pageReturnable)

Constructor

Parameters:

pageReturnable - The associated returnable on pages

Method Detail

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

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

Parameters:

contentHandler - The content handler

hit - The search hit

logger - A logger

args - The other arguments

Throws:

SAXException - if a SAX error occured

_saxPageContents

private void _saxPageContents(Page page,
                              ContentHandler handler,
                              Logger logger)

_saxLastModifiedDate

private void _saxLastModifiedDate(Page page,
                                  ContentHandler handler)
                           throws SAXException

Throws:

SAXException

_saxLastValidationDate

private void _saxLastValidationDate(Page page,
                                    ContentHandler handler)
                             throws SAXException

Throws:

SAXException

_saxLastDate

private void _saxLastDate(Page page,
                          Function<Content,Date> dateRetriever,
                          ContentHandler handler,
                          String tagName)
                   throws SAXException

Throws:

SAXException

_pageContents

private static Stream<Content> _pageContents(Page page)

saxContent

protected void saxContent(Content content,
                          String metadataSetName,
                          Locale defaultLocale,
                          ContentHandler contentHandler,
                          Logger logger)
                   throws SAXException

SAX the metadata set of a content if exists

Parameters:

content - the content

metadataSetName - The name of metadata set to sax

defaultLocale - The locale to use to sax localized values such as multilingual content or multilingual string. Only use if initial content's language is not null.

contentHandler - The content handler

logger - The logger

Throws:

SAXException - if an exception occurs while saxing

saxRichTextExcerpt

protected void saxRichTextExcerpt(String metadataPath,
                                  String contentId,
                                  Object richText,
                                  ContentHandler contentHandler,
                                  Logger logger)

SAX excerpt for rich text

Parameters:

metadataPath - The path of metadata

contentId - The content id

richText - The rich text

contentHandler - The content handler

logger - The logger