com.raritantechnologies.verity.topic
Class VQLTopicRenderer

java.lang.Object
  com.raritantechnologies.verity.topic.VQLTopicRenderer

All Implemented Interfaces:

IConfigurable, ITopicRenderer

public class VQLTopicRenderer

extends java.lang.Object

implements ITopicRenderer

Topic Renderer for Verity Query Language (VQL).

XML Configuration Template:

   <TopicRenderer class="com.raritantechnologies.verity.topic.VQLTopicRenderer" >

     <!-- list of supported fields, a field can either be freetext, zone or field -->
     <Fields>
       <Field ID="[ fieldID ]" type="[FIELD|ZONE|FREETEXT]"  />
     </Fields>

   </TopicRenderer>
 

Constructor Summary

VQLTopicRenderer()

Method Summary

void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
java.lang.String	renderTopic(Topic topic)
java.lang.String	renderTopic(Topic topic, java.util.Set subTopics, boolean skipSubTopics)

Methods inherited from class java.lang.Object

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

Constructor Detail

VQLTopicRenderer

public VQLTopicRenderer()

Method Detail

renderTopic

public java.lang.String renderTopic(Topic topic)

Specified by:

renderTopic in interface ITopicRenderer

renderTopic

public java.lang.String renderTopic(Topic topic,
                                    java.util.Set subTopics,
                                    boolean skipSubTopics)

Specified by:

renderTopic in interface ITopicRenderer

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable