com.raritantechnologies.webServices
Interface IDocumentContentMapper

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

BasicDocumentContentMapper

public interface IDocumentContentMapper

extends IConfigurable

Configurable interface to manage the 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.

Developed by Raritan Technologies .

Author:

Ted Sullivan

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) Used by GetSourcesMapper to send the SOAP client a Request Schema for full text retrieval.
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.

Method Detail

createRequestContentSchema

public SOAPBodyElement createRequestContentSchema(java.lang.String searchSourceName)

Used by GetSourcesMapper to send the SOAP client a Request Schema for full text retrieval.

createRequestContentSchema

public SOAPBodyElement createRequestContentSchema(IDocumentContentHandler contentHandler)

createDocumentRequest

public RaritanPageContext createDocumentRequest(SOAPEnvelope soapRequest)

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

getUserName

public java.lang.String getUserName(SOAPEnvelope soapRequest)

getPassword

public java.lang.String getPassword(SOAPEnvelope soapRequest)

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