Z3950SearchSource

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.raritantechnologies.federated.z3950
Class Z3950SearchSource

java.lang.Object
  com.raritantechnologies.searchApp.SearchSource
      com.raritantechnologies.federated.z3950.Z3950SearchSource

public class Z3950SearchSource
extends SearchSource

Defines a Z3950 Search Source - an open Internet protocol.

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]"    />

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

  </SourceType>

Developed by Raritan Technologies Inc..

Author:: Glenn Robitaille, Ted Sullivan

Field Summary

Fields inherited from class com.raritantechnologies.searchApp.SearchSource

ID_FIELD, IS_FEDERATED, NUMBER_OF_FIELDS, SECURE, SOURCE_NAME, SOURCE_TYPE, TITLE_FIELD, URL_FIELD

Constructor Summary
`Z3950SearchSource()`

Method Summary
`java.lang.String`	`constructSimplePrefixQuery(java.util.Map inputParameters)` Constructs a Prefix Query Notation query that can be parsed into a Z3950 RPNQuery by the JZKit.
`Z3950AttributeList`	`getAttributeList()`
`java.lang.String`	`getAttributeSet()`
`java.lang.String`	`getCollectionId()`
`java.lang.String`	`getDefaultRecordSyntax()`
`java.lang.String`	`getpassword()`
`java.lang.String`	`getPrefixQueryField()`
`java.lang.Object`	`getProperty(java.lang.String property)` returns a Source Property.
`IQueryProcessor`	`getQueryProcessor()` returns the type of QueryProcessor that can access this SearchSource.
`java.util.Map`	`getResultMap()`
`java.lang.String`	`getServiceHost()`
`java.lang.String`	`getServiceLongName()`
`java.lang.String`	`getServicePort()`
`java.lang.String`	`getServiceShortName()`
`java.lang.String[]`	`getSourcePropertyNames()` Returns a list of Source type specific property names.
`java.lang.String`	`getSummaryCode()`
`java.lang.String`	`getTitleCode()`
`java.lang.String`	`getuserID()`
`java.lang.String`	`getVersion()`
`XMLResultProcessor`	`getXMLResultProcessor()`
`void`	`setAttributeList(Z3950AttributeList zAttrList)`
`void`	`setAttributeSet(java.lang.String attributeSet)`
`void`	`setCollectionId(java.lang.String collectionId)`
`void`	`setDefaultRecordSyntax(java.lang.String defaultRecordSyntax)`
`void`	`setpassword(java.lang.String password)`
`void`	`setPrefixQueryField(java.lang.String prefixQueryField)`
`void`	`setResultMap(java.util.Map resultMap)` get the map for ISO 2709 Code --> field name
`void`	`setServiceHost(java.lang.String serviceHost)`
`void`	`setServiceLongName(java.lang.String serviceLongName)`
`void`	`setServicePort(java.lang.String servicePort)`
`void`	`setServiceShortName(java.lang.String serviceShortName)`
`void`	`setSummaryCode(java.lang.String summaryCode)` Set/get the iso 2709 field code for "summary"
`void`	`setTitleCode(java.lang.String titleCode)` Set/get the iso 2709 field code for "title"
`void`	`setuserID(java.lang.String userID)`
`void`	`setVersion(java.lang.String version)`
`void`	`setXMLResultProcessor(XMLResultProcessor xmlResProc)`

Methods inherited from class com.raritantechnologies.searchApp.SearchSource

addFieldFormatter, addSearchField, addSourceAttributes, addStaticField, addStaticFields, addUserSearchField, canAccess, canConsolidateSources, consolidateSources, delSearchField, formatResult, formatResult, formatResultField, formatResultField, formatResults, formatResults, getAccessableFields, getAttributes, getBasePath, getConfigPath, getDisplayName, getFieldFormatters, getIDField, getName, getSearchField, getSearchFieldID, getSearchFields, getSearchFields, getSecondarySortSpec, getSecurityManager, getSecurityManagerName, getSecurityModel, getSortSpec, getSourceCredentials, getTitleField, getType, getURLField, getUserSearchFields, isMultiThreaded, setConfigPath, setDisplayName, setIDField, setMultiThreaded, setName, setSecurityManagerName, setSecurityModel, setSortMap, setSourcePropertyInfoSource, setTitleField, setType, setURLField, shouldFormatResults, supportsBackgroundSort

Methods inherited from class java.lang.Object

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

Constructor Detail