MainJavadocSource
SevSearchSource

com.raritantechnologies.symantec
Class SevSearchSource

java.lang.Object
  extended bycom.raritantechnologies.searchApp.SearchSource
      extended bycom.raritantechnologies.symantec.SevSearchSource
All Implemented Interfaces:
SevSearchConstants

public class SevSearchSource
extends SearchSource
implements SevSearchConstants

SearchSource for Symantec Vault collections.

XML Configuration Template:
  <SourceType name="[ source name ]" type="SevSearchSource" displayName="[ source display name ]"
                 sourceFactoryClass="com.raritantechnologies.symantec.SevSearchSourceFactory" 
                 queryProcessor="com.raritantechnologies.symantec.SevQueryProcessor"
                 type="HTMLWorker"
                 displayName="SymantecOnlineVaultSearch"
                 archiveEntryId="1E40F02BBB386B24AA0DCB51F26E0CB021110000kvs6.x1dev.com"
                 sevApi="enabled(default)|disabled"
                 defaultTerm=""
                 dllLog="enabled(default)|disabled">

    <Fields>
      <!-- One or more Field elements: -->
     <Field ID="[abstract field name in Symantec Vault]" 
                indexProperty="[ name in Symantec Vault ]"
                sevCode="[ index pointing to Symantec Index Properties Name ]"
                type="[ ALPHANUMERIC | NUMERIC | DATE ]" >
    </Fields>


  </SourceType>
 

Developed by Raritan Technologies Inc..

Author:
Pat Crabtree

Field Summary
static java.lang.StringBOOL_OP_PREFIX
           
static java.lang.StringEND_OP_PREFIX
           
static java.lang.StringFIELD_OP_PREFIX
           
static java.lang.StringFIELD_PREFIX
           
static java.lang.StringNAME_PREFIX
           
static java.lang.StringVALUE_PREFIX
           
 
Fields inherited from class com.raritantechnologies.searchApp.SearchSource
ID_FIELD, IS_FEDERATED, NUMBER_OF_FIELDS, SECURE, SOURCE_NAME, SOURCE_TYPE, TITLE_FIELD, URL_FIELD
 
Fields inherited from interface com.raritantechnologies.symantec.SevSearchConstants
ESQ_ALL, ESQ_ALL_NEAR, ESQ_AND, ESQ_AND_NOT, ESQ_ANY, ESQ_AUTO_WILD, ESQ_BEGIN_ANY, ESQ_BEGINS, ESQ_BINARY, ESQ_CASE_SENS, ESQ_DEFAULT, ESQ_ENDS, ESQ_EXACT, ESQ_EXACT_ANY, ESQ_FILTER, ESQ_OR, ESQ_PHRASE, ESQ_RANK, ESQ_SCOPE_ALL, ESQ_TERNARY, INDEX_PROP_AUTH, INDEX_PROP_RECP, INDEX_PROP_TEXT, PS_WA_FULL
 
Constructor Summary
SevSearchSource()
           
 
Method Summary
 CommandaddTermCommand(java.lang.String fieldName, java.lang.String sValue, java.lang.String flag)
           
 voidcookQuery(java.lang.String paramValue, java.lang.String value, java.util.ArrayList fifoCommandList, boolean simpleQuery)
           
 voidcreateIdPropMap()
           
 java.lang.StringgetArchiveEntryId()
           
 java.util.HashMapgetArchiveMap()
           
 java.util.ArrayListgetAuxCommandList()
           
 java.lang.StringgetDefaultQueryField()
           
 java.lang.StringgetDefaultTerm()
           
 java.lang.StringgetDllLog()
           
 java.util.ArrayListgetFifoCommandList()
           
 java.util.HashMapgetInclusiveFields()
           
 java.lang.StringgetLogDir()
           
 java.lang.StringgetMainSearchOperator()
           
 java.lang.ObjectgetProperty(java.lang.String property)
          returns a Source Property.
 IQueryProcessorgetQueryProcessor()
          returns the type of QueryProcessor that can access this SearchSource.
 intgetResultType()
           
 java.lang.StringgetSevAddTermFlag()
           
 java.lang.StringgetSevApi()
           
 long[]getSevFieldCodeArray()
           
 java.lang.StringgetSevOperatorFlag()
           
 java.lang.StringgetSevRangeFlag()
           
 java.lang.String[]getSourcePropertyNames()
          Returns a list of Source type specific property names.
 intgetTimeout()
           
 intgetTotalDocuments()
           
 java.lang.String[][]search(int startRec, int pageSize, java.lang.String userName, SevProxy ssq)
           
 voidsetArchiveEntryId(java.lang.String archiveEntryId)
           
 voidsetArchiveMap(java.util.HashMap archiveMap)
           
 voidsetAuxCommandList(java.util.ArrayList auxCommandList)
           
 voidsetDefaultQueryField(java.lang.String defaultQueryField)
           
 voidsetDefaultTerm(java.lang.String defaultTerm)
           
 voidsetDllLog(java.lang.String dllLog)
           
 voidsetFifoCommandList(java.util.ArrayList fifoCommandList)
           
 voidsetInclusiveFields(java.util.HashMap inclusiveFields)
           
 voidsetLogDir(java.lang.String logDir)
           
 voidsetMainSearchOperator(java.lang.String mainSearchOperator)
           
 voidsetPageSize(int pageSize)
           
 voidsetResultType(int resultType)
           
 voidsetSevAddTermFlag(java.lang.String sevAddTermFlag)
           
 voidsetSevApi(java.lang.String sevApi)
           
 voidsetSevOperatorFlag(java.lang.String sevOperatorFlag)
           
 voidsetSevRangeFlag(java.lang.String sevRangeFlag)
           
 voidsetTimeout(int timeout)
           
 voidsetTotalDocuments(int totalDocuments)
           
 
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
 

Field Detail

BOOL_OP_PREFIX

public static final java.lang.String BOOL_OP_PREFIX
See Also:
Constant Field Values

END_OP_PREFIX

public static final java.lang.String END_OP_PREFIX
See Also:
Constant Field Values

FIELD_OP_PREFIX

public static final java.lang.String FIELD_OP_PREFIX
See Also:
Constant Field Values

FIELD_PREFIX

public static final java.lang.String FIELD_PREFIX
See Also:
Constant Field Values

VALUE_PREFIX

public static final java.lang.String VALUE_PREFIX
See Also:
Constant Field Values

NAME_PREFIX

public static final java.lang.String NAME_PREFIX
See Also:
Constant Field Values
Constructor Detail

SevSearchSource

public SevSearchSource()
Method Detail

setTimeout

public void setTimeout(int timeout)

getTimeout

public int getTimeout()

cookQuery

public void cookQuery(java.lang.String paramValue,
                      java.lang.String value,
                      java.util.ArrayList fifoCommandList,
                      boolean simpleQuery)

addTermCommand

public Command addTermCommand(java.lang.String fieldName,
                              java.lang.String sValue,
                              java.lang.String flag)

search

public java.lang.String[][] search(int startRec,
                                   int pageSize,
                                   java.lang.String userName,
                                   SevProxy ssq)

getSevFieldCodeArray

public long[] getSevFieldCodeArray()

createIdPropMap

public void createIdPropMap()

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

getArchiveEntryId

public java.lang.String getArchiveEntryId()

setArchiveEntryId

public void setArchiveEntryId(java.lang.String archiveEntryId)

getFifoCommandList

public java.util.ArrayList getFifoCommandList()

setFifoCommandList

public void setFifoCommandList(java.util.ArrayList fifoCommandList)

getSevApi

public java.lang.String getSevApi()

setSevApi

public void setSevApi(java.lang.String sevApi)

getDllLog

public java.lang.String getDllLog()

setDllLog

public void setDllLog(java.lang.String dllLog)

getDefaultTerm

public java.lang.String getDefaultTerm()

setDefaultTerm

public void setDefaultTerm(java.lang.String defaultTerm)

setPageSize

public void setPageSize(int pageSize)

getResultType

public int getResultType()

setResultType

public void setResultType(int resultType)

getSevAddTermFlag

public java.lang.String getSevAddTermFlag()

setSevAddTermFlag

public void setSevAddTermFlag(java.lang.String sevAddTermFlag)

getSevOperatorFlag

public java.lang.String getSevOperatorFlag()

setSevOperatorFlag

public void setSevOperatorFlag(java.lang.String sevOperatorFlag)

getSevRangeFlag

public java.lang.String getSevRangeFlag()

setSevRangeFlag

public void setSevRangeFlag(java.lang.String sevRangeFlag)

getInclusiveFields

public java.util.HashMap getInclusiveFields()

setInclusiveFields

public void setInclusiveFields(java.util.HashMap inclusiveFields)

getDefaultQueryField

public java.lang.String getDefaultQueryField()

setDefaultQueryField

public void setDefaultQueryField(java.lang.String defaultQueryField)

getMainSearchOperator

public java.lang.String getMainSearchOperator()

setMainSearchOperator

public void setMainSearchOperator(java.lang.String mainSearchOperator)

getLogDir

public java.lang.String getLogDir()

setLogDir

public void setLogDir(java.lang.String logDir)

getAuxCommandList

public java.util.ArrayList getAuxCommandList()

setAuxCommandList

public void setAuxCommandList(java.util.ArrayList auxCommandList)

getArchiveMap

public java.util.HashMap getArchiveMap()

setArchiveMap

public void setArchiveMap(java.util.HashMap archiveMap)

getTotalDocuments

public int getTotalDocuments()

setTotalDocuments

public void setTotalDocuments(int totalDocuments)