com.marklogic.hub.collector.impl

Class CollectorImpl

java.lang.Object

com.marklogic.hub.collector.impl.CollectorImpl

All Implemented Interfaces:

Collector

public class CollectorImpl
extends java.lang.Object
implements Collector

Constructor Summary

Constructors

Constructor and Description
CollectorImpl()
CollectorImpl(java.lang.String module, CodeFormat codeFormat)

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectorImpl

public CollectorImpl()

CollectorImpl

public CollectorImpl(java.lang.String module,
                     CodeFormat codeFormat)

Method Detail

setHubConfig

public void setHubConfig(HubConfig config)

Description copied from interface: Collector

Set's the hub config for the collector

Specified by:

setHubConfig in interface Collector

Parameters:

config - takes in a HubConfig object

getHubConfig

public HubConfig getHubConfig()

Description copied from interface: Collector

Returns the current hubConfig ont he collector object

Specified by:

getHubConfig in interface Collector

Returns:

current hub config in use by collector

setClient

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

Description copied from interface: Collector

Sets the client to be used to communicate with the database

Specified by:

setClient in interface Collector

Parameters:

client - - a databaseclient to use

getClient

public com.marklogic.client.DatabaseClient getClient()

Description copied from interface: Collector

Gets the client in use currently by the collector object

Specified by:

getClient in interface Collector

Returns:

a database client object

getCodeFormat

public CodeFormat getCodeFormat()

Description copied from interface: Collector

Obtains the code format for the collector in use

Specified by:

getCodeFormat in interface Collector

Returns:

xqy or sjs (xquery or javascript)

getModule

public java.lang.String getModule()

Description copied from interface: Collector

Returns the module for the collect

Specified by:

getModule in interface Collector

Returns:

the code in string form

run

public 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)

Description copied from interface: Collector

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

Specified by:

run in interface Collector

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