1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22
23 package org.opencastproject.textanalyzer.api;
24
25 import org.opencastproject.job.api.Job;
26 import org.opencastproject.mediapackage.Attachment;
27 import org.opencastproject.mediapackage.MediaPackageException;
28
29 /**
30 * Api for text analysis implementations, aimed at extracting text from an image.
31 */
32 public interface TextAnalyzerService {
33
34 /** Receipt type */
35 String JOB_TYPE = "org.opencastproject.textanalyzer";
36
37 /** The operation type */
38 String OPERATION = "extract";
39
40 /**
41 * Takes the given image and returns a receipt that can be used to get the resulting catalog.
42 *
43 * @param image
44 * element to analyze
45 * @return the metadata
46 * @throws TextAnalyzerException
47 * if the text in this image can not be analyzed
48 * @throws MediaPackageException
49 * if this attachment is not valid
50 */
51 Job extract(Attachment image) throws TextAnalyzerException, MediaPackageException;
52
53 }