com.raritantechnologies.endeca
Class EndecaTopicRenderer

java.lang.Object
  com.raritantechnologies.endeca.EndecaTopicRenderer

All Implemented Interfaces:

IConfigurable, ITopicRenderer

public class EndecaTopicRenderer

extends java.lang.Object

implements ITopicRenderer

Renders a topic in Endeca's Query Language.

XML Configuration Template:

   <TopicRenderer class="com.raritantechnologies.endeca.EndecaTopicRenderer" 
                     endecaSource="[ name of Endeca Search Source ]"
                     nearDistance="[ distance for proximity matches ]"
                     matchMode="[ all| any | partial | allpartial | allany | partialmax ]" >

    <!-- Optional Field mapping -->
    <Fields onlyUseMappedFields="[ true|false(default) ]">
      <Field ID="[ abstract fieldID ]" collectionField="[ name of field in collection (or 'FREETEXT') ]" type="[number|text|date]"/>
    </Fields>

   </TopicREnderer>
 

*

Author:

Pat Crabtree

Constructor Summary

EndecaTopicRenderer()

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)
void	setEndecaSearchSource(EndecaSearchSource endecaSearchSource)

Methods inherited from class java.lang.Object

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

Constructor Detail

EndecaTopicRenderer

public EndecaTopicRenderer()

Method Detail

setEndecaSearchSource

public void setEndecaSearchSource(EndecaSearchSource endecaSearchSource)

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