IBM Information Integrator for Content V8.2 APIs

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

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.infomining.DKIKFSearchConfiguration
All Implemented Interfaces:
java.io.Serializable

public abstract class DKIKFSearchConfiguration
extends java.lang.Object
implements java.io.Serializable

A search configuration can be used to customize a search.

See Also:
Serialized Form

Constructor Summary
protected DKIKFSearchConfiguration()
          Use create() to get an object.
 
Method Summary
static DKIKFSearchConfiguration create()
          Created a new search configuration object.
abstract  int getMaxResults()
          Returns the maximum number of results.
abstract  java.lang.String[] getRecordKeys()
          Returns the currently set keys whose associated values are to be retrieved for the records found.
abstract  int getResultBufferSize()
          Returns the size of the buffer to be used to retrieve results from the server.
abstract  DKIKFTaxonomy getTaxonomy()
          Returns the taxonomy.
abstract  void setMaxResults(int maxResults)
          Set the maximum number of search results to be returned.
abstract  void setRecordKeys(java.lang.String[] recordKeys)
          Sets the keys of the values to be retrieved for the records found.
abstract  void setResultBufferSize(int resultBufferSize)
          Sets the size of the buffer to be used to retrieve results from the server, default is 20;
abstract  void setTaxonomy(DKIKFTaxonomy taxonomy)
          Sets the taxonomy to be used for resolving category paths in the query string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKIKFSearchConfiguration

protected DKIKFSearchConfiguration()
Use create() to get an object.
Method Detail

create

public static DKIKFSearchConfiguration create()
Created a new search configuration object.

setMaxResults

public abstract void setMaxResults(int maxResults)
Set the maximum number of search results to be returned.

getMaxResults

public abstract int getMaxResults()
Returns the maximum number of results.

setResultBufferSize

public abstract void setResultBufferSize(int resultBufferSize)
Sets the size of the buffer to be used to retrieve results from the server, default is 20;

getResultBufferSize

public abstract int getResultBufferSize()
Returns the size of the buffer to be used to retrieve results from the server.

setTaxonomy

public abstract void setTaxonomy(DKIKFTaxonomy taxonomy)
Sets the taxonomy to be used for resolving category paths in the query string.

getTaxonomy

public abstract DKIKFTaxonomy getTaxonomy()
Returns the taxonomy.

setRecordKeys

public abstract void setRecordKeys(java.lang.String[] recordKeys)
Sets the keys of the values to be retrieved for the records found. An empty array requestes all values.
Parameters:
recordKeys - keys whose associated values are to be retrieved

getRecordKeys

public abstract java.lang.String[] getRecordKeys()
Returns the currently set keys whose associated values are to be retrieved for the records found.
Returns:
the keys of the values to be retrieved

IBM Information Integrator for Content V8.2 APIs

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