org.zanata.rest.service

Class MockGlossaryResource

java.lang.Object

org.zanata.rest.service.MockGlossaryResource

All Implemented Interfaces:

GlossaryResource

@Path(value="/glossary")
public class MockGlossaryResource
extends Object
implements GlossaryResource

Author:

Patrick Huang pahuang@redhat.com

Field Summary

Fields inherited from interface org.zanata.rest.service.GlossaryResource

GLOBAL_QUALIFIED_NAME, MAX_PAGE_SIZE, SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
MockGlossaryResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteAllEntries(String qualifiedName) Delete all entries in a glossary.
javax.ws.rs.core.Response	deleteEntry(Long id, String qualifiedName) Delete a glossary entry.
javax.ws.rs.core.Response	downloadFile(String fileType, String locales, String qualifiedName) Download all glossary entries as a file
javax.ws.rs.core.Response	getDetails(LocaleId locale, List<Long> termIds) Get the details for a set of glossary terms.
javax.ws.rs.core.Response	getEntries(LocaleId srcLocale, LocaleId transLocale, int page, int sizePerPage, String filter, String sort, String qualifiedName) Returns a subset of Glossary entries for the given source and translation locale as indicated by the paging parameters.
javax.ws.rs.core.Response	getInfo(String qualifiedName) Return source locales available for all glossary entries
javax.ws.rs.core.Response	getQualifiedName() Return default global glossary qualifiedName
javax.ws.rs.core.Response	post(List<GlossaryEntry> glossaryEntries, String locale, String qualifiedName) Create or update glossary entries.
javax.ws.rs.core.Response	search(LocaleId srcLocale, LocaleId transLocale, int maxResults, String searchText, String projectSlug) Returns Glossary entries based on a fuzzy text search.
javax.ws.rs.core.Response	upload(GlossaryFileUploadForm glossaryFileUploadForm) Upload glossary file (currently supported formats: po, csv)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MockGlossaryResource

public MockGlossaryResource()

Method Detail

getInfo

public javax.ws.rs.core.Response getInfo(String qualifiedName)

Description copied from interface: GlossaryResource

Return source locales available for all glossary entries

Specified by:

getInfo in interface GlossaryResource

Parameters:

qualifiedName - Qualified name of glossary, default to GlossaryResource.GLOBAL_QUALIFIED_NAME

getEntries

public javax.ws.rs.core.Response getEntries(LocaleId srcLocale,
                                            LocaleId transLocale,
                                            int page,
                                            int sizePerPage,
                                            String filter,
                                            String sort,
                                            String qualifiedName)

Description copied from interface: GlossaryResource

Returns a subset of Glossary entries for the given source and translation locale as indicated by the paging parameters.

Specified by:

getEntries in interface GlossaryResource

Parameters:

srcLocale - Source locale - Required (default value: en-US).

transLocale - Translation locale

page - Current request page (default value: 1)

sizePerPage - Size of entry per page (default/max value: 1000) GlossaryResource.MAX_PAGE_SIZE

filter - String filter for source content

sort - Fields to sort. Comma separated. e.g sort=desc,-part_of_speech See GlossarySortField

qualifiedName - Qualified name of glossary, default to GlossaryResource.GLOBAL_QUALIFIED_NAME

See Also:

org.zanata.rest.dto.GlossaryEntry} for details on the result list's contents.

search

public javax.ws.rs.core.Response search(LocaleId srcLocale,
                                        LocaleId transLocale,
                                        int maxResults,
                                        String searchText,
                                        String projectSlug)

Description copied from interface: GlossaryResource

Returns Glossary entries based on a fuzzy text search.

Specified by:

search in interface GlossaryResource

Parameters:

srcLocale - Source locale

transLocale - Translation locale

maxResults - Maximum results for global and project queries. May return up to double this number. Default: 20

searchText - Text containing terms to match in the search.

projectSlug - (optional) Project slug if a project glossary should be searched in addition to the global glossary.

See Also:

org.zanata.rest.dto.GlossaryEntry} for details on the result list's contents.

getDetails

public javax.ws.rs.core.Response getDetails(LocaleId locale,
                                            List<Long> termIds)

Description copied from interface: GlossaryResource

Get the details for a set of glossary terms. Includes source details, and details from the given locale.

Specified by:

getDetails in interface GlossaryResource

Parameters:

locale - include locale-specific detail for this locale

termIds - id for glossary terms in the default locale, found in results of GlossaryResource.search(LocaleId, LocaleId, int, String, String)

Returns:

Source and target glossary details.

downloadFile

public javax.ws.rs.core.Response downloadFile(@DefaultValue(value="csv")
                                              String fileType,
                                              String locales,
                                              String qualifiedName)

Description copied from interface: GlossaryResource

Download all glossary entries as a file

Specified by:

downloadFile in interface GlossaryResource

Parameters:

fileType - 'po' or 'csv' (case insensitive) are currently supported

locales - optional comma separated list of languages required.

qualifiedName - Qualified name of glossary, default to GlossaryResource.GLOBAL_QUALIFIED_NAME

Returns:

A file stream with the glossary contents in the specified format

post

public javax.ws.rs.core.Response post(List<GlossaryEntry> glossaryEntries,
                                      String locale,
                                      String qualifiedName)

Description copied from interface: GlossaryResource

Create or update glossary entries. Glossary Terms with a locale different from the given locale parameter will be ignored.

Specified by:

post in interface GlossaryResource

Parameters:

glossaryEntries - The glossary entries to create/update

locale - Locale to which the given glossary entries belong

qualifiedName - Qualified name of glossary, defaults to GlossaryResource.GLOBAL_QUALIFIED_NAME

getQualifiedName

public javax.ws.rs.core.Response getQualifiedName()

Description copied from interface: GlossaryResource

Return default global glossary qualifiedName

Specified by:

getQualifiedName in interface GlossaryResource

upload

public javax.ws.rs.core.Response upload(GlossaryFileUploadForm glossaryFileUploadForm)

Description copied from interface: GlossaryResource

Upload glossary file (currently supported formats: po, csv)

Specified by:

upload in interface GlossaryResource

Parameters:

glossaryFileUploadForm - Multi-part form with the following named parts:
file: The file contents
srcLocale: Source locale for the glossary entries
transLocale: Translation locale for the glossary entries
fileName: The name of the file being uploaded
qualifiedName: The qualified name for the glossary

deleteEntry

public javax.ws.rs.core.Response deleteEntry(Long id,
                                             String qualifiedName)

Description copied from interface: GlossaryResource

Delete a glossary entry.

Specified by:

deleteEntry in interface GlossaryResource

Parameters:

id - id for source glossary term

qualifiedName - Qualified name of glossary, defaults to GlossaryResource.GLOBAL_QUALIFIED_NAME

Returns:

the removed glossary entry

deleteAllEntries

public javax.ws.rs.core.Response deleteAllEntries(String qualifiedName)

Description copied from interface: GlossaryResource

Delete all entries in a glossary.

Specified by:

deleteAllEntries in interface GlossaryResource

Parameters:

qualifiedName - Qualified name of glossary, defaults to GlossaryResource.GLOBAL_QUALIFIED_NAME

Returns:

The number of deleted glossary entries