MainJavadocSource
DQLSearchSource

com.raritantechnologies.federated.DQL
Class DQLSearchSource

java.lang.Object
  extended bycom.raritantechnologies.searchApp.SearchSource
      extended bycom.raritantechnologies.federated.DQL.DQLSearchSource

public class DQLSearchSource
extends SearchSource

RTI SearchSource that can retrieve records from a Documentum Docbase.

XML Configuration Template:
  <SourceType name="[ source name ]" type="DQLSearchSource" displayName="[ source display name ]"
                 sourceFactoryClass="com.raritantechnologies.federated.DQL.DQLSearchSourceFactory" 
                 queryProcessor="com.raritantechnologies.federated.DQL.DQLQueryProcessor" >

    <LoginProcess>
      <UserName>[ user name ]</UserName>
      <!-- Password can be in the clear or encrypted: -->
      <Password>[ clear text password ]</Password>

      <PasswordEnc>[ encrypted password ]</PasswordEnc>

    </LoginProcess>

    <SearchProcess>

    </SearchProcess>

    <ResultMap>
      <ResultField fieldID="status" colName="description" append="true|false" >
      <ResultField fieldID="itemID" colName="item_id">
    </ResultMap>

  </SourceType>
 

Developed by Raritan Technologies Inc..

Author:
Glenn Robitaille

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
DQLSearchSource()
           
 
Method Summary
 voidaddDQLTemplate(java.lang.String dqlTmpl)
          Save the DQL template
 voidaddQueryColumns(org.w3c.dom.Element sourceElem)
          add the query columns to "IDtoColMap".
 voidaddResultFields(org.w3c.dom.NodeList resultMap)
          add the result fields from the sections of the .
 com.raritantechnologies.federated.DQL.DQLSearchSource.DQLResultexecuteDQL(java.lang.String username, java.lang.String password, java.lang.String dbURI, java.util.Map inParams, int startRec, int maxDocs)
           
 intgetMaxDocCount()
           
 java.lang.ObjectgetProperty(java.lang.String property)
          returns a Source Property.
 IQueryProcessorgetQueryProcessor()
          get a IQueryProcessor object (currently a DQLQueryProcessor)
 com.raritantechnologies.federated.DQL.DQLSearchSource.DQLResultgetSearchProcess(java.util.Map inputParameters, int startRec, ILoginInfo userInfo)
          get an ArrayList of search processes.
 java.lang.String[]getSourcePropertyNames()
          Returns a list of Source type specific property names.
static booleanisDEBUG()
           
 voidsetDBConnection(java.lang.String DBURI, java.lang.String UID, java.lang.String PASSWD)
          save the documentum database parameters.
 voidsetUseFullText(java.lang.String useFText)
           
 voidsetUseSessionLogin(java.lang.String useSess)
           
 
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

DQLSearchSource

public DQLSearchSource()
Method Detail

getQueryProcessor

public IQueryProcessor getQueryProcessor()
get a IQueryProcessor object (currently a DQLQueryProcessor)

Specified by:
getQueryProcessor in class SearchSource

getSourcePropertyNames

public java.lang.String[] getSourcePropertyNames()
Description copied from class: SearchSource
Returns a list of Source type specific property names.

Overrides:
getSourcePropertyNames in class SearchSource

getProperty

public java.lang.Object getProperty(java.lang.String property)
Description copied from class: SearchSource
returns a Source Property. The standard pattern is to return a String or Object if a property has a single value and a String or Object Array if the property has multiple values.

Overrides:
getProperty in class SearchSource

getMaxDocCount

public int getMaxDocCount()

getSearchProcess

public com.raritantechnologies.federated.DQL.DQLSearchSource.DQLResult getSearchProcess(java.util.Map inputParameters,
                                                                                        int startRec,
                                                                                        ILoginInfo userInfo)
get an ArrayList of search processes.


setDBConnection

public void setDBConnection(java.lang.String DBURI,
                            java.lang.String UID,
                            java.lang.String PASSWD)
save the documentum database parameters.


addQueryColumns

public void addQueryColumns(org.w3c.dom.Element sourceElem)
add the query columns to "IDtoColMap". This corresponds to the . Store the ID and the op (operator, e.g. "like").


addDQLTemplate

public void addDQLTemplate(java.lang.String dqlTmpl)
Save the DQL template


addResultFields

public void addResultFields(org.w3c.dom.NodeList resultMap)
add the result fields from the sections of the .


executeDQL

public com.raritantechnologies.federated.DQL.DQLSearchSource.DQLResult executeDQL(java.lang.String username,
                                                                                  java.lang.String password,
                                                                                  java.lang.String dbURI,
                                                                                  java.util.Map inParams,
                                                                                  int startRec,
                                                                                  int maxDocs)
                                                                           throws DfException
Throws:
DfException

setUseFullText

public void setUseFullText(java.lang.String useFText)

isDEBUG

public static boolean isDEBUG()

setUseSessionLogin

public void setUseSessionLogin(java.lang.String useSess)