com.esri.gpt.catalog.discovery
Class DiscoveryFilter

java.lang.Object
  com.esri.gpt.catalog.discovery.DiscoveryComponent
      com.esri.gpt.catalog.discovery.DiscoveryFilter

public class DiscoveryFilter
extends DiscoveryComponent

Defines the filter that constrains a query.

Field Summary

static int

THRESHOLD_MAXRECORDS The threshold for the maximum number of record to return = 5000

Constructor Summary

DiscoveryFilter()
Default constructor.

Method Summary

void	echo(StringBuffer sb) Appends property information for the component to a buffer.
int	getMaxRecords() Gets the maximum number of records to return.
LogicalClause	getRootClause() Gets the root clause for the filter.
int	getStartRecord() Gets the starting record.
void	setMaxRecords(int maxRecords) Sets the maximum number of records to return.
void	setRootClause(LogicalClause clause) Sets the root clause for the filter.
void	setStartRecord(int startRecord) Sets the starting record.

Methods inherited from class com.esri.gpt.catalog.discovery.DiscoveryComponent

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

THRESHOLD_MAXRECORDS

public static final int THRESHOLD_MAXRECORDS

The threshold for the maximum number of record to return = 5000

See Also:

Constant Field Values

Constructor Detail

DiscoveryFilter

public DiscoveryFilter()

Default constructor.

Method Detail

getMaxRecords

public int getMaxRecords()

Gets the maximum number of records to return.

Returns:

the maximum number of records to return

setMaxRecords

public void setMaxRecords(int maxRecords)

Sets the maximum number of records to return.
A value of zero or less will return no records (hit count only).
If the supplied value exceeds the threshold, the max records will be set to the threshold.

Parameters:

maxRecords - maximum number of records to return

getRootClause

public LogicalClause getRootClause()

Gets the root clause for the filter.

Returns:

the root clause

setRootClause

public void setRootClause(LogicalClause clause)

Sets the root clause for the filter.

Parameters:

clause - the root clause

getStartRecord

public int getStartRecord()

Gets the starting record.
The record set starts at 1 not 0.

Returns:

the starting record

setStartRecord

public void setStartRecord(int startRecord)

Sets the starting record.
If the supplied value is less that 1, the start record will be set to 1.

Parameters:

startRecord - the starting record

echo

public void echo(StringBuffer sb)

Appends property information for the component to a buffer.

Overrides:

echo in class DiscoveryComponent

Parameters:

sb - the buffer to use when appending information