com.marklogic.hub.legacy.collector

Interface LegacyCollector

All Known Implementing Classes:

LegacyCollectorImpl

public interface LegacyCollector

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
CodeFormat	getCodeFormat() Obtains the code format for the collector in use
HubConfig	getHubConfig() Returns the current hubConfig ont he collector object
java.lang.String	getModule() Returns the module for the collect
DiskQueue<java.lang.String>	run(java.lang.String jobId, java.lang.String entity, java.lang.String flow, int threadCount, 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

getCodeFormat

CodeFormat getCodeFormat()

Obtains the code format for the collector in use

Returns:

xqy or sjs (xquery or javascript)

getModule

java.lang.String getModule()

Returns the module for the collect

Returns:

the code in string form

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 jobId,
                                java.lang.String entity,
                                java.lang.String flow,
                                int threadCount,
                                java.util.Map<java.lang.String,java.lang.Object> options)

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

Parameters:

jobId - - id of the job this is to have

entity - - name of which entity is this being run against

flow - - name of which flow

threadCount - - how many threads to use for the operation

options - - string/object map of options you want to pass to the collector

Returns:

a list of uris as strings in a diskqueue object