com.raritantechnologies.webServices
Class StandardOutputMapper

java.lang.Object
  com.raritantechnologies.webServices.StandardOutputMapper

All Implemented Interfaces:

IWebServiceOutputMapper

public class StandardOutputMapper

extends java.lang.Object

implements IWebServiceOutputMapper

Creates a Standard RTI SearchResponse output.

Output Format:

   <SearchRequestResponse>
     <ResultStatus>
       <Status>[ Succeeded | Failed ]</Status>
       <Reason>[ description of failure ]</Reason>
     </ResultStatus>
     <ResultSet>
       <StartRec>[ start record number ]</StartRec>
       <PageSize>[ page size ]</PageSize>
       <TotalDocs>[ total number of hits ]</TotalDocs>
       <Results>
         <SearchResult>
           <SourceName>[ name of search source ]</SourceName>
           <Fields>

             <DataField>
               <Name>[ field name ]</Name>
               <Value>[ field value ]</Value>
             </DataField>
           
             <DataField>
               <Name>[ field name ]</Name>
               <Value>[ field value ]</Value>
             </DataField>

           </Fields>

           <NestedResults>
             <Name>[ name of nested results field ]</Name>
             <Results>
               <SearchResult>
                 <!-- etc... -->
               </SearchResult>
             </Results>
           </NestedResults>

         </SearchResult>

         <SearchResult>

         </SearchResult>

         <!-- etc... -->
       </Results>
     </ResultSet>
  </SearchRequestResponse>
 

XML Configuration Template:

  <OutputMap outputMapperClass="com.raritantechnologies.webServices.StandardOutputMapper" >

    <!-- One or more StringFilters to filter Field values -->
    <StringFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" 
                     fieldID="[ name of result field to filter ]" >

    </StringFilter>

    <!-- etc... -->

    <!-- Optional list of Output Fields -->
    <OutputFields>
      <Field ID="[ id of field to pass through to output message ]" />
      <Field etc... />
    </OutputFields>

  </OutputMap>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Constructor Summary

StandardOutputMapper()

Method Summary

SOAPBodyElement	convertResponse(IResultSet response, java.lang.String status, java.lang.String reason)
void	initialize(org.w3c.dom.Element elem)

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardOutputMapper

public StandardOutputMapper()

Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)

Specified by:

initialize in interface IWebServiceOutputMapper

convertResponse

public SOAPBodyElement convertResponse(IResultSet response,
                                       java.lang.String status,
                                       java.lang.String reason)

Specified by:

convertResponse in interface IWebServiceOutputMapper