MainJavadocSource
SQLSearchSource

com.raritantechnologies.federated.SQL
Class SQLSearchSource

java.lang.Object
  extended bycom.raritantechnologies.searchApp.SearchSource
      extended bycom.raritantechnologies.federated.SQL.SQLSearchSource

public class SQLSearchSource
extends SearchSource

Converts any SQL-compliant relational database to a Raritan SearchSource.


Developed by Raritan Technologies Inc..

Author:
Bill Ellis

Nested Class Summary
 classSQLSearchSource.QueryColumn
           
 
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
SQLSearchSource()
           
 
Method Summary
 voidaddQueryColumns(org.w3c.dom.Element sourceElem)
           
 voidaddResultFields(org.w3c.dom.NodeList resultMap)
           
 voidaddSQLTemplate(java.lang.String sqlTmpl)
           
 booleangetBlankQueryReturnsAll()
           
 voidgetJNDIConnection()
           
 java.lang.ObjectgetProperty(java.lang.String property)
          returns a Source Property.
 IQueryProcessorgetQueryProcessor()
          returns the type of QueryProcessor that can access this SearchSource.
 java.util.ArrayListgetSearchProcess(java.util.Map inputParameters, ISearchFieldMap searchMap)
           
 java.lang.String[]getSourcePropertyNames()
          Returns a list of Source type specific property names.
 booleanreconnectToDatabase()
           
 voidsetBlankQueryReturnsAll(boolean blankQueryReturnsAll)
           
 voidsetConstructWhereClause(boolean b)
           
 voidsetDBConnection(java.lang.String dbType, java.lang.String uid, java.lang.String passwd, java.lang.String jdbcURL)
           
 voidsetDBConnectionUsingJNDI(java.lang.String name)
           
 
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

SQLSearchSource

public SQLSearchSource()
Method Detail

setConstructWhereClause

public void setConstructWhereClause(boolean b)

getQueryProcessor

public IQueryProcessor getQueryProcessor()
Description copied from class: SearchSource
returns the type of QueryProcessor that can access this SearchSource.

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

getSearchProcess

public java.util.ArrayList getSearchProcess(java.util.Map inputParameters,
                                            ISearchFieldMap searchMap)

setDBConnection

public void setDBConnection(java.lang.String dbType,
                            java.lang.String uid,
                            java.lang.String passwd,
                            java.lang.String jdbcURL)

setDBConnectionUsingJNDI

public void setDBConnectionUsingJNDI(java.lang.String name)
                              throws java.lang.Exception
Throws:
java.lang.Exception

getJNDIConnection

public void getJNDIConnection()
                       throws java.lang.Exception
Throws:
java.lang.Exception

reconnectToDatabase

public boolean reconnectToDatabase()

addQueryColumns

public void addQueryColumns(org.w3c.dom.Element sourceElem)

addSQLTemplate

public void addSQLTemplate(java.lang.String sqlTmpl)

addResultFields

public void addResultFields(org.w3c.dom.NodeList resultMap)

setBlankQueryReturnsAll

public void setBlankQueryReturnsAll(boolean blankQueryReturnsAll)

getBlankQueryReturnsAll

public boolean getBlankQueryReturnsAll()