Package org.ametys.web.frontoffice.search.metamodel

Interface ReturnableSaxer

All Known Implementing Classes:

ContentSaxer, CourseSaxer, PageSaxer, ProgramSaxer, ResourceSaxer, UserPageReturnable.UserSaxer

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	Description
boolean	canSax(AmetysObject hit, Logger logger, SearchComponentArguments args)	Returns true if this saxer is able to SAX the given search hit
default String	getIdentifier()	Gets this Saxer identifier.
void	sax(ContentHandler contentHandler, AmetysObject hit, Logger logger, SearchComponentArguments args)	SAX the given search hit

Method Details

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

getIdentifier

default String getIdentifier()

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 getIdentifier() by returning its superclass name, in order to match the same XSL templates.

Returns:

this Saxer identifier