org.zanata.rest.service

Interface TranslationMemoryResource

@Path(value="/tm")
 @Produces(value="application/xml")
 @Consumes(value="application/xml")
public interface TranslationMemoryResource

Allows clients to [push and] pull translation memories.

Author:

Sean Flanigan sflaniga@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFERRED_MEDIA_TYPE
static String	SERVICE_PATH

Method Summary

Modifier and Type	Method and Description
Object	deleteTranslationUnits(String slug) Delete a collection of translation memory
javax.ws.rs.core.Response	getAllTranslationMemory(LocaleId srcLocale, LocaleId locale) Returns all translation memory in the system
javax.ws.rs.core.Response	getProjectIterationTranslationMemory(String projectSlug, String iterationSlug, LocaleId srcLocale, LocaleId locale) Retrieves translation memory for a project version
javax.ws.rs.core.Response	getProjectTranslationMemory(String projectSlug, LocaleId srcLocale, LocaleId locale) Retrieves translation memory for a project
javax.ws.rs.core.Response	getTranslationMemory(String slug) Retrieves a collection of translation memory
javax.ws.rs.core.Response	updateTranslationMemory(String slug, InputStream input) Updates a collection of translation memory

Field Detail

SERVICE_PATH

static final String SERVICE_PATH

See Also:

Constant Field Values

PREFERRED_MEDIA_TYPE

static final String PREFERRED_MEDIA_TYPE

See Also:

Constant Field Values

Method Detail

getAllTranslationMemory

@GET
 @Path(value="all")
javax.ws.rs.core.Response getAllTranslationMemory(@QueryParam(value="srcLocale") @Nullable
                                                                           LocaleId srcLocale,
                                                                           @QueryParam(value="locale") @Nullable
                                                                           LocaleId locale)

Returns all translation memory in the system

Parameters:

srcLocale - Source locale

locale - Translation locale

getProjectTranslationMemory

@GET
 @Path(value="projects/{projectSlug}")
javax.ws.rs.core.Response getProjectTranslationMemory(@PathParam(value="projectSlug") @Nonnull
                                                                                                  String projectSlug,
                                                                                                  @QueryParam(value="srcLocale") @Nullable
                                                                                                  LocaleId srcLocale,
                                                                                                  @QueryParam(value="locale") @Nullable
                                                                                                  LocaleId locale)

Retrieves translation memory for a project

Parameters:

projectSlug - Project identifier

srcLocale - Source locale

locale - Translation locale

getProjectIterationTranslationMemory

@GET
 @Path(value="projects/{projectSlug}/iterations/{iterationSlug}")
javax.ws.rs.core.Response getProjectIterationTranslationMemory(@PathParam(value="projectSlug") @Nonnull
                                                                                                                                      String projectSlug,
                                                                                                                                      @PathParam(value="iterationSlug") @Nonnull
                                                                                                                                      String iterationSlug,
                                                                                                                                      @QueryParam(value="srcLocale") @Nullable
                                                                                                                                      LocaleId srcLocale,
                                                                                                                                      @QueryParam(value="locale") @Nullable
                                                                                                                                      LocaleId locale)

Retrieves translation memory for a project version

Parameters:

projectSlug - Project identifier

iterationSlug - Project version identifier

srcLocale - Source locale

locale - Translation locale

getTranslationMemory

@GET
 @Path(value="{slug}")
javax.ws.rs.core.Response getTranslationMemory(@PathParam(value="slug") @Nonnull
                                                                           String slug)

Retrieves a collection of translation memory

Parameters:

slug - Identifier for a translation memory collection

updateTranslationMemory

@POST
 @Path(value="{slug}")
 @Consumes(value="*/*")
javax.ws.rs.core.Response updateTranslationMemory(@PathParam(value="slug")
                                                                                                       String slug,
                                                                                                       InputStream input)
                                                                                                throws Exception

Updates a collection of translation memory

Parameters:

slug - Identifier for a translation memory collection

input - Input stream of TMX file

Throws:

Exception

deleteTranslationUnits

@DELETE
 @Path(value="{slug}/transunits")
Object deleteTranslationUnits(@PathParam(value="slug")
                                                                        String slug)

Delete a collection of translation memory

Parameters:

slug - Identifier for a translation memory collection

Returns:

message of the operation