This repository has been archived by the owner on Nov 9, 2017. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 57
/
TranslationFileService.java
155 lines (136 loc) · 5.92 KB
/
TranslationFileService.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/*
* Copyright 2010, Red Hat, Inc. and individual contributors as indicated by the
* @author tags. See the copyright.txt file in the distribution for a full
* listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This software is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this software; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF
* site: http://www.fsf.org.
*/
package org.zanata.service;
import org.zanata.adapter.FileFormatAdapter;
import org.zanata.common.DocumentType;
import org.zanata.exception.ZanataServiceException;
import org.zanata.rest.dto.resource.Resource;
import org.zanata.rest.dto.resource.TranslationsResource;
import java.io.File;
import java.io.InputStream;
import java.net.URI;
import java.util.Set;
/**
* Provides basic services to transform and process translation files.
*
* @author Carlos Munoz <a href="mailto:camunoz@redhat.com">camunoz@redhat.com</a>
*/
public interface TranslationFileService
{
/**
* Extract the translated strings from a document file to a usable form, using appropriate
* id mapping.
*
* @param fileContents the document to parse
* @param fileName the name including extension for the file (used to determine how to parse file)
* @param originalIsPo true if the document was originally uploaded in po format
* @return a representation of the translations
* @throws ZanataServiceException if there is no adapter available for the
* document format, or there is an error during parsing
*/
TranslationsResource parseTranslationFile(InputStream fileContents, String fileName, String localeId, boolean originalIsPo) throws ZanataServiceException;
/**
* Extract the translatable strings from a new document file or from a new version of an existing
* document file to a usable form.
*
* @param fileContents
* @param docId the id of an existing document
* @param uploadFileName name of the new file being parsed, used only to identify format
* @param offlinePo true to use msgctxt as the id for each text flow
* @return a usable representation of the document
*/
Resource parseUpdatedDocumentFile(InputStream fileContents, String docId, String uploadFileName, boolean offlinePo);
/**
* Extracts the translatable strings from a document file to a usable form.
*
* @param documentFile location of the document to parse
* @param path to use within the Zanata project-iteration
* @param fileName to use within the Zanata project-iteration
* @return a usable representation of the document
* @throws ZanataServiceException if there is no adapter available for the
* document format, or there is an error during parsing
*/
Resource parseDocumentFile(URI documentFile, String path, String fileName) throws ZanataServiceException;
/**
* Extract the translatable strings from a new version of an existing document file to a usable form.
*
* @param documentFile location of the document to parse
* @param docId the id of an existing document
* @param uploadFileName name of the new file being parsed, used only to identify format
* @return a usable representation of the document
* @throws ZanataServiceException
*/
Resource parseUpdatedDocumentFile(URI documentFile, String docId, String uploadFileName) throws ZanataServiceException;
/**
* Check whether a handler for the given document type is available.
*
* @param fileNameOrExtension full filename with extension, or just extension
* @return
*/
boolean hasAdapterFor(DocumentType type);
/**
* Check whether a handler for the given file type is available.
*
* @param fileNameOrExtension full filename with extension, or just extension
* @return
* @deprecated use {@link #hasAdapterFor(DocumentType)}s
*/
@Deprecated
boolean hasAdapterFor(String fileNameOrExtension);
Set<String> getSupportedExtensions();
/**
* @deprecated use {@link #getAdapterFor(DocumentType)}
*/
@Deprecated
FileFormatAdapter getAdapterFor(String fileNameOrExtension);
FileFormatAdapter getAdapterFor(DocumentType type);
/**
* Persist an input stream to a temporary file.
*
* The created file should be removed using {@link #removeTempFile(File)} when it is no longer required.
*
* @param fileContents stream of bytes to persist
* @return reference to the created file
*/
File persistToTempFile(InputStream fileContents);
/**
* Attempts to remove a temporary file from disk.
*
* If the file cannot be removed, it is marked for removal on application exit.
*
* @param tempFile file to remove
*/
void removeTempFile(File tempFile);
boolean hasPersistedDocument(String projectSlug, String iterationSlug, String docPath, String docName);
String getFileExtension(String projectSlug, String iterationSlug, String docPath, String docName);
/**
*
* @param fileNameOrExtension
* @return the extension for a given filename, or the extension that was passed in
*/
String extractExtension(String fileNameOrExtension);
/**
* @return true if the specified document is of type po, false if it is any other
* type, including null.
*/
boolean isPoDocument(String projectSlug, String iterationSlug, String docId);
String generateDocId(String path, String fileName);
}