org.eclipse.smila.connectivity.framework.compound
Interface CompoundManager

All Known Implementing Classes:

CompoundManagerImpl

public interface CompoundManager

The Interface CompoundManager.

Method Summary

Record	adaptCompoundRecord(Record record, DataSourceConnectionConfig config) Adapts the input record according to the given configuration.
Crawler	extract(Record record, DataSourceConnectionConfig config) * Extracts the elements of the given record and returns a Crawler over the extracted elements.
boolean	isCompound(Record record, DataSourceConnectionConfig config) Checks if a record is a compound object.

Method Detail

isCompound

boolean isCompound(Record record,
                   DataSourceConnectionConfig config)
                   throws CompoundException

Checks if a record is a compound object.

Parameters:

record - the Record

config - the DataSourceConnectionConfig

Returns:

true if the record is a compound object and is extractable by this CompoundManager, false otherwise

Throws:

CompoundException - if any error occurs

extract

Crawler extract(Record record,
                DataSourceConnectionConfig config)
                throws CompoundException

* Extracts the elements of the given record and returns a Crawler over the extracted elements.

Parameters:

record - the Record

config - the DataSourceConnectionConfig

Returns:

a Crawler interface over the extracted elements

Throws:

CompoundException - if any error occurs

adaptCompoundRecord

Record adaptCompoundRecord(Record record,
                           DataSourceConnectionConfig config)
                           throws CompoundException

Adapts the input record according to the given configuration. The record may be left unmodified, modified or even set to null.

Parameters:

record - the Record

config - the DataSourceConnectionConfig

Returns:

the adapted record

Throws:

CompoundException - if any error occurs