no.sesat.search.view.velocity
Class AbstractEnrichmentDirective

java.lang.Object
  org.apache.velocity.runtime.directive.Directive
      no.sesat.search.view.velocity.AbstractDirective
          no.sesat.search.view.velocity.AbstractEnrichmentDirective

All Implemented Interfaces:

Cloneable, org.apache.velocity.runtime.directive.DirectiveConstants

public abstract class AbstractEnrichmentDirective
extends AbstractDirective

Handles presenting the enrichments The first argument allow inclusion/exclusion of each enrichment according to the subclasses implementation of placementCorrect(tab, placement, i, e)

The second argument specifies the a string to use in beginning wrapping around each enrichment. a third argument is expected for end wrapping. If no argument is specified no div is written around each enrichment.)

The enrichments that are rendered are those named as the results field for EnrichmentHint.NAME_KEY within the "templates/enrichments/${placement}/" directory. If this is not found then the same named template within the "templates/enrichments/" directory is used.

Version:

$Id: AbstractEnrichmentDirective.java 7225 2009-04-09 00:32:20Z ssmiweve $

Field Summary

Fields inherited from class org.apache.velocity.runtime.directive.Directive

rsvc

Fields inherited from interface org.apache.velocity.runtime.directive.DirectiveConstants

BLOCK, LINE

Constructor Summary

AbstractEnrichmentDirective()

Method Summary

String	getName()
int	getType()
protected abstract boolean	placementCorrect(DataModel datamodel, String placement, int i, ResultList e)
boolean	render(org.apache.velocity.context.InternalContextAdapter cxt, Writer writer, org.apache.velocity.runtime.parser.node.Node node)

Methods inherited from class no.sesat.search.view.velocity.AbstractDirective

getArgument, getDataModel, getObjectArgument

Methods inherited from class org.apache.velocity.runtime.directive.Directive

getColumn, getLine, init, setLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEnrichmentDirective

public AbstractEnrichmentDirective()

Method Detail

getName

public String getName()

Specified by:

getName in class org.apache.velocity.runtime.directive.Directive

getType

public int getType()

Specified by:

getType in class org.apache.velocity.runtime.directive.Directive

render

public boolean render(org.apache.velocity.context.InternalContextAdapter cxt,
                      Writer writer,
                      org.apache.velocity.runtime.parser.node.Node node)
               throws IOException,
                      org.apache.velocity.exception.ResourceNotFoundException,
                      org.apache.velocity.exception.ParseErrorException,
                      org.apache.velocity.exception.MethodInvocationException

Specified by:

render in class org.apache.velocity.runtime.directive.Directive

Parameters:

cxt - The cxt.

writer - The writer.

node - The node.

Returns:

return true on success.

Throws:

IOException

org.apache.velocity.exception.ResourceNotFoundException

org.apache.velocity.exception.ParseErrorException

org.apache.velocity.exception.MethodInvocationException

placementCorrect

protected abstract boolean placementCorrect(DataModel datamodel,
                                            String placement,
                                            int i,
                                            ResultList e)