com.raritantechnologies.endeca
Class EndecaSearchSourceFactory

java.lang.Object
  extended bycom.raritantechnologies.searchApp.XMLSearchSourceFactory
      extended bycom.raritantechnologies.endeca.EndecaSearchSourceFactory
All Implemented Interfaces:
IXMLSearchSourceFactory

public class EndecaSearchSourceFactory
extends XMLSearchSourceFactory

Defines a Endeca Information Access Platform source.

XML Configuration Template:
  <SourceType name="[ source name ]" type="EndecaSearchSource" displayName="[ source display name ]"
                 sourceFactoryClass="com.raritantechnologies.endeca.EndecaSearchSourceFactory" 
                 queryProcessor="com.raritantechnologies.endeca.EndecaQueryProcessor"
                 host="[ host name of Endeca DataSearch server ]"
                 port="[ port number of Endeca DataSearch server ]"
                 matchMode="all | allpartial"
                 freeTextField="[ query field that will search all Endeca Fields ]"
                 useEndecaMatchesFunction="[ true|false(default) - if true uses endeca:matches( ) query function ]"
                 blankQueryReturnsAll="true(default)|false" >

   <EndecaTopicRenderer >

    <!-- 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>

   </EndecaTopicRenderer>

   <!-- Field Schema for collections: -->
   <Fields>

    <Field ID="[ abstract field ID" freeTextField="[ true|false(default) ]" >
      <collection_field name="[ endeca field name ]""  >
        <type>ExactMathch</type>
        <matchMode>[ all | partial | any | allpartial | allany | partialmax ]</matchMode>
      </collection_field>
    </Field>

    <etc . . . -->

  </Fields>

  <DimensionSearchFields>
     <!-- one or more Field tags... -->
     <Field ID="[ abstract field name ]" />
  </DimensionSearchFields>


  </SourceType>
 

Developed by Raritan Technologies Inc..

Author:
Pat Crabtree

Constructor Summary
EndecaSearchSourceFactory()
           
 
Method Summary
 SearchSource[] createSearchSources(org.w3c.dom.Element sourceElem, ISearchFieldMapFactory factory)
           
protected  void readInFields(org.w3c.dom.Element sourceElem, ISearchFieldMapFactory factory, EndecaSearchSource endecaSource)
           
 
Methods inherited from class com.raritantechnologies.searchApp.XMLSearchSourceFactory
changeBasePath, initializeFieldFormatters, initializeSource, initializeStaticFields
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EndecaSearchSourceFactory

public EndecaSearchSourceFactory()
Method Detail

createSearchSources

public SearchSource[] createSearchSources(org.w3c.dom.Element sourceElem,
                                          ISearchFieldMapFactory factory)
Specified by:
createSearchSources in interface IXMLSearchSourceFactory
Specified by:
createSearchSources in class XMLSearchSourceFactory

readInFields

protected void readInFields(org.w3c.dom.Element sourceElem,
                            ISearchFieldMapFactory factory,
                            EndecaSearchSource endecaSource)