org.gcube.datatransformation

Class DataTransformationService

java.lang.Object

org.gcube.datatransformation.DataTransformationService

All Implemented Interfaces:

org.gcube.datatransformation.rest.commons.DataTransformationServiceAPI

@Path(value="/")
public class DataTransformationService
extends Object
implements org.gcube.datatransformation.rest.commons.DataTransformationServiceAPI

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCOPE_HEADER

Constructor Summary

Constructors

Constructor and Description
DataTransformationService()

Method Summary

Methods

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

Field Detail

SCOPE_HEADER

public static final String SCOPE_HEADER

See Also:

Constant Field Values

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(@HeaderParam(value="gcube-scope")
                                                     String scope)

Specified by:

statistics in interface org.gcube.datatransformation.rest.commons.DataTransformationServiceAPI

transformData

@POST
@Path(value="/transformData")
@Produces(value="application/json; charset=UTF-8")
public javax.ws.rs.core.Response transformData(@HeaderParam(value="gcube-scope")
                                                         String scope,
                                                         @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)

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.

Specified by:

transformData in interface org.gcube.datatransformation.rest.commons.DataTransformationServiceAPI

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(@HeaderParam(value="gcube-scope")
                                                                                  String scope,
                                                                                  @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)

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.

Specified by:

transformDataWithTransformationProgram in interface org.gcube.datatransformation.rest.commons.DataTransformationServiceAPI

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(@HeaderParam(value="gcube-scope")
                                                                               String scope,
                                                                               @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)

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.

Specified by:

transformDataWithTransformationUnit in interface org.gcube.datatransformation.rest.commons.DataTransformationServiceAPI

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(@HeaderParam(value="gcube-scope")
                                                                             String scope,
                                                                             @FormParam(value="sourceContentType")
                                                                             String sourceContentTypeJSON,
                                                                             @FormParam(value="targetContentType")
                                                                             String targetContentTypeJSON,
                                                                             @FormParam(value="createAndPublishCompositeTP")
                                                                             String createAndPublishCompositeTPJSON,
                                                                             @QueryParam(value="pretty")@DefaultValue(value="false")
                                                                             Boolean pretty)

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

Specified by:

findApplicableTransformationUnits in interface org.gcube.datatransformation.rest.commons.DataTransformationServiceAPI

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(@HeaderParam(value="gcube-scope")
                                                                           String scope,
                                                                           @FormParam(value="sourceContentType")
                                                                           String sourceContentTypeJSON,
                                                                           @QueryParam(value="pretty")@DefaultValue(value="false")
                                                                           Boolean pretty)

Searches for ContentTypes to which an object can be transformed.

Specified by:

findAvailableTargetContentTypes in interface org.gcube.datatransformation.rest.commons.DataTransformationServiceAPI

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(@HeaderParam(value="gcube-scope")
                                                                       String scope,
                                                                       @FormParam(value="query")
                                                                       String queryJSON,
                                                                       @QueryParam(value="pretty")@DefaultValue(value="false")
                                                                       Boolean pretty)

Performs a query to get information about the transformation programs.

Specified by:

queryTransformationPrograms in interface org.gcube.datatransformation.rest.commons.DataTransformationServiceAPI

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.