org.eclipse.smila.connectivity.framework.compound.zip
Class ZipCompoundCrawler

java.lang.Object
  org.eclipse.smila.connectivity.framework.AbstractCrawler
      org.eclipse.smila.connectivity.framework.compound.AbstractCompoundCrawler
          org.eclipse.smila.connectivity.framework.compound.zip.ZipCompoundCrawler

All Implemented Interfaces:

CompoundCrawler, Crawler, CrawlerCallback

public class ZipCompoundCrawler
extends AbstractCompoundCrawler

The Interface CompoundHandler.

Constructor Summary

ZipCompoundCrawler()

Method Summary

void	close() Ends crawl, allowing the Crawler implementation to close any open resources.
void	dispose(Id id) Disposes the record with the given Id.
byte[]	getAttachment(Id id, java.lang.String name) Returns the attachment for the given Id and name pair.
java.lang.String[]	getAttachmentNames(Id id) Returns an array of String[] containing the names of the available attachments for the given id.
MObject	getMObject(Id id) Returns the MObject for the given id.
DataReference[]	getNext() Returns an array of DataReference objects.
void	initialize(DataSourceConnectionConfig config) Initialize.

Methods inherited from class org.eclipse.smila.connectivity.framework.compound.AbstractCompoundCrawler

getCompoundRecord, setCompoundRecord

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

Methods inherited from interface org.eclipse.smila.connectivity.framework.Crawler

getCrawlerId

Constructor Detail

ZipCompoundCrawler

public ZipCompoundCrawler()

Parameters:

crawlerId -

Method Detail

initialize

public void initialize(DataSourceConnectionConfig config)
                throws CrawlerException,
                       CrawlerCriticalException

Initialize.

Parameters:

config - the DataSourceConnectionConfig

Throws:

CrawlerException - the crawler exception

CrawlerCriticalException - the crawler critical exception

See Also:

CompoundCrawler#initialize(DataSourceConnectionConfig)

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:

CompoundCrawler#getNext()

close

public void close()
           throws CrawlerException

Ends crawl, allowing the Crawler implementation to close any open resources.

Throws:

CrawlerException - if any error occurs

See Also:

CompoundCrawler#close()

getMObject

public MObject getMObject(Id id)
                   throws CrawlerException,
                          CrawlerCriticalException

Returns the MObject 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:

CrawlerCallback.getMObject(Id)

getAttachmentNames

public java.lang.String[] getAttachmentNames(Id 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:

CrawlerCallback.getAttachmentNames(Id)

getAttachment

public byte[] getAttachment(Id 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:

CrawlerCallback.getAttachment(Id, String)

dispose

public void dispose(Id id)

Disposes the record with the given Id.

Parameters:

id - the record id

See Also:

CrawlerCallback.dispose(Id)