com.raritantechnologies.webServices
Class BasicSourceSchemaMapper

java.lang.Object
  com.raritantechnologies.webServices.BasicSourceSchemaMapper

All Implemented Interfaces:

IConfigurable, ISourceSchemaMapper

public class BasicSourceSchemaMapper

extends java.lang.Object

implements ISourceSchemaMapper

Generates a source schema for a SOAP client, describing the source, its search fields and display fields.

XML Configuration Template:

   <SchemaMapper sourceNames="[ name(s) of SearchSource(s) ]"
                    class="com.raritantechnologies.webServices.BasicSourceSchemaMapper"
                    addSourceFields="[true(default)|false]"
                    ignoreFieldCase="[true(default)}false]" >
     <Fields>
        <Field ID="[ RTI source field ID ]" name="[ name of field in destination system ]" type="[ type of field ]" 
                  label="[ human readable display name ]" format="[ format of field ]"
                  searchable="[true|false]" displayable="[true|false]" sortable="[true|false]" />
     </Fields>
   </SchemaMapper>
 

XML Output Format:

   <SearchSource>
     <Name>[ source name ]</Name>
     <Type>[ source class ]</Type>
     <Fields>
        <SearchField>
          <FieldID>[ abstract field ID ]</FieldID>
          <Name>[ name of field ]</Name>
          <Type>[ type of field ]</Type>
          <Searchable>[ true|false ]</Searchable>
          <Displayable>[ true|false ]</Displayable>
          <Sortable>[ true|false ]</Sortable>
        </SearchField> 
     </Fields>
   </SearchSource>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Constructor Summary

BasicSourceSchemaMapper()

Method Summary

org.w3c.dom.Element	createSourceSchema(org.w3c.dom.Document doc, java.lang.String sourceName, ISearchFieldMap sfMap)
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

BasicSourceSchemaMapper

public BasicSourceSchemaMapper()

Method Detail

createSourceSchema

public org.w3c.dom.Element createSourceSchema(org.w3c.dom.Document doc,
                                              java.lang.String sourceName,
                                              ISearchFieldMap sfMap)

Specified by:

createSourceSchema in interface ISourceSchemaMapper

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 ISourceSchemaMapper