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 package org.opencastproject.textextractor.api;
23
24 import java.io.File;
25 import java.io.IOException;
26 import java.util.List;
27
28 /**
29 * Interface for implementations that are able to extract text from an image.
30 */
31 public interface TextExtractor {
32
33 /**
34 * Extracts text from the image and returns it as a set of lines in the text frame.
35 *
36 * @param image
37 * the image
38 * @return the text
39 * @throws IOException
40 * if the file can't be read
41 * @throws TextExtractorException
42 * if text extraction fails
43 */
44 List<String> extract(File image) throws IOException, TextExtractorException;
45
46 }