com.raritantechnologies.webServices
Class BasicDocumentContentMapper

java.lang.Object
  com.raritantechnologies.webServices.BasicDocumentContentMapper

All Implemented Interfaces:

IConfigurable, IDocumentContentMapper

public class BasicDocumentContentMapper

extends java.lang.Object

implements IDocumentContentMapper

Basic implementation of mapping between search results and full text retrieval. Used by the ContentHandlerMapper to send required result fields to be sent by the client to retrieve the document full text for a given Search Source, and to convert the client metadata request into an IDocumentContentHandler request.

XML Configuration Template:

   <ContentRequestMapper class="com.raritantechnologies.webServices.BasicDocumentContentMapper" >
     <Source names="[ names of sources that use this request map ]" >
       <Fields>
         <Field ID="fieldID" name="name of request parameter"
                   fieldDelim="[ optional delimiter for fields ]"
                   valueDelim="[ optional delimiter for values ]"
                   startPattern="[ RegExpr pattern that preceeds delimited String ]"
                   endPattern="[ RegExpr pattern that follows delimited String ]"
                   indexOf="[ alternatively - set starting point for name=value pairs ]" >

           <!-- Optional String filter for final Value translation -->
           <StringFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >

           </StringFilter>
         </Field>
       </Fields>

       <FixedParams>
         <Param name="[ name of param ]" value="[ value of param ]" />
       </FixedParams>

       <!-- Alternatively: use the IDocumentContentHandler getRequestParameters( ) method -->
       <!-- with mapping to the remote field/column Name -->

     </Source>
   </ContentRequestMapper>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

BasicDocumentContentMapper()

Method Summary

RaritanPageContext	createDocumentRequest(SOAPEnvelope soapRequest) Used by the ContentHandlerMapper to convert a SOAP request into a IDocumentContentHandler input.
SOAPBodyElement	createRequestContentSchema(IDocumentContentHandler contentHandler)
SOAPBodyElement	createRequestContentSchema(java.lang.String searchSourceName) Returns a SOAPBodyElement with the following schema: <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <ns1:ContentFormatRequestResponse> <SourceName> <Fields> <SearchField> <FieldID> <Name> <Label> <Type> <Format> <Searchable>false <Displayable>false <Sortable>false </SearchField> </Fields> </ns1:ContentFormatRequestResponse> </SOAP-ENV:Body>
java.lang.String	getPassword(SOAPEnvelope soapRequest)
java.lang.String	getUserName(SOAPEnvelope soapRequest)
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

BasicDocumentContentMapper

public BasicDocumentContentMapper()

Method Detail

createRequestContentSchema

public SOAPBodyElement createRequestContentSchema(java.lang.String searchSourceName)

Returns a SOAPBodyElement with the following schema: <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <ns1:ContentFormatRequestResponse> <SourceName> <Fields> <SearchField> <FieldID> <Name> <Label> <Type> <Format> <Searchable>false <Displayable>false <Sortable>false </SearchField> </Fields> </ns1:ContentFormatRequestResponse> </SOAP-ENV:Body>

Specified by:

createRequestContentSchema in interface IDocumentContentMapper

createRequestContentSchema

public SOAPBodyElement createRequestContentSchema(IDocumentContentHandler contentHandler)

Specified by:

createRequestContentSchema in interface IDocumentContentMapper

createDocumentRequest

public RaritanPageContext createDocumentRequest(SOAPEnvelope soapRequest)

Used by the ContentHandlerMapper to convert a SOAP request into a IDocumentContentHandler input.

Specified by:

createDocumentRequest in interface IDocumentContentMapper

getUserName

public java.lang.String getUserName(SOAPEnvelope soapRequest)

Specified by:

getUserName in interface IDocumentContentMapper

getPassword

public java.lang.String getPassword(SOAPEnvelope soapRequest)

Specified by:

getPassword in interface IDocumentContentMapper

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 IDocumentContentMapper