IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.sdk.common.infomining
Class DKIKFWebQueryConverter

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.infomining.DKIKFWebQueryConverter

public class DKIKFWebQueryConverter
extends java.lang.Object

Converts a web query using unitary '+' and '-' operators to a value that can be used as a CONTAINS string in query. The syntax for a web query looks like:

 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. Example:

 String webQuery = "+birds -crow";
 DKIKFWebQueryConverter converter = new DKIKFWebQueryConverter();
 String queryString = "(\"IKF_CONTENT\" CONTAINS \"" + converter.toContainsString(webQuery) + "\")";
 

See Also:
DKIKFCatalog.searchRecords(String,DKIKFSearchConfiguration)

Constructor Summary
DKIKFWebQueryConverter()
          Creates a new web query converter.
 
Method Summary
 java.lang.String toContainsString(java.lang.String webQuery)
          Converts the specified web query to a string that can directly be used as a CONTAINS string in a query.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKIKFWebQueryConverter

public DKIKFWebQueryConverter()
Creates a new web query converter.
Method Detail

toContainsString

public java.lang.String toContainsString(java.lang.String webQuery)
                                  throws DKIKFWebQuerySyntaxException
Converts the specified web query to a string that can directly be used as a CONTAINS string in a query. searchRecords
Parameters:
webQuery - the web query to be converted
Returns:
a CONTAINS string for a query
Throws:
DKIKFWebQuerySyntaxException - if the specified web query cannot be processed

IBM Information Integrator for Content V8.2 APIs

© Copyright International Business Machines Corporation 1996, 2003 IBM Corp. All rights reserved.