com.raritantechnologies.searchApp
Class FileSystemSearchSource

java.lang.Object
  com.raritantechnologies.searchApp.SearchSource
      com.raritantechnologies.searchApp.FileSystemSearchSource

All Implemented Interfaces:

IQueryProcessor, IXMLSearchSourceFactory

public class FileSystemSearchSource

extends SearchSource

implements IQueryProcessor, IXMLSearchSourceFactory

Simple File System search source. Creates an IResultSet from a file directory. Can search on file name, file type, date modified.

XML Configuration Template:

  <SourceType name="fileSource" type="FileSystemSearchSource"
            sourceFactoryClass="com.raritantechnologies.searchApp.FileSystemSearchSource" 
            queryProcessor="com.raritantechnologies.searchApp.FileSystemSearchSource" 
            pathParam="[ parameter used to specify directory file path ]"
            nameParam="[ result parameter that gets the file name ]"
            dateParam="[ result parameter that gets modified date ]"
            dateFormat="MM/dd/yy hh:mm:ss"
            sizeParam="[ result parameter that gets file size ]"
            typeParam="[ result parameter that gets file type ]"
            removeExtension="[ false(default)|true - if true remove file extension from file name ]"
            nestedLevels="[ number of directory levels to extract (using nested IResultSet) - default 0 ]"
            nestedResultsField="[ name of field that gets nested directory results ]" >

    <FileTypeMap>
      <FileType extension="doc" type="MS Word Document" />
      <FileType extension="pdf" type="Adobe Acrobat Document" />
      <FileType extension="xml" type="XML Document" />
    </FileTypeMap>

    <ResultParser class="[ class of com.raritantechnologies.searchApp.IResultParser ]" >

    </ResultParser>

  </SourceType>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

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

FileSystemSearchSource()

Method Summary

SearchSource[]	createSearchSources(org.w3c.dom.Element sourceElem, ISearchFieldMapFactory factory)
IResultSet	executeQuery(java.lang.Integer queryID, ISearchFieldMap searchMap, SourceLoginInfo[] sources, OrderedMap inputParameters, java.lang.Integer pageSize, java.lang.Integer startRec) Executes a Query.
java.lang.Object	getProperty(java.lang.String property) returns a Source Property.
IQueryProcessor	getQueryProcessor() returns the type of QueryProcessor that can access this SearchSource.
java.lang.String[]	getSourcePropertyNames() Returns a list of Source type specific property names.
void	initializeSource(org.w3c.dom.Element sourceElem, SearchSource source)

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

FileSystemSearchSource

public FileSystemSearchSource()

Method Detail

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

executeQuery

public IResultSet executeQuery(java.lang.Integer queryID,
                               ISearchFieldMap searchMap,
                               SourceLoginInfo[] sources,
                               OrderedMap inputParameters,
                               java.lang.Integer pageSize,
                               java.lang.Integer startRec)
                        throws QueryProcessorException

Description copied from interface: IQueryProcessor

Executes a Query. Returns results in the form of an IResultSet object.

Specified by:

executeQuery in interface IQueryProcessor

Parameters:

queryID - Unique ID for this query. Used by front end to manage queries and query pages. QueryProcessor may use this parameter to organize its search results, and to organize any state information it needs to process future page requests (future executeQuery( ) calls with the same queryID.

searchMap - Provides mapping information needed to translate the inputParameters into a search string appropriate for this type of QueryProcessor. Mapping information is obtained by the application framework from local configuration data.

sources - The LoginInfo and SearchSource(s) to be used for this query. The SearchSource(s) must be of the appropriate type for the QueryProcessor.

inputParameters - Form inputs. Use ISearchFieldMap to translate these into implementation and source-specific fields.

pageSize - Integer specifying the number of results to include in the returned Document. if null - use the default page size.

startRec - Integer specifying the starting record in the result set to be returned. if null - start with the first record.

Returns:

IResultSet containing result set.

Throws:

QueryProcessorException

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

createSearchSources

public SearchSource[] createSearchSources(org.w3c.dom.Element sourceElem,
                                          ISearchFieldMapFactory factory)

Specified by:

createSearchSources in interface IXMLSearchSourceFactory

initializeSource

public void initializeSource(org.w3c.dom.Element sourceElem,
                             SearchSource source)

Specified by:

initializeSource in interface IXMLSearchSourceFactory