com.armatiek.infofuze.source
Interface DataSourceIf

All Known Implementing Classes:

AbstractJDBCSource, AbstractSAXSource, AbstractStreamSource, CIFSSource, CSVSource, DirectJDBCSource, FileSystemSource, HTTPBasedSource, JNDIJDBCSource, LDAPSource, LocalFileSystemSource, NullSource, PooledJDBCSource, SolrSource, WebCrawlSource, WebDAVSource

public interface DataSourceIf

Interface that must implemented by all Infofuze Source classes.

Author:

Maarten Kroon

Method Summary

void	afterStreamClosed() Method that can be implemented to perform special operations after the source is closed.
void	close() Closes this source.
void	destroy()
java.lang.String	getName() Returns the name of this source.
java.lang.String	getTransformId() Returns the transformation identifier of the transformation this source is currently part of.
Definitions.TransformMode	getTransformMode() Returns the transformation mode of the transformation this source is currently part of.
boolean	isAutoReturning() Tests whether this source must be returned to the pool automatically when it is closed.
boolean	isOpen() Tests whether this source is open or not.
void	open() Opens this source.
void	reset() Resets this source (i.e. resets the transformation mode and identifier).
void	setAutoReturning(boolean value) Specifies if this source must be returned to the pool automatically when it is closed.
void	setParameters(java.util.List<Parameter> params) Sets the parameters.
void	setTransformId(java.lang.String id) Sets the transformation identifier.
void	setTransformMode(Definitions.TransformMode transformMode) Sets the transformation mode.

Method Detail

afterStreamClosed

void afterStreamClosed()

Method that can be implemented to perform special operations after the source is closed.

close

void close()

Closes this source.

destroy

void destroy()
             throws java.lang.Throwable

Throws:

java.lang.Throwable

getName

java.lang.String getName()

Returns the name of this source.

Returns:

A String specifying the name of this source

getTransformId

java.lang.String getTransformId()

Returns the transformation identifier of the transformation this source is currently part of.

Returns:

A String specifying the transformation identifier

getTransformMode

Definitions.TransformMode getTransformMode()

Returns the transformation mode of the transformation this source is currently part of.

Returns:

The transformation mode

isAutoReturning

boolean isAutoReturning()

Tests whether this source must be returned to the pool automatically when it is closed.

isOpen

boolean isOpen()

Tests whether this source is open or not.

open

void open()

Opens this source.

reset

void reset()

Resets this source (i.e. resets the transformation mode and identifier).

setAutoReturning

void setAutoReturning(boolean value)

Specifies if this source must be returned to the pool automatically when it is closed.

setTransformId

void setTransformId(java.lang.String id)

Sets the transformation identifier.

Parameters:

id - A String specifying the transformation identifier

setTransformMode

void setTransformMode(Definitions.TransformMode transformMode)

Sets the transformation mode.

Parameters:

transformMode - The transformation mode

setParameters

void setParameters(java.util.List<Parameter> params)

Sets the parameters.

Parameters:

params - A list containing the parameters