org.gcube.datatransformation.datatransformationlibrary

Class DTSCore

java.lang.Object

org.gcube.datatransformation.datatransformationlibrary.DTSCore

public class DTSCore
extends Object

Author:

Dimitris Katris, NKUA DTSCore is the class invoked by any interface (as the web service interface) which needs to utilize the data transformationUnit functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static long	TIMEOUT Timeout when data source collection is empty

Constructor Summary

Constructors

Constructor and Description
DTSCore(IManager iManager, TransformationsGraph graph) Constructor of DTSCore.

Method Summary

Methods

Modifier and Type	Method and Description
void	clean()
void	destroy() Destroys the information kept by the DTSCore instance.
ArrayList<TransformationUnit>	findApplicableTransformationUnits(ContentType sourceContentType, ContentType targetContentType, boolean createAndPublishCompositeTP) Searches for TransformationUnits that are able to perform a transformationUnit from a source to a target ContentType.
ArrayList<ContentType>	getAvailableTargetContentTypes(ContentType sourceContentType) Searches for ContentTypes to which an object can be transformed.
static DataBridge	getDataBridge() Returns an instance of a DataBridge.
static DataBridge	getHardDataBridge() Returns an instance of a DataBridge.
IManager	getIManager() Returns the iManager object.
void	initializeAdaptor(TransformationDescription desc, String scope, boolean isTest)
void	transformData(DataSource source, ContentType targetContentType) This method transforms the input data which are fetched by the DataSource to the target ContentType and stores the transformed DataElements to the DataSink.
void	transformDataWithTransformationProgram(DataSource source, String transformationProgramID, Parameter[] programUnboundParameters, ContentType targetContentType) This method transforms the input data which are fetched by the DataSources to the target ContentType and stores the transformed DataElements to the DataSink.
void	transformDataWithTransformationUnit(String transformationProgramID, String transformationUnitID, Parameter[] programUnboundParameters, ContentType targetContentType, boolean filterSources) This method transforms the input data which are fetched by the DataSources to the target ContentType and stores the transformed DataElements to the DataSink.

Methods inherited from class java.lang.Object

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

Field Detail

TIMEOUT

public static final long TIMEOUT

Timeout when data source collection is empty

See Also:

Constant Field Values

Constructor Detail

DTSCore

public DTSCore(IManager iManager,
       TransformationsGraph graph)
        throws Exception

Constructor of DTSCore. DTSCore requires a IManager instance and a TransformationsGraph instance in order to be initialized.

Parameters:

iManager - The IManager from which the DTSCore instance will retrieve the TransformationPrograms.

graph - The TransformationsGraph which the DTSCore instance will use in order to search for applicable TransformationUnits.

Throws:

Exception - If imanager or graph is not set.

Method Detail

getIManager

public IManager getIManager()

Returns the iManager object.

Returns:

The iManager.

destroy

public void destroy()

Destroys the information kept by the DTSCore instance.

initializeAdaptor

public void initializeAdaptor(TransformationDescription desc,
                     String scope,
                     boolean isTest)
                       throws Exception

Throws:

Exception

transformDataWithTransformationProgram

public void transformDataWithTransformationProgram(DataSource source,
                                          String transformationProgramID,
                                          Parameter[] programUnboundParameters,
                                          ContentType targetContentType)
                                            throws Exception

This method transforms the input data which are fetched by the DataSources to the target ContentType and stores the transformed DataElements to the DataSink. The TransformationProgram which will be used by the service is indicated by the client.

This method should be only used externally as internally the transformationUnit id is known. Putting a TP without the transformationUnit id is useful when having a TP that is created in order to perform an operation over some variable input content types, performed by different programs and the target format has common semantics.

Parameters:

source - The DataSource from which the DTSCore#transformDataWithTransformationProgram(DataSource, String, Parameter[], ContentType, DataSink) method fetches the DataElements.

transformationProgramID - The id of the TransformationProgram.

programUnboundParameters - The unbound program parameters which are set by the client.

targetContentType - The ContentType to which the DataElements are transformed.

Throws:

Exception - If an error occurred in the transformationUnit process.

transformDataWithTransformationUnit

public void transformDataWithTransformationUnit(String transformationProgramID,
                                       String transformationUnitID,
                                       Parameter[] programUnboundParameters,
                                       ContentType targetContentType,
                                       boolean filterSources)
                                         throws Exception

This method transforms the input data which are fetched by the DataSources to the target ContentType and stores the transformed DataElements to the DataSink. The TransformationUnit which will be used by the service is indicated by the client.

Parameters:

transformationProgramID - The id of the TransformationProgram.

transformationUnitID - The id of the TransformationUnit.

programUnboundParameters - A list with Program parameters set by the client.

targetContentType - The ContentType to which the DataElements are transformed.

filterSources - If true then the ContentType of each DataElement from the DataSources is checked if it conforms to the input expected by the TransformationUnit.

Throws:

Exception - If an error occurred in the transformationUnit process.

transformData

public void transformData(DataSource source,
                 ContentType targetContentType)

This method transforms the input data which are fetched by the DataSource to the target ContentType and stores the transformed DataElements to the DataSink. In this method the service by its self discovers the TransformationProgram to use.

Parameters:

source - The DataSource from which the DTSCore#transformData(DataSource, ContentType, DataSink) method fetches the DataElements.

targetContentType - The ContentType to which the DataElements are transformed.

clean

public void clean()

getDataBridge

public static DataBridge getDataBridge()

Returns an instance of a DataBridge. The class name of the DataBridge is set in the "dtslib.properties" file.

Returns:

The instance of the DataBridge.

getHardDataBridge

public static DataBridge getHardDataBridge()

Returns an instance of a DataBridge. The class name of the DataBridge is set in the "dtslib.properties" file. The difference with the getDataBridge() method is that hard DataBridges copies the content of each DataElement in the hard disk.

Returns:

The instance of the DataBridge.

findApplicableTransformationUnits

public ArrayList<TransformationUnit> findApplicableTransformationUnits(ContentType sourceContentType,
                                                              ContentType targetContentType,
                                                              boolean createAndPublishCompositeTP)

Searches for TransformationUnits that are able to perform a transformationUnit from a source to a target ContentType.

Parameters:

sourceContentType - The source ContentType.

targetContentType - The target ContentType.

createAndPublishCompositeTP - If true then the TransformationsGraph creates and publishes the composite TransformationPrograms.

Returns:

A list of applicable TransformationUnits.

getAvailableTargetContentTypes

public ArrayList<ContentType> getAvailableTargetContentTypes(ContentType sourceContentType)

Searches for ContentTypes to which an object can be transformed.

Parameters:

sourceContentType - The source ContentType.

Returns:

One or more available target ContentTypes.