org.gcube.datatransformation.datatransformationservice
Class DataTransformationService

java.lang.Object
  extended by GCUBEPortType
      extended by org.gcube.datatransformation.datatransformationservice.DataTransformationService

public class DataTransformationService
extends GCUBEPortType

Author:
Dimitris Katris, NKUA DataTransformationService is the class implementing the WS-Interface of the DataTransformationServicePortType

Constructor Summary
DataTransformationService()
           
 
Method Summary
 ArrayOfDataElementIDandContentType evaluateContentTypeByDataElementID(EvaluateContentTypeByDataElementID request)
          Uses a ContentType evaluator which is identified by its type in order to evaluate the ContentType of an object.
 FindApplicableTransformationUnitsResponse findApplicableTransformationUnits(FindApplicableTransformationUnits params)
          Searches for TransformationUnits that are able to perform a transformation from a source to a target ContentType.
 FindAvailableTargetContentTypesResponse findAvailableTargetContentTypes(FindAvailableTargetContentTypes request)
          Searches for ContentTypes to which an object can be transformed.
 java.lang.String queryTransformationPrograms(java.lang.String query)
          Performs a query to get information about the transformation programs.
 TransformDataResponse transformData(TransformData params)
          This method transforms the input data to the target ContentType and stores the results to the output.
 TransformDataWithTransformationProgramResponse transformDataWithTransformationProgram(TransformDataWithTransformationProgram params)
          This method transforms the input data to the target ContentType and stores the results to the output.
 TransformDataWithTransformationUnitResponse transformDataWithTransformationUnit(TransformDataWithTransformationUnit params)
          This method transforms the input data to the target ContentType and stores the results to the output.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataTransformationService

public DataTransformationService()
Method Detail

transformData

public TransformDataResponse transformData(TransformData params)
                                    throws GCUBEFault
This method transforms the input data to the target ContentType and stores the results to the output. In this method the service by its self discovers the TransformationProgram to use.

Parameters:
params - The input (type + value), the output, the target ContentType and a boolean that denotes if the reporting mechanism shall be enabled.
Returns:
The output value as well as the identifier of the report (if requested).
Throws:
GCUBEFault - If an error in transformData method occurred.

transformDataWithTransformationProgram

public TransformDataWithTransformationProgramResponse transformDataWithTransformationProgram(TransformDataWithTransformationProgram params)
                                                                                      throws GCUBEFault
This method transforms the input data to the target ContentType and stores the results to the output. The TransformationProgram which will be used by the service is indicated by the client.

Parameters:
params - The input (type + value), the output, the target ContentType, the transformation program id and a boolean that denotes if the reporting mechanism shall be enabled.
Returns:
The output value as well as the identifier of the report (if requested).
Throws:
GCUBEFault - If an error in transformDataWithTransformationProgram method occurred.

transformDataWithTransformationUnit

public TransformDataWithTransformationUnitResponse transformDataWithTransformationUnit(TransformDataWithTransformationUnit params)
                                                                                throws GCUBEFault
This method transforms the input data to the target ContentType and stores the results to the output. The TransformationUnit which will be used by the service is indicated by the client.

Parameters:
The - input (type + value), the output, the target ContentType, the transformation program, unit id and a boolean that denotes if the reporting mechanism shall be enabled.
Returns:
The output value as well as the identifier of the report (if requested).
Throws:
GCUBEFault - If an error in transformDataWithTransformationUnit method occurred.

findApplicableTransformationUnits

public FindApplicableTransformationUnitsResponse findApplicableTransformationUnits(FindApplicableTransformationUnits params)
                                                                            throws GCUBEFault
Searches for TransformationUnits that are able to perform a transformation from a source to a target ContentType.

Parameters:
params - A source and a target ContentType.
Returns:
One or more available transformation units that can perform the conversion from the source to the target ContentType.
Throws:
GCUBEFault - If an error in searching for transformation units occurred.

findAvailableTargetContentTypes

public FindAvailableTargetContentTypesResponse findAvailableTargetContentTypes(FindAvailableTargetContentTypes request)
                                                                        throws GCUBEFault
Searches for ContentTypes to which an object can be transformed.

Parameters:
request - The source ContentType.
Returns:
One or more available target ContentTypes.
Throws:
GCUBEFault - If an error in searching for available target ContentTypes occurred.

queryTransformationPrograms

public java.lang.String queryTransformationPrograms(java.lang.String query)
                                             throws GCUBEFault
Performs a query to get information about the transformation programs.

Parameters:
query - The query about the transformation programs.
Returns:
The result of the query in xml format.
Throws:
GCUBEFault - If an error in performing the query occurred.

evaluateContentTypeByDataElementID

public ArrayOfDataElementIDandContentType evaluateContentTypeByDataElementID(EvaluateContentTypeByDataElementID request)
                                                                      throws GCUBEFault
Uses a ContentType evaluator which is identified by its type in order to evaluate the ContentType of an object.

Parameters:
request - The Data Element id and the type of the content type evaluator
Returns:
The ContentType of the data element.
Throws:
GCUBEFault - If an error in evaluating the ContentType occurred.