com.raritantechnologies.federated.z3950
Class Z3950SearchSourceFactory

java.lang.Object
  com.raritantechnologies.searchApp.XMLSearchSourceFactory
      com.raritantechnologies.federated.z3950.Z3950SearchSourceFactory

All Implemented Interfaces:

IXMLSearchSourceFactory

public class Z3950SearchSourceFactory

extends XMLSearchSourceFactory

Responsible for constructing Z3950SearchSource objects from <SourceType> XML tags.

XML Configuration Template:

   <SourceType name="[source name]" 
                  type="Z3950SearchSource" 
                  displayName="[ Displayable Name]"
                  sourceFactoryClass="com.raritantechnologies.federated.z3950.Z3950SearchSourceFactory" 
                  queryProcessor="com.raritantechnologies.federated.z3950.Z3950QueryProcessor" >

      <Z3950Service serviceHost="[ z3950 host. Example: 'lib.leeds.ac.uk']" 
                  maxresults="[maximum number of results per request]"
                  servicePort="[connection port Example: '210']"
                  serviceShortName="[ short name of service Example:'Leeds' ]"
                  serviceLongName="[ long name of service Example:'Leeds university default database']"
                  defaultRecordSyntax="[ record syntax to use usually 'usmarc']"
                  collectionId="[ name of collection at host Example:'INNOPAC']"
                  searchUrl="[base search url at host Example:'http://lib.leeds.ac.uk/search/t?SEARCH=']"
                  attributeSet="[Z3950 attribute set to use Example:'bib-1']"
                  version="[Z3950 Version Example:'1']" 
                  userID="[user]"
                  password="[password]"
                  prefixQueryField="[ input field that takes a preformed prefix query ]" />

      <!-- AttributeList tag describes which Z39.50 fields to retrieve from host and how these -->
      <!-- fields map to Raritan result field IDs. -->
	<AttributeList>
        <!-- contains one or more Attribute elements -->
        <Attribute code="[Z39.50 code Example:'1']" 
                      value="[Z39.50 field name Example:'Personal name']"  
                      field="[Raritan fieldID]" />
        <!-- Example -->
        <Attribute code="2" value="Corporate name" field="AU" />
      </AttributeList>

      <ResultMap>
        <title>[ title code ]</title>
        <summary>[ summary code ]</summary>

        <code iso2709="[ iso2709 code ]" fieldName="[ field name ]" />
        <code etc... >
      </ResultMap>

      <!-- If the record type is XML - use and XMLResultProcessor -->
      <XMLResultProcessor>

      </XMLResultProcessor>

  </SourceType>
 

Developed by Raritan Technologies Inc..

Author:

Glenn Robitaille, Ted Sullivan

Constructor Summary

Z3950SearchSourceFactory()

Method Summary

SearchSource[]

createSearchSources(org.w3c.dom.Element sourceElem, ISearchFieldMapFactory factory)

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

Z3950SearchSourceFactory

public Z3950SearchSourceFactory()

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