org.zanata.rest.service

Interface StatisticsResource

All Known Subinterfaces:

IStatisticsResource

@Produces(value={"application/xml","application/json"})
 @Consumes(value={"application/xml","application/json"})
public interface StatisticsResource

Author:

Carlos Munoz camunoz@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_PATH

Method Summary

Modifier and Type	Method and Description
ContainerTranslationStatistics	getStatistics(String projectSlug, String iterationSlug, boolean includeDetails, boolean includeWordStats, String[] locales) Get translation statistics for a Project iteration and (optionally) it's underlying documents.
ContainerTranslationStatistics	getStatistics(String projectSlug, String iterationSlug, String docId, boolean includeWordStats, String[] locales) Get translation statistics for a Document.

Field Detail

SERVICE_PATH

static final String SERVICE_PATH

See Also:

Constant Field Values

Method Detail

getStatistics

@GET
 @Path(value="/proj/{projectSlug}/iter/{iterationSlug}")
ContainerTranslationStatistics getStatistics(@PathParam(value="projectSlug")
                                                                                                           String projectSlug,
                                                                                                           @PathParam(value="iterationSlug")
                                                                                                           String iterationSlug,
                                                                                                           @QueryParam(value="detail") @DefaultValue(value="false")
                                                                                                           boolean includeDetails,
                                                                                                           @QueryParam(value="word") @DefaultValue(value="false")
                                                                                                           boolean includeWordStats,
                                                                                                           @QueryParam(value="locale")
                                                                                                           String[] locales)

Get translation statistics for a Project iteration and (optionally) it's underlying documents.

Parameters:

projectSlug - Project identifier.

iterationSlug - Project Iteration identifier.

includeDetails - Indicates whether to include detailed statistics for the project iteration's documents.

includeWordStats - Indicates whether to include word-level statistics. Default is only message level stats.

locales - Locale statistics to be fetched. If this is empty, all locale statistics will be returned. This parameter may be specified multiple times if multiple locales are to be fetched.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response containing translation statistics for the specified parameters.
NOT FOUND(404) - If a project iteration could not be found for the given parameters.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

getStatistics

@GET
 @Path(value="/proj/{projectSlug}/iter/{iterationSlug}/doc/{docId:.*}")
ContainerTranslationStatistics getStatistics(@PathParam(value="projectSlug")
                                                                                                                          String projectSlug,
                                                                                                                          @PathParam(value="iterationSlug")
                                                                                                                          String iterationSlug,
                                                                                                                          @PathParam(value="docId")
                                                                                                                          String docId,
                                                                                                                          @QueryParam(value="word") @DefaultValue(value="false")
                                                                                                                          boolean includeWordStats,
                                                                                                                          @QueryParam(value="locale")
                                                                                                                          String[] locales)

Get translation statistics for a Document.

Parameters:

projectSlug - Project identifier.

iterationSlug - Project Iteration identifier.

docId - Document identifier.

includeWordStats - Indicates whether to include word-level statistics. Default is only message level stats.

locales - Locale statistics to be fetched. If this is empty, all locale statistics will be returned. This parameter may be specified multiple times if multiple locales are to be fetched.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response containing translation statistics for the specified parameters.
NOT FOUND(404) - If a document could not be found for the given parameters.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.