Interface ReturnableSaxer
-
- All Known Implementing Classes:
ContentSaxer
,CourseSaxer
,PageSaxer
,ProgramSaxer
,ResourceSaxer
,UserReturnable.UserSaxer
public interface ReturnableSaxer
An object returned byReturnable.getSaxer(java.util.Collection<org.ametys.web.frontoffice.search.metamodel.Returnable>, org.ametys.web.frontoffice.search.metamodel.AdditionalParameterValueMap)
to SAX hits (results)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description boolean
canSax(AmetysObject hit, org.slf4j.Logger logger, SearchComponentArguments args)
Returnstrue
if this saxer is able to SAX the given search hitdefault String
getIdentifier()
Gets this Saxer identifier.void
sax(ContentHandler contentHandler, AmetysObject hit, org.slf4j.Logger logger, SearchComponentArguments args)
SAX the given search hit
-
-
-
Method Detail
-
canSax
boolean canSax(AmetysObject hit, org.slf4j.Logger logger, SearchComponentArguments args)
Returnstrue
if this saxer is able to SAX the given search hit- Parameters:
hit
- The search hitlogger
- A loggerargs
- The other arguments- Returns:
true
if this saxer is able to SAX the given search hit
-
sax
void sax(ContentHandler contentHandler, AmetysObject hit, org.slf4j.Logger logger, SearchComponentArguments args) throws SAXException
SAX the given search hit- Parameters:
contentHandler
- The content handlerhit
- The search hitlogger
- A loggerargs
- 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 aReturnableSaxer
implementation can extend another Saxer and overridegetIdentifier()
by returning its superclass name, in order to match the same XSL templates.- Returns:
- this Saxer identifier
-
-