org.eclipse.smila.connectivity.framework.crawler.jdbc
Class JdbcCrawler

java.lang.Object
  org.eclipse.smila.connectivity.framework.AbstractCrawler
      org.eclipse.smila.connectivity.framework.crawler.jdbc.JdbcCrawler

All Implemented Interfaces:

Crawler, CrawlerCallback

public class JdbcCrawler
extends AbstractCrawler

The Class JdbcCrawler. Instances of this class can be used to crawl JDBC datasources. Clients can access the retrieved data via the methods defined in the Crawler-Interface. The DataSourceConnectionConfig passed in the initialize()-Method must comply to the Schema defined in JdbcDataSourceConnectionConfigSchema.xsd.

Field Summary

static java.lang.String

POC_DATA_ROWS_RETRIEVED Name used for the CrawlerPerformanceCounters property logging the number of retrieved database rows.

Constructor Summary

JdbcCrawler()
Standard constructor of JdbcCrawler.

Method Summary

void	close() This method should be called by clients after completing their work with the JdbcCrawler can release its JDBC- and other resources.
void	dispose(ConnectivityId id) Disposes the record with the given Id.
byte[]	getAttachment(ConnectivityId id, java.lang.String name) Returns the attachment for the given Id and name pair.
java.lang.String[]	getAttachmentNames(ConnectivityId id) Returns an array of String[] containing the names of the available attachments for the given id.
CrawlerPerformanceCounterHelper<? extends ConnectivityPerformanceAgent>	getCounterHelper()
AnyMap	getMetadata(ConnectivityId id) Returns the metadata for the given id.
DataReference[]	getNext() Returns an array of DataReference objects.
java.lang.Thread	getProducerThread()
void	initialize(DataSourceConnectionConfig config) Initialize.

Methods inherited from class org.eclipse.smila.connectivity.framework.AbstractCrawler

activate, getCrawlerId

Methods inherited from class java.lang.Object

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

Field Detail

POC_DATA_ROWS_RETRIEVED

public static final java.lang.String POC_DATA_ROWS_RETRIEVED

Name used for the CrawlerPerformanceCounters property logging the number of retrieved database rows.

See Also:

Constant Field Values

Constructor Detail

JdbcCrawler

public JdbcCrawler()

Standard constructor of JdbcCrawler.

Method Detail

close

public void close()

This method should be called by clients after completing their work with the JdbcCrawler can release its JDBC- and other resources. If the method is called before the CrawlingProducerThread terminates, the thread will terminate after evaluating the _forceClosing-flag the next time which is set by the close() -Method.

getProducerThread

public java.lang.Thread getProducerThread()

Returns:

The Crawlers ProducerThread.

See Also:

CrawlingProducerThread

initialize

public void initialize(DataSourceConnectionConfig config)
                throws CrawlerException,
                       CrawlerCriticalException

Initialize.

Parameters:

config - the DataSourceConnectionConfig

Throws:

CrawlerException - the crawler exception

CrawlerCriticalException - the crawler critical exception

getNext

public DataReference[] getNext()
                        throws CrawlerException,
                               CrawlerCriticalException

Returns an array of DataReference objects. The size of the returned array may vary from call to call. The maximum size of the array is determined by configuration or by the implementation class.

Returns:

an array of DataReference objects or null, if no more DataReference exist

Throws:

CrawlerException - if any error occurs

CrawlerCriticalException - the crawler critical exception

See Also:

Crawler.getNext()

dispose

public void dispose(ConnectivityId id)

Disposes the record with the given Id.

Parameters:

id - the record id

See Also:

org.eclipse.smila.connectivity.framework.CrawlerCallback#dispose(org.eclipse.smila.datamodel.id.Id)

getAttachment

public byte[] getAttachment(ConnectivityId id,
                            java.lang.String name)
                     throws CrawlerException,
                            CrawlerCriticalException

Returns the attachment for the given Id and name pair.

Parameters:

id - the record id

name - the name of the attachment

Returns:

a byte[] containing the attachment

Throws:

CrawlerException - if any non critical error occurs

CrawlerCriticalException - if any critical error occurs

See Also:

org.eclipse.smila.connectivity.framework.CrawlerCallback#getAttachment(org.eclipse.smila.datamodel.id.Id, java.lang.String)

getAttachmentNames

public java.lang.String[] getAttachmentNames(ConnectivityId id)
                                      throws CrawlerException,
                                             CrawlerCriticalException

Returns an array of String[] containing the names of the available attachments for the given id.

Parameters:

id - the record id

Returns:

an array of String[] containing the names of the available attachments

Throws:

CrawlerException - if any non critical error occurs

CrawlerCriticalException - if any critical error occurs

See Also:

org.eclipse.smila.connectivity.framework.CrawlerCallback#getAttachmentNames(org.eclipse.smila.datamodel.id.Id)

getMetadata

public AnyMap getMetadata(ConnectivityId id)
                   throws CrawlerException,
                          CrawlerCriticalException

Returns the metadata for the given id.

Parameters:

id - the record id

Returns:

the MObject

Throws:

CrawlerException - if any non critical error occurs

CrawlerCriticalException - if any critical error occurs

See Also:

org.eclipse.smila.connectivity.framework.CrawlerCallback#getMObject(org.eclipse.smila.datamodel.id.Id)

getCounterHelper

public CrawlerPerformanceCounterHelper<? extends ConnectivityPerformanceAgent> getCounterHelper()

Returns:

helper for crawler counters.