com.marklogic.client.example.extension

Class SearchCollector

java.lang.Object

com.marklogic.client.impl.ResourceManagerImplementation

com.marklogic.client.extensions.ResourceManager

com.marklogic.client.example.extension.SearchCollector

public class SearchCollector
extends ResourceManager

SearchCollector provides an extension for collecting a set of database documents based on a search. The query options for the search must return results but need not return snippets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchCollector.CollectorResults

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
SearchCollector(DatabaseClient client)

Method Summary

Modifier and Type	Method and Description
SearchCollector.CollectorResults	collect(String criteria, long start)
SearchCollector.CollectorResults	collect(String criteria, long start, String optionsName)
SearchCollector.CollectorResults	collect(StructuredQueryDefinition def, long start)
long	getPageLength()
void	setPageLength(long pageLength)

Methods inherited from class com.marklogic.client.extensions.ResourceManager

getName, startLogging, stopLogging

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

SearchCollector

public SearchCollector(DatabaseClient client)

Method Detail

getPageLength

public long getPageLength()

setPageLength

public void setPageLength(long pageLength)

collect

public SearchCollector.CollectorResults collect(String criteria,
                                                long start)

collect

public SearchCollector.CollectorResults collect(String criteria,
                                                long start,
                                                String optionsName)

collect

public SearchCollector.CollectorResults collect(StructuredQueryDefinition def,
                                                long start)