com.marklogic.hub.collector

Interface Collector

All Known Implementing Classes:

CollectorImpl

public interface Collector

Manages config and client for the collector, as well as runs the collector for the associated entity and flow

Method Summary

Modifier and Type	Method and Description
com.marklogic.client.DatabaseClient	getClient() Gets the client in use currently by the collector object
HubConfig	getHubConfig() Returns the current hubConfig ont he collector object
DiskQueue<java.lang.String>	run(java.lang.String flow, java.lang.String step, java.util.Map<java.lang.String,java.lang.Object> options) Obtains and grabs a list of uris that match the collector code
void	setClient(com.marklogic.client.DatabaseClient client) Sets the client to be used to communicate with the database
void	setHubConfig(HubConfig config) Set's the hub config for the collector

Method Detail

setHubConfig

void setHubConfig(HubConfig config)

Set's the hub config for the collector

Parameters:

config - takes in a HubConfig object

getHubConfig

HubConfig getHubConfig()

Returns the current hubConfig ont he collector object

Returns:

current hub config in use by collector

setClient

void setClient(com.marklogic.client.DatabaseClient client)

Sets the client to be used to communicate with the database

Parameters:

client - - a databaseclient to use

getClient

com.marklogic.client.DatabaseClient getClient()

Gets the client in use currently by the collector object

Returns:

a database client object

run

DiskQueue<java.lang.String> run(java.lang.String flow,
                                java.lang.String step,
                                java.util.Map<java.lang.String,java.lang.Object> options)

Obtains and grabs a list of uris that match the collector code

Parameters:

flow - - name of which flow

step - - step of the flow

options - - options Map for running the step

Returns:

a list of uris as strings in a diskqueue object