com.raritantechnologies.rql.topic
Class CollectionGatewayTopicSetBuilder

java.lang.Object
  com.raritantechnologies.rql.topic.CollectionGatewayTopicSetBuilder

All Implemented Interfaces:

IConfigurable, ITopicSetBuilder

public class CollectionGatewayTopicSetBuilder

extends java.lang.Object

implements ITopicSetBuilder

Builds a TopicSet from a set of IResults generated by an ICollectionGateway.

XML Configuration Template:

   <TopicSetBuilder class="com.raritantechnologies.rql.topic.CollectionGatewayTopicSetBuilder" >

     <CollectionGateway class="[ class of com.raritantechnologies.searchApp.dataCollection.ICollectionGateway" >

     </CollectionGateway>

     <!-- Optional IResultSetProcessor to filter the Result Set before transforming to Topics -->
     <ResultSetProcessor class="[ class of com.raritantechnologies.searchApp.IResultSetProcessor ]" >

     </ResultSetProcessor>

     <!-- One ResultTopicMap to define the mapping of IResult fields to topic name field and term fields -->
     <ResultTopicMap nameField="[ result field that gets topic name ]" 
                        defaultTopicName="[ optional default topic name (if nameField value is missing - default='Topic') ]"
                        termOperator="[ AND | OR(default) ]"
                        searchFields="[ comma separate list of search fields to use for fielded (IN) Topic ]" >

       <!-- One or more term fields. -->
       <TermField name="[ name of IResult Field ]" />

       <!-- Alternatively - can use an ITopicParser to transform a result field value into a topic -->
       <TopicParser queryField="[ result field that has input to the topic parser  ]" >
         <Parser class="[ class of com.raritantechnologies.rql.topic.ITopicParser ]" >

         </Parser>
       </TopicParser>

       <!-- Result fields that are added as Topic attributes (used for tagging purposes) -->
       <TopicAttributes>
         <Attribute resultField="[ name of result field ]" topicAttribute="[ name of topic attribute ]" />
       </TopicAttributes>

     </ResultTopicMap>
     
     <NestedResultTopic nestedResultField="[ name of nested Result Field ]" operator="[ AND | OR | NOT ]" >

       <ResultTopicMap nameField="[ result field that gets topic name ]" 
                          termOperator="[ AND | OR(default) ]" >

       </ResultTopicMap>

     </NestedResultTopic>

   </TopicSetBuilder>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

CollectionGatewayTopicSetBuilder()

Method Summary

TopicSet	buildTopicSet(RaritanPageContext pageContext)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionGatewayTopicSetBuilder

public CollectionGatewayTopicSetBuilder()

Method Detail

buildTopicSet

public TopicSet buildTopicSet(RaritanPageContext pageContext)

Specified by:

buildTopicSet in interface ITopicSetBuilder

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