|
IBM Information Integrator for Content V8.2 APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.beans.infomining.CMBInfoMiningBean | +--com.ibm.mm.beans.infomining.CMBConnectedMiningBean | +--com.ibm.mm.beans.infomining.CMBAdvancedSearchService
The CMBAdvancedSearchService is a non-visual bean that performs a text search on records in the Information Mining catalog.
Properties and Events Overview: pre-conditions open server connection properties (default) catalogName ("") queryString ("") maxResults (0) pageSize (10) traceEnabled (false) bound properties none constrained properties none event target for CMBConnectionReplyEvent event source for CMBResultEvent CMBExceptionEvent CMBTraceEvent
Constructor Summary | |
CMBAdvancedSearchService()
Constructs a new CMBAdvancedSearchService. |
Method Summary | |
void |
addCMBResultListener(com.ibm.mm.beans.CMBResultListener l)
Adds the specified result listener so that result events can be received from this information mining bean. |
static java.lang.String |
convertWebQuery(java.lang.String webQuery)
Converts a query using unitary '+' and '-' operators to a value that can be used as a CONTAINS value. |
java.lang.String |
getCatalogName()
Returns the current catalog name. |
java.lang.String[] |
getKeysToBeFetched()
Returns the currently set keys whose associated values are to be retrieved for the records found. |
int |
getMaxResults()
Returns the maximum number of search results returned from each query. |
int |
getPageSize()
Returns the number of search results in one result page. |
java.lang.String |
getQueryString()
Returns the current query. |
void |
removeCMBResultListener(com.ibm.mm.beans.CMBResultListener l)
Removes the specified result listener so that it no longer receives result events from this information mining bean. |
void |
runQuery()
Performs a search using the current query. |
void |
setCatalogName(java.lang.String catalogName)
Sets the name of the catalog to be searched. |
void |
setKeysToBeFetched(java.lang.String[] recordKeys)
Sets the keys of the values to be retrieved for the records found. |
void |
setMaxResults(int maxResults)
Sets the maximum number of search results returned from each query. |
void |
setPageSize(int pageSize)
Sets the number of search results in one result page. |
void |
setQueryString(java.lang.String queryString)
Sets the query. |
Methods inherited from class com.ibm.mm.beans.infomining.CMBConnectedMiningBean |
getConnection, isConnected, onCMBConnectionReply, setConnection, validateConnection |
Methods inherited from class com.ibm.mm.beans.infomining.CMBInfoMiningBean |
addCMBExceptionListener, addCMBTraceListener, isTraceEnabled, removeCMBExceptionListener, removeCMBTraceListener, setTraceEnabled |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CMBAdvancedSearchService()
Method Detail |
public void setCatalogName(java.lang.String catalogName)
catalogName
- the catalog namegetCatalogName()
public java.lang.String getCatalogName()
setCatalogName(String)
public void setQueryString(java.lang.String queryString)
query_string ::= term term ::= ( term ) ::= single_term ::= compound_term single_term ::= category_term ::= text_search_term ::= string_term ::= number_term compound_term ::= term binary_bool_operator term ::= unary_bool_operator single_term category_term ::= ( DKIKFCategory category_operator category_path_value ) text_search_term ::= ( "attribute name" CONTAINS text_search_value ) string_term ::= ( "attribute name" string_operator string_value ) number_term ::= ( "attribute name" basic_operator number_value ) binary_bool_operator ::= AND | OR unary_bool_operator ::= NOT category_operator ::= >= | = string_operator ::= LIKE | basic_operator basic_operator ::= > | < | <= | >= | != | = category_path_value ::= "category path" text_search_value ::= "'string'" string_value ::= "string" number_value ::= "integer" | "decimal number"Example:
("IKF_CONTENT" CONTAINS "'bird'") AND (DKIKFCategory = "root/nature")
queryString
- the query string built according to the syntax described above.convertWebQuery(java.lang.String)
,
runQuery()
,
getQueryString()
public java.lang.String getQueryString()
setQueryString(String)
public void setMaxResults(int maxResults)
0
is specified the query will result in as much results as
possible.maxResults
- maximum number of search resultsgetMaxResults()
public int getMaxResults()
setMaxResults(int)
public void setPageSize(int pageSize)
pageSize
- number of search results in one result pagegetPageSize()
public int getPageSize()
setPageSize(int)
public void setKeysToBeFetched(java.lang.String[] recordKeys)
recordKeys
- keys whose associated values are to be retrievedpublic java.lang.String[] getKeysToBeFetched()
public static java.lang.String convertWebQuery(java.lang.String webQuery) throws CMBWebQuerySyntaxException
query string ::= qterms qterm qterms qterm ::= [operator] term operator ::= '+' | '-' | ' 'A term may be a single word, a hyphen term (e.g. e-mail), or a phrase that must be rendered with quotations marks (e.g. "human resources").
The '+' terms must occur in the result set, the '-' terms must not. Terms without any operators may occur.
setQueryString(String)
public void runQuery() throws com.ibm.mm.beans.CMBNoConnectionException, CMBNoSuchCatalogException
com.ibm.mm.beans.CMBNoConnectionException
- if not connection has been establishedCMBNoSuchCatalogException
- if the specified catalog name is not validsetQueryString(String)
,
setCatalogName(String)
public void addCMBResultListener(com.ibm.mm.beans.CMBResultListener l)
l
- the result listenerremoveCMBResultListener(CMBResultListener)
public void removeCMBResultListener(com.ibm.mm.beans.CMBResultListener l)
l
- the result listeneraddCMBResultListener(CMBResultListener)
|
IBM Information Integrator for Content V8.2 APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |