DataTransformationService (DataTransformationService 3.0.0-SNAPSHOT API)

java.lang.Object
- org.gcube.datatransformation.DataTransformationService

@Path(value="/")
public class DataTransformationService
extends Object

Constructor Summary

Constructors
Constructor and Description

DataTransformationService()

Constructors
Constructor and Description
`DataTransformationService()`

Method Summary

Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`findApplicableTransformationUnits(String sourceContentTypeJSON, String targetContentTypeJSON, String createAndPublishCompositeTPJSON, Boolean all, Boolean pretty, String scope)` Searches for `TransformationUnit`s that are able to perform a transformation from a source to a target `ContentType`.
`javax.ws.rs.core.Response`	`findAvailableTargetContentTypes(String sourceContentTypeJSON, Boolean all, Boolean pretty, String scope)` Searches for `ContentType`s to which an object can be transformed.
`javax.ws.rs.core.Response`	`queryTransformationPrograms(String queryJSON, Boolean all, Boolean pretty, String scope)` Performs a query to get information about the transformation programs.
`javax.ws.rs.core.Response`	`statistics()`
`javax.ws.rs.core.Response`	`transformData(String inputJSON, String targetContentTypeJSON, String outputJSON, String createReportJSON, Boolean all, Boolean pretty, String scope)` This method transforms the input data to the target `ContentType` and stores the results to the output.
`javax.ws.rs.core.Response`	`transformDataWithTransformationProgram(String inputJSON, String tpIDJSON, String targetContentTypeJSON, String tProgramUnboundParametersJSON, String outputJSON, String createReportJSON, Boolean all, Boolean pretty, String scope)` This method transforms the input data to the target `ContentType` and stores the results to the output.
`javax.ws.rs.core.Response`	`transformDataWithTransformationUnit(String inputsJSON, String tpIDJSON, String transformationUnitIDJSON, String targetContentTypeJSON, String tProgramUnboundParametersJSON, String outputJSON, String filterSourcesJSON, String createReportJSON, Boolean all, Boolean pretty, String scope)` This method transforms the input data to the target `ContentType` and stores the results to the output.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataTransformationService

public DataTransformationService()
                          throws Exception

Throws:: Exception

Method Detail

statistics

@GET
@Path(value="/statistics")
@Produces(value="application/xml; charset=UTF-8")
public javax.ws.rs.core.Response statistics()

transformData

@POST
@Path(value="/transformData")
@Produces(value="application/json; charset=UTF-8")
public javax.ws.rs.core.Response transformData(@FormParam(value="input")
                                                         String inputJSON,
                                                         @FormParam(value="targetContentType")
                                                         String targetContentTypeJSON,
                                                         @FormParam(value="output")
                                                         String outputJSON,
                                                         @FormParam(value="createReport")
                                                         String createReportJSON,
                                                         @QueryParam(value="all")@DefaultValue(value="false")
                                                         Boolean all,
                                                         @QueryParam(value="pretty")@DefaultValue(value="false")
                                                         Boolean pretty,
                                                         @HeaderParam(value="gcube-scope")
                                                         String scope)

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:: inputJSON - The input (type + value); targetContentTypeJSON - the target ContentType; outputJSON - The output (type + value); createReportJSON - a boolean that denotes if the reporting mechanism shall be enabled; all - if results are printed; pretty - if pretty print is in use; scope - the scope of the request, if provided
Returns:: The output value as well as the identifier of the report (if requested)

transformDataWithTransformationProgram

@POST
@Path(value="/transformDataWithTransformationProgram")
@Produces(value="application/json; charset=UTF-8")
public javax.ws.rs.core.Response transformDataWithTransformationProgram(@FormParam(value="input")
                                                                                  String inputJSON,
                                                                                  @FormParam(value="tpID")
                                                                                  String tpIDJSON,
                                                                                  @FormParam(value="targetContentType")
                                                                                  String targetContentTypeJSON,
                                                                                  @FormParam(value="tProgramUnboundParameters")
                                                                                  String tProgramUnboundParametersJSON,
                                                                                  @FormParam(value="output")
                                                                                  String outputJSON,
                                                                                  @FormParam(value="createReport")
                                                                                  String createReportJSON,
                                                                                  @QueryParam(value="all")@DefaultValue(value="false")
                                                                                  Boolean all,
                                                                                  @QueryParam(value="pretty")@DefaultValue(value="false")
                                                                                  Boolean pretty,
                                                                                  @HeaderParam(value="gcube-scope")
                                                                                  String scope)

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:: inputJSON - The input (type + value); tpIDJSON - the transformation program id; targetContentTypeJSON - the target ContentType; tProgramUnboundParametersJSON - the transformation unbound parameters; outputJSON - The output (type + value); createReportJSON - a boolean that denotes if the reporting mechanism shall be enabled; all - if results are printed; pretty - if pretty print is in use; scope - the scope of the request, if provided
Returns:: The output value as well as the identifier of the report (if requested)

transformDataWithTransformationUnit

@POST
@Path(value="/transformDataWithTransformationUnit")
@Produces(value="application/json; charset=UTF-8")
public javax.ws.rs.core.Response transformDataWithTransformationUnit(@FormParam(value="inputs")
                                                                               String inputsJSON,
                                                                               @FormParam(value="tpID")
                                                                               String tpIDJSON,
                                                                               @FormParam(value="transformationUnitID")
                                                                               String transformationUnitIDJSON,
                                                                               @FormParam(value="targetContentType")
                                                                               String targetContentTypeJSON,
                                                                               @FormParam(value="tProgramUnboundParameters")
                                                                               String tProgramUnboundParametersJSON,
                                                                               @FormParam(value="output")
                                                                               String outputJSON,
                                                                               @FormParam(value="filterSources")
                                                                               String filterSourcesJSON,
                                                                               @FormParam(value="createReport")
                                                                               String createReportJSON,
                                                                               @QueryParam(value="all")@DefaultValue(value="false")
                                                                               Boolean all,
                                                                               @QueryParam(value="pretty")@DefaultValue(value="false")
                                                                               Boolean pretty,
                                                                               @HeaderParam(value="gcube-scope")
                                                                               String scope)

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:: inputsJSON - The inputs (type + value); tpIDJSON - the transformation program id; transformationUnitIDJSON - the unit id of the program; targetContentTypeJSON - the target ContentType; tProgramUnboundParametersJSON - the transformation unbound parameters; outputJSON - The output (type + value); filterSourcesJSON - either to filter the sources or not; createReportJSON - a boolean that denotes if the reporting mechanism shall be enabled; all - if results are printed; pretty - if pretty print is in use; scope - the scope of the request, if provided
Returns:: The output value as well as the identifier of the report (if requested)

findApplicableTransformationUnits

@POST
@Path(value="/findApplicableTransformationUnits")
@Produces(value="application/json; charset=UTF-8")
public javax.ws.rs.core.Response findApplicableTransformationUnits(@FormParam(value="sourceContentType")
                                                                             String sourceContentTypeJSON,
                                                                             @FormParam(value="targetContentType")
                                                                             String targetContentTypeJSON,
                                                                             @FormParam(value="createAndPublishCompositeTP")
                                                                             String createAndPublishCompositeTPJSON,
                                                                             @QueryParam(value="all")@DefaultValue(value="false")
                                                                             Boolean all,
                                                                             @QueryParam(value="pretty")@DefaultValue(value="false")
                                                                             Boolean pretty,
                                                                             @HeaderParam(value="gcube-scope")
                                                                             String scope)

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

Parameters:: sourceContentTypeJSON - source ContentType; targetContentTypeJSON - target ContentType; createAndPublishCompositeTPJSON - a boolean that denotes if the reporting mechanism shall be enabled; all - if results are printed; pretty - if pretty print is in use; scope - the scope of the request, if provided
Returns:: One or more available transformation units that can perform the conversion from the source to the target ContentType.

findAvailableTargetContentTypes

@POST
@Path(value="/findAvailableTargetContentTypes")
@Produces(value="application/json; charset=UTF-8")
public javax.ws.rs.core.Response findAvailableTargetContentTypes(@FormParam(value="sourceContentType")
                                                                           String sourceContentTypeJSON,
                                                                           @QueryParam(value="all")@DefaultValue(value="false")
                                                                           Boolean all,
                                                                           @QueryParam(value="pretty")@DefaultValue(value="false")
                                                                           Boolean pretty,
                                                                           @HeaderParam(value="gcube-scope")
                                                                           String scope)

Searches for ContentTypes to which an object can be transformed.

Parameters:: sourceContentTypeJSON - source ContentType; all - if results are printed; pretty - if pretty print is in use; scope - the scope of the request, if provided
Returns:: One or more available target ContentTypes.

queryTransformationPrograms

@POST
@Path(value="/queryTransformationPrograms")
@Produces(value="application/xml; charset=UTF-8")
public javax.ws.rs.core.Response queryTransformationPrograms(@FormParam(value="query")
                                                                       String queryJSON,
                                                                       @QueryParam(value="all")@DefaultValue(value="false")
                                                                       Boolean all,
                                                                       @QueryParam(value="pretty")@DefaultValue(value="false")
                                                                       Boolean pretty,
                                                                       @HeaderParam(value="gcube-scope")
                                                                       String scope)

Performs a query to get information about the transformation programs.

Parameters:: queryJSON - The query about the transformation programs; all - if results are printed; pretty - if pretty print is in use; scope - the scope of the request, if provided
Returns:: The result of the query in xml format.

Class DataTransformationService

Constructor Summary