org.apache.ctakes.ytex.web.search

Interface DocumentSearchService

All Known Implementing Classes:

DocumentSearchServiceImpl

public interface DocumentSearchService

Service for searching documents. Executes queries defined in ytex/search.properties.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<DocumentSearchResult>	extendedSearch(java.lang.String code, java.lang.String documentTypeName, java.util.Date dateFrom, java.util.Date dateTo, java.lang.Integer patientId, java.lang.Boolean negationStatus) Extended search
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	fullTextSearch(java.lang.String searchTerm) perform full text search
java.lang.String	getFullTextSearchDocument(int documentId) retrieve note for specified document id, retrieved via full text search
java.util.List<DocumentSearchResult>	searchByCui(java.lang.String cui)

Method Detail

searchByCui

java.util.List<DocumentSearchResult> searchByCui(java.lang.String cui)

extendedSearch

java.util.List<DocumentSearchResult> extendedSearch(java.lang.String code,
                                                  java.lang.String documentTypeName,
                                                  java.util.Date dateFrom,
                                                  java.util.Date dateTo,
                                                  java.lang.Integer patientId,
                                                  java.lang.Boolean negationStatus)

Extended search

Parameters:

code - concept CUI or code. this is the only required argument

documentTypeName - document type name. (in VACS @see DocumentType)

dateFrom - document date greater than or equal to this

dateTo - document date less than or equal to this

patientId - patient id (study id in VACS)

negationStatus - true - only affirmed terms. false - only negated terms.

Returns:

list of results matching query

fullTextSearch

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> fullTextSearch(java.lang.String searchTerm)

perform full text search

Parameters:

searchTerm -

Returns:

list of maps for each record. map keys correspond to search query headings. map (i.e. query) must contain DOCUMENT_ID (integer) and NOTE (string) fields.

getFullTextSearchDocument

java.lang.String getFullTextSearchDocument(int documentId)

retrieve note for specified document id, retrieved via full text search

Parameters:

documentId -

Returns:

note text.