org.ametys.web.frontoffice.search.metamodel

Interface ReturnableSaxer

All Known Implementing Classes:

ContentSaxer, CourseSaxer, PageSaxer, ProgramSaxer, ResourceSaxer

public interface ReturnableSaxer

An object returned by Returnable.getSaxer(java.util.Collection<org.ametys.web.frontoffice.search.metamodel.Returnable>, org.ametys.web.frontoffice.search.metamodel.AdditionalParameterValueMap) to SAX hits (results)

Method Summary

Modifier and Type	Method and Description
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

Method Detail

canSax

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

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

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

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

SAX the given search hit

Parameters:

contentHandler - The content handler

hit - The search hit

logger - A logger

args - The other arguments

Throws:

SAXException - if a SAX error occured