com.raritantechnologies.searchApp.component
Class MasterTemplateEditor

java.lang.Object
  com.raritantechnologies.searchApp.component.MasterTemplateEditor

All Implemented Interfaces:

IConfigurable, ICustomTag

public class MasterTemplateEditor

extends java.lang.Object

implements ICustomTag

Used to configure a JobProcess job from a set of pluggable component templates.

Individual component template types (such as an ICollectionGateway) are

XML Configuration Template:

   <SystemObject name="[ custom tag name ]" type="MasterTemplateEditor"
                    configurableClass="com.raritantechnologies.searchApp.component.MasterTemplateEditor"
                    templateType="[ type of template: CollectionBuilder, TreeBuilder, TopicSetBuilder etc... ]" >

   <MasterTemplateEditor
       templateType="[ template type, e.g. CollectionBuilder, TreeBuilder, TopicSetBuilder etc... ]"
       action="[ url for editor actions ]" >

     <Components>
       <!-- One or more Element elements: -->
       <Component name="[ display name of the Element ]"
                   interfaceClass="[ fully qualified IConfigurable Interface class name ]"
                   required="[ true|false ]"
                   configKey="[ name that matches {key} section in the master template ]"
                   templateFile="[ name of component template file (if no choice available) ]" >

         <!-- IXMLDataSource that contains a set of ComponentTemplate(s) that could be used -->
         <!-- for this Component.  -->
         <TemplateSource class="[ class of IXMLDataSource ]" >

         </TemplateSource>

       </Component>

     </Components>

     <!-- class that persists final configuration XML -->
     <XMLSaver class="[ class of com.raritantechnologies.xml.dataCollection.IXMLPersist ]" >

     </XMLSaver>

     <TabRenderer class="[ subclass of com.raritantechnologies.searchApp.taglibrary.TabRenderer ]" >

     </TabRenderer>

     <!-- The Output Configuration Template: -->
     <ConfigurationTemplate>
       <![CDATA[

       ]]>
     </ConfigurationTemplate>
     
   </MasterTemplateEditor>
 

Constructor Summary

MasterTemplateEditor()

Method Summary

java.lang.String	getBody(RaritanPageContext pageContext) Returns the tag body.
TabRenderer	getTabRenderer()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	initialize(java.util.Map initParams)

Methods inherited from class java.lang.Object

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

Constructor Detail

MasterTemplateEditor

public MasterTemplateEditor()

Method Detail

getBody

public java.lang.String getBody(RaritanPageContext pageContext)

Description copied from interface: ICustomTag

Returns the tag body.

Specified by:

getBody in interface ICustomTag

Parameters:

pageContext - Platform-neutral page context ( can be used in non J2EE environments such as ASP).

Returns:

The tag body text string.

getTabRenderer

public TabRenderer getTabRenderer()

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

initialize

public void initialize(java.util.Map initParams)

Specified by:

initialize in interface ICustomTag