-
Notifications
You must be signed in to change notification settings - Fork 154
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#4634 - Pull document file storage code out of document service into …
…a new service - Move the code out
- Loading branch information
Showing
18 changed files
with
384 additions
and
191 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
81 changes: 81 additions & 0 deletions
81
...-api/src/main/java/de/tudarmstadt/ukp/inception/documents/api/DocumentStorageService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
/* | ||
* Licensed to the Technische Universität Darmstadt under one | ||
* or more contributor license agreements. See the NOTICE file | ||
* distributed with this work for additional information | ||
* regarding copyright ownership. The Technische Universität Darmstadt | ||
* licenses this file to you under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance | ||
* with the License. | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package de.tudarmstadt.ukp.inception.documents.api; | ||
|
||
import java.io.File; | ||
import java.io.IOException; | ||
import java.io.InputStream; | ||
|
||
import org.apache.wicket.util.resource.IResourceStream; | ||
|
||
import de.tudarmstadt.ukp.clarin.webanno.model.SourceDocument; | ||
|
||
public interface DocumentStorageService | ||
{ | ||
/** | ||
* @return a stream to the source document file. | ||
* | ||
* @param document | ||
* the source document. | ||
* @throws IOException | ||
* if there was an IO-level problem. | ||
*/ | ||
InputStream openSourceDocumentFile(SourceDocument document) throws IOException; | ||
|
||
/** | ||
* Write the data from the given input stream to the source document file. | ||
* | ||
* @param inputStream | ||
* the source document data. | ||
* @param document | ||
* the source document. | ||
* @throws IOException | ||
* if there was an IO-level problem. | ||
*/ | ||
void writeSourceDocumentFile(SourceDocument document, InputStream inputStream) | ||
throws IOException; | ||
|
||
/** | ||
* Copy the source document file to the given directory. | ||
* | ||
* @param document | ||
* the source document. | ||
* @param targetDir | ||
* the target directory. | ||
* @throws IOException | ||
* if there was an IO-level problem. | ||
*/ | ||
void copySourceDocumentFile(SourceDocument document, File targetDir) throws IOException; | ||
|
||
/** | ||
* @param document | ||
* the source document. | ||
* @return the size of the source document file. | ||
*/ | ||
long getSourceDocumentFileSize(SourceDocument document); | ||
|
||
File getSourceDocumentFile(SourceDocument aDocument); | ||
|
||
IResourceStream getSourceDocumentResourceStream(SourceDocument aDocument); | ||
|
||
IResourceStream getSourceDocumentResourceStream(SourceDocument aDocument, String aContentType); | ||
|
||
void removeSourceDocumentFile(SourceDocument aDocument) throws IOException; | ||
|
||
boolean existsSourceDocumentFile(SourceDocument aDocument) throws IOException; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.