BaseSearchManager.BasicSearch (sakai-citations-impl 10.3 API)

java.lang.Object
- org.sakaiproject.citation.impl.BaseSearchManager.BasicSearch

All Implemented Interfaces:: org.sakaiproject.citation.api.ActiveSearch

Enclosing class:: BaseSearchManager

public class BaseSearchManager.BasicSearch
extends Object
implements org.sakaiproject.citation.api.ActiveSearch

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`end`
`protected org.sakaiproject.citation.util.api.SearchQuery`	`m_advancedQuery`
`protected org.osid.repository.AssetIterator`	`m_assetIterator`
`protected List`	`m_assets`
`protected org.sakaiproject.citation.util.api.SearchQuery`	`m_basicQuery`
`protected String[]`	`m_databaseIds`
`protected Set`	`m_duplicateCheck`
`protected boolean`	`m_duplicateCheckEnabled`
`protected boolean`	`m_firstPage`
`protected Map`	`m_index`
`protected boolean`	`m_lastPage`
`protected int`	`m_lastPageViewed`
`protected boolean`	`m_newSearch`
`protected Integer`	`m_numRecordsFetched`
`protected Integer`	`m_numRecordsFound`
`protected Integer`	`m_numRecordsMerged`
`protected List`	`m_pageOrder`
`protected Integer`	`m_pageSize`
`protected org.osid.repository.Repository`	`m_repository`
`protected String`	`m_repositoryId`
`protected String`	`m_repositoryName`
`protected org.sakaiproject.citation.api.CitationIterator`	`m_resultsIterator`
`protected org.sakaiproject.citation.api.CitationCollection`	`m_savedResults`
`protected String`	`m_searchId`
`protected org.sakaiproject.citation.api.CitationIterator`	`m_searchIterator`
`protected org.sakaiproject.citation.api.CitationCollection`	`m_searchResults`
`protected Thread`	`m_searchThread`
`protected String`	`m_searchType`
`protected String`	`m_sortBy`
`protected Integer`	`m_startRecord`
`protected int`	`m_viewPageSize`
`protected int`	`start`
`protected String`	`statusMessage`

Fields inherited from interface org.sakaiproject.citation.api.ActiveSearch
ADVANCED_SEARCH_TYPE, BASIC_SEARCH_TYPE

Constructor Summary

Constructors
Constructor and Description

BaseSearchManager.BasicSearch()
Constructor

BaseSearchManager.BasicSearch(org.sakaiproject.citation.api.CitationCollection searchResults)

Constructors
Constructor and Description
`BaseSearchManager.BasicSearch()` Constructor
`BaseSearchManager.BasicSearch(org.sakaiproject.citation.api.CitationCollection searchResults)`

Method Summary

Methods
Modifier and Type	Method and Description
`org.sakaiproject.citation.util.api.SearchQuery`	`getAdvancedQuery()`
`protected org.osid.repository.AssetIterator`	`getAssetIterator()`
`List`	`getAssets()`
`org.sakaiproject.citation.util.api.SearchQuery`	`getBasicQuery()`
`String[]`	`getDatabaseIds()` Fetch the selected list of searchable databases
`Set`	`getDuplicateCheck()`
`int`	`getFirstRecordIndex()`
`Map`	`getIndex()`
`int`	`getLastRecordIndex()`
`Integer`	`getNumRecordsFetched()`
`Integer`	`getNumRecordsFound()`
`Integer`	`getNumRecordsMerged()`
`Integer`	`getPageSize()`
`org.osid.repository.Repository`	`getRepository()`
`String`	`getRepositoryId()`
`String`	`getRepositoryName()`
`String`	`getSearchId()`
`org.sakaiproject.citation.api.CitationCollection`	`getSearchResults()`
`Thread`	`getSearchThread()`
`String`	`getSearchType()`
`String`	`getSortBy()`
`Integer`	`getStartRecord()`
`String`	`getStatusMessage()`
`int`	`getViewPageNumber()`
`int`	`getViewPageSize()`
`boolean`	`isDuplicateCheckEnabled()` Are we checking for duplicate search results?
`boolean`	`isFirstPage()`
`boolean`	`isLastPage()`
`boolean`	`isNewSearch()`
`void`	`prepareForNextPage()`
`void`	`resetSearch()`
`void`	`setAdvancedQuery(org.sakaiproject.citation.util.api.SearchQuery advancedQuery)`
`void`	`setAssetIterator(org.osid.repository.AssetIterator assetIterator)`
`void`	`setAssets(List assets)`
`void`	`setBasicQuery(org.sakaiproject.citation.util.api.SearchQuery basicQuery)`
`void`	`setDatabaseIds(String[] databaseIds)` Set the selected list of searchable databases
`void`	`setDuplicateCheckEnabled(boolean state)` Enable/disable duplicate checking
`void`	`setFirstPage(boolean firstPage)`
`void`	`setGuid(String guid)`
`void`	`setIndex(Map index)`
`void`	`setLastPage(boolean lastPage)`
`void`	`setNewSearch(boolean newSearch)`
`void`	`setNumRecordsFetched(Integer numRecordsFetched)`
`void`	`setNumRecordsFound(Integer numRecordsFound)`
`void`	`setNumRecordsMerged(Integer numRecordsMerged)`
`protected void`	`setPageLimits(int page)`
`void`	`setPageSize(Integer pageSize)`
`void`	`setPageSize(String pageSize)`
`void`	`setRepository(org.osid.repository.Repository repository)`
`void`	`setRepositoryId(String repositoryId)`
`void`	`setRepositoryName(String repositoryName)`
`void`	`setSearchResults(org.sakaiproject.citation.api.CitationCollection searchResults)`
`void`	`setSearchThread(Thread searchThread)`
`void`	`setSearchType(String searchType)`
`void`	`setSortBy(String sortBy)`
`void`	`setStartRecord(Integer startRecord)`
`void`	`setStartRecord(String startRecord)`
`void`	`setStatusMessage()`
`protected void`	`setStatusMessage(org.osid.repository.Repository repository)`
`void`	`setStatusMessage(String msg)`
`void`	`setViewPageSize(int size)`
`List`	`viewPage()`
`List`	`viewPage(int page)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - m_assets
```
protected List m_assets
```
  - m_pageOrder
```
protected List m_pageOrder
```
  - m_duplicateCheck
```
protected Set m_duplicateCheck
```
  - m_duplicateCheckEnabled
```
protected boolean m_duplicateCheckEnabled
```
  - m_firstPage
```
protected boolean m_firstPage
```
  - m_searchId
```
protected String m_searchId
```
  - m_searchType
```
protected String m_searchType
```
  - m_lastPage
```
protected boolean m_lastPage
```
  - m_newSearch
```
protected boolean m_newSearch
```
  - m_pageSize
```
protected Integer m_pageSize
```
  - m_startRecord
```
protected Integer m_startRecord
```
  - m_databaseIds
```
protected String[] m_databaseIds
```
  - m_assetIterator
```
protected org.osid.repository.AssetIterator m_assetIterator
```
  - m_numRecordsFetched
```
protected Integer m_numRecordsFetched
```
  - m_numRecordsFound
```
protected Integer m_numRecordsFound
```
  - m_numRecordsMerged
```
protected Integer m_numRecordsMerged
```
  - m_repository
```
protected org.osid.repository.Repository m_repository
```
  - m_repositoryId
```
protected String m_repositoryId
```
  - m_repositoryName
```
protected String m_repositoryName
```
  - m_basicQuery
```
protected org.sakaiproject.citation.util.api.SearchQuery m_basicQuery
```
  - m_advancedQuery
```
protected org.sakaiproject.citation.util.api.SearchQuery m_advancedQuery
```
  - m_sortBy
```
protected String m_sortBy
```
  - m_searchResults
```
protected org.sakaiproject.citation.api.CitationCollection m_searchResults
```
  - m_savedResults
```
protected org.sakaiproject.citation.api.CitationCollection m_savedResults
```
  - m_resultsIterator
```
protected org.sakaiproject.citation.api.CitationIterator m_resultsIterator
```
  - m_index
```
protected Map m_index
```
  - m_lastPageViewed
```
protected int m_lastPageViewed
```
  - m_searchIterator
```
protected org.sakaiproject.citation.api.CitationIterator m_searchIterator
```
  - start
```
protected int start
```
  - end
```
protected int end
```
  - m_viewPageSize
```
protected int m_viewPageSize
```
  - statusMessage
```
protected String statusMessage
```
  - m_searchThread
```
protected Thread m_searchThread
```
- Constructor Detail
  - BaseSearchManager.BasicSearch
```
public BaseSearchManager.BasicSearch()
```
    Constructor
  - BaseSearchManager.BasicSearch
```
public BaseSearchManager.BasicSearch(org.sakaiproject.citation.api.CitationCollection searchResults)
```
- Method Detail
  - getAssetIterator
```
protected org.osid.repository.AssetIterator getAssetIterator()
```
  - getAssets
```
public List getAssets()
```
  - getSearchId
```
public String getSearchId()
```
    Specified by:
    
    getSearchId in interface org.sakaiproject.citation.api.ActiveSearch
  - getNumRecordsFetched
```
public Integer getNumRecordsFetched()
```
    Specified by:
    
    getNumRecordsFetched in interface org.sakaiproject.citation.api.ActiveSearch
  - getNumRecordsFound
```
public Integer getNumRecordsFound()
```
    Specified by:
    
    getNumRecordsFound in interface org.sakaiproject.citation.api.ActiveSearch
  - getNumRecordsMerged
```
public Integer getNumRecordsMerged()
```
    Specified by:
    
    getNumRecordsMerged in interface org.sakaiproject.citation.api.ActiveSearch
  - setPageLimits
```
protected void setPageLimits(int page)
                      throws org.sakaiproject.citation.util.api.SearchException
```
    Throws:
    
    org.sakaiproject.citation.util.api.SearchException
  - viewPage
```
public List viewPage(int page)
              throws org.sakaiproject.citation.util.api.SearchException,
                     org.sakaiproject.citation.util.api.SearchCancelException
```
    Specified by:
    
    viewPage in interface org.sakaiproject.citation.api.ActiveSearch
    
    Parameters:
    page -
    
    Returns:
    
    Throws:
    
    org.sakaiproject.citation.util.api.SearchException
    
    org.sakaiproject.citation.util.api.SearchCancelException
  - setStatusMessage
```
protected void setStatusMessage(org.osid.repository.Repository repository)
```
  - setStatusMessage
```
public void setStatusMessage(String msg)
```
    Specified by:
    
    setStatusMessage in interface org.sakaiproject.citation.api.ActiveSearch
  - setStatusMessage
```
public void setStatusMessage()
```
    Specified by:
    
    setStatusMessage in interface org.sakaiproject.citation.api.ActiveSearch
  - getStatusMessage
```
public String getStatusMessage()
```
    Specified by:
    
    getStatusMessage in interface org.sakaiproject.citation.api.ActiveSearch
  - setDatabaseIds
```
public void setDatabaseIds(String[] databaseIds)
```
    Set the selected list of searchable databases
    
    Specified by:
    
    setDatabaseIds in interface org.sakaiproject.citation.api.ActiveSearch
    
    Parameters:
    A - list of database IDs
  - getDatabaseIds
```
public String[] getDatabaseIds()
```
    Fetch the selected list of searchable databases
    
    Specified by:
    
    getDatabaseIds in interface org.sakaiproject.citation.api.ActiveSearch
    
    Returns:
    The list of database IDs (null if none)
  - getPageSize
```
public Integer getPageSize()
```
    Specified by:
    
    getPageSize in interface org.sakaiproject.citation.api.ActiveSearch
  - getRepository
```
public org.osid.repository.Repository getRepository()
```
  - getRepositoryId
```
public String getRepositoryId()
```
    Specified by:
    
    getRepositoryId in interface org.sakaiproject.citation.api.ActiveSearch
  - getRepositoryName
```
public String getRepositoryName()
```
    Specified by:
    
    getRepositoryName in interface org.sakaiproject.citation.api.ActiveSearch
  - getBasicQuery
```
public org.sakaiproject.citation.util.api.SearchQuery getBasicQuery()
```
    Specified by:
    
    getBasicQuery in interface org.sakaiproject.citation.api.ActiveSearch
  - getSortBy
```
public String getSortBy()
```
    Specified by:
    
    getSortBy in interface org.sakaiproject.citation.api.ActiveSearch
  - getStartRecord
```
public Integer getStartRecord()
```
    Specified by:
    
    getStartRecord in interface org.sakaiproject.citation.api.ActiveSearch
  - isFirstPage
```
public boolean isFirstPage()
```
    Specified by:
    
    isFirstPage in interface org.sakaiproject.citation.api.ActiveSearch
    
    Returns:
    the firstPage
  - isLastPage
```
public boolean isLastPage()
```
    Specified by:
    
    isLastPage in interface org.sakaiproject.citation.api.ActiveSearch
    
    Returns:
    the lastPage
  - isNewSearch
```
public boolean isNewSearch()
```
    Specified by:
    
    isNewSearch in interface org.sakaiproject.citation.api.ActiveSearch
    
    Returns:
    the newSearch
  - setAssetIterator
```
public void setAssetIterator(org.osid.repository.AssetIterator assetIterator)
```
  - setAssets
```
public void setAssets(List assets)
```
  - setFirstPage
```
public void setFirstPage(boolean firstPage)
```
    Specified by:
    
    setFirstPage in interface org.sakaiproject.citation.api.ActiveSearch
  - setGuid
```
public void setGuid(String guid)
```
  - setLastPage
```
public void setLastPage(boolean lastPage)
```
    Specified by:
    
    setLastPage in interface org.sakaiproject.citation.api.ActiveSearch
  - setNewSearch
```
public void setNewSearch(boolean newSearch)
```
    Specified by:
    
    setNewSearch in interface org.sakaiproject.citation.api.ActiveSearch
  - setNumRecordsFetched
```
public void setNumRecordsFetched(Integer numRecordsFetched)
```
    Specified by:
    
    setNumRecordsFetched in interface org.sakaiproject.citation.api.ActiveSearch
    
    Parameters:
    numRecordsFetched - the numRecordsFetched to set
  - setNumRecordsFound
```
public void setNumRecordsFound(Integer numRecordsFound)
```
    Specified by:
    
    setNumRecordsFound in interface org.sakaiproject.citation.api.ActiveSearch
  - setNumRecordsMerged
```
public void setNumRecordsMerged(Integer numRecordsMerged)
```
    Specified by:
    
    setNumRecordsMerged in interface org.sakaiproject.citation.api.ActiveSearch
  - setPageSize
```
public void setPageSize(Integer pageSize)
```
    Specified by:
    
    setPageSize in interface org.sakaiproject.citation.api.ActiveSearch
    
    Parameters:
    pageSize - the pageSize to set
  - setPageSize
```
public void setPageSize(String pageSize)
```
    Specified by:
    
    setPageSize in interface org.sakaiproject.citation.api.ActiveSearch
    
    Parameters:
    pageSize - the pageSize to set
  - setRepository
```
public void setRepository(org.osid.repository.Repository repository)
```
  - setRepositoryId
```
public void setRepositoryId(String repositoryId)
```
  - setRepositoryName
```
public void setRepositoryName(String repositoryName)
```
    Specified by:
    
    setRepositoryName in interface org.sakaiproject.citation.api.ActiveSearch
  - setBasicQuery
```
public void setBasicQuery(org.sakaiproject.citation.util.api.SearchQuery basicQuery)
```
    Specified by:
    
    setBasicQuery in interface org.sakaiproject.citation.api.ActiveSearch
  - setSortBy
```
public void setSortBy(String sortBy)
```
    Specified by:
    
    setSortBy in interface org.sakaiproject.citation.api.ActiveSearch
  - setStartRecord
```
public void setStartRecord(Integer startRecord)
```
    Specified by:
    
    setStartRecord in interface org.sakaiproject.citation.api.ActiveSearch
  - getSearchResults
```
public org.sakaiproject.citation.api.CitationCollection getSearchResults()
```
    Specified by:
    
    getSearchResults in interface org.sakaiproject.citation.api.ActiveSearch
  - setSearchResults
```
public void setSearchResults(org.sakaiproject.citation.api.CitationCollection searchResults)
```
    Parameters:
    searchResults - the searchResults to set
  - setStartRecord
```
public void setStartRecord(String startRecord)
```
    Specified by:
    
    setStartRecord in interface org.sakaiproject.citation.api.ActiveSearch
  - getIndex
```
public Map getIndex()
```
    Specified by:
    
    getIndex in interface org.sakaiproject.citation.api.ActiveSearch
  - setIndex
```
public void setIndex(Map index)
```
    Specified by:
    
    setIndex in interface org.sakaiproject.citation.api.ActiveSearch
  - getDuplicateCheck
```
public Set getDuplicateCheck()
```
    Returns:
  - isDuplicateCheckEnabled
```
public boolean isDuplicateCheckEnabled()
```
    Are we checking for duplicate search results?
    
    Returns:
    true if so
  - setDuplicateCheckEnabled
```
public void setDuplicateCheckEnabled(boolean state)
```
    Enable/disable duplicate checking
    
    Parameters:
    state - true to enable the duplicate check
  - prepareForNextPage
```
public void prepareForNextPage()
```
    Specified by:
    
    prepareForNextPage in interface org.sakaiproject.citation.api.ActiveSearch
  - getViewPageNumber
```
public int getViewPageNumber()
```
    Specified by:
    
    getViewPageNumber in interface org.sakaiproject.citation.api.ActiveSearch
  - getViewPageSize
```
public int getViewPageSize()
```
    Specified by:
    
    getViewPageSize in interface org.sakaiproject.citation.api.ActiveSearch
  - viewPage
```
public List viewPage()
              throws org.sakaiproject.citation.util.api.SearchException,
                     org.sakaiproject.citation.util.api.SearchCancelException
```
    Specified by:
    
    viewPage in interface org.sakaiproject.citation.api.ActiveSearch
    
    Throws:
    
    org.sakaiproject.citation.util.api.SearchException
    
    org.sakaiproject.citation.util.api.SearchCancelException
  - getFirstRecordIndex
```
public int getFirstRecordIndex()
```
    Specified by:
    
    getFirstRecordIndex in interface org.sakaiproject.citation.api.ActiveSearch
  - getLastRecordIndex
```
public int getLastRecordIndex()
```
    Specified by:
    
    getLastRecordIndex in interface org.sakaiproject.citation.api.ActiveSearch
  - setViewPageSize
```
public void setViewPageSize(int size)
```
    Specified by:
    
    setViewPageSize in interface org.sakaiproject.citation.api.ActiveSearch
  - getSearchType
```
public String getSearchType()
```
    Specified by:
    
    getSearchType in interface org.sakaiproject.citation.api.ActiveSearch
  - setSearchType
```
public void setSearchType(String searchType)
```
    Specified by:
    
    setSearchType in interface org.sakaiproject.citation.api.ActiveSearch
  - getAdvancedQuery
```
public org.sakaiproject.citation.util.api.SearchQuery getAdvancedQuery()
```
    Specified by:
    
    getAdvancedQuery in interface org.sakaiproject.citation.api.ActiveSearch
  - setAdvancedQuery
```
public void setAdvancedQuery(org.sakaiproject.citation.util.api.SearchQuery advancedQuery)
```
    Specified by:
    
    setAdvancedQuery in interface org.sakaiproject.citation.api.ActiveSearch
  - getSearchThread
```
public Thread getSearchThread()
```
    Specified by:
    
    getSearchThread in interface org.sakaiproject.citation.api.ActiveSearch
  - setSearchThread
```
public void setSearchThread(Thread searchThread)
```
    Specified by:
    
    setSearchThread in interface org.sakaiproject.citation.api.ActiveSearch
  - resetSearch
```
public void resetSearch()
```
    Specified by:
    
    resetSearch in interface org.sakaiproject.citation.api.ActiveSearch

Class BaseSearchManager.BasicSearch

Field Summary

Fields inherited from interface org.sakaiproject.citation.api.ActiveSearch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_assets

m_pageOrder

m_duplicateCheck

m_duplicateCheckEnabled

m_firstPage

m_searchId

m_searchType

m_lastPage

m_newSearch

m_pageSize

m_startRecord

m_databaseIds

m_assetIterator

m_numRecordsFetched

m_numRecordsFound

m_numRecordsMerged

m_repository

m_repositoryId

m_repositoryName

m_basicQuery

m_advancedQuery

m_sortBy

m_searchResults

m_savedResults

m_resultsIterator

m_index

m_lastPageViewed

m_searchIterator

start

end

m_viewPageSize

statusMessage

m_searchThread

Constructor Detail

BaseSearchManager.BasicSearch

BaseSearchManager.BasicSearch

Method Detail

getAssetIterator

getAssets

getSearchId

getNumRecordsFetched

getNumRecordsFound

getNumRecordsMerged

setPageLimits

viewPage

setStatusMessage

setStatusMessage

setStatusMessage

getStatusMessage

setDatabaseIds

getDatabaseIds

getPageSize

getRepository

getRepositoryId

getRepositoryName

getBasicQuery

getSortBy

getStartRecord

isFirstPage

isLastPage

isNewSearch

setAssetIterator

setAssets

setFirstPage

setGuid

setLastPage

setNewSearch

setNumRecordsFetched

setNumRecordsFound

setNumRecordsMerged

setPageSize

setPageSize

setRepository