2007-10-27 17:57:10 -04:00
|
|
|
/* ====================================================================
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
The ASF 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. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
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 org.apache.poi;
|
|
|
|
|
2013-06-17 03:53:59 -04:00
|
|
|
import java.io.Closeable;
|
|
|
|
import java.io.IOException;
|
|
|
|
|
2007-10-27 17:57:10 -04:00
|
|
|
/**
|
|
|
|
* Common Parent for Text Extractors
|
|
|
|
* of POI Documents.
|
|
|
|
* You will typically find the implementation of
|
|
|
|
* a given format's text extractor under
|
|
|
|
* org.apache.poi.[format].extractor .
|
2016-06-06 19:33:00 -04:00
|
|
|
*
|
2014-11-14 19:00:30 -05:00
|
|
|
* @see org.apache.poi.hssf.extractor.ExcelExtractor
|
|
|
|
* @see org.apache.poi.hslf.extractor.PowerPointExtractor
|
|
|
|
* @see org.apache.poi.hdgf.extractor.VisioTextExtractor
|
|
|
|
* @see org.apache.poi.hwpf.extractor.WordExtractor
|
2007-10-27 17:57:10 -04:00
|
|
|
*/
|
2013-06-17 03:53:59 -04:00
|
|
|
public abstract class POITextExtractor implements Closeable {
|
2015-12-20 15:39:01 -05:00
|
|
|
private Closeable fsToClose = null;
|
|
|
|
|
2007-10-27 17:57:10 -04:00
|
|
|
/**
|
|
|
|
* Retrieves all the text from the document.
|
|
|
|
* How cells, paragraphs etc are separated in the text
|
|
|
|
* is implementation specific - see the javadocs for
|
|
|
|
* a specific project for details.
|
|
|
|
* @return All the text from the document
|
|
|
|
*/
|
|
|
|
public abstract String getText();
|
2008-08-12 15:02:41 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns another text extractor, which is able to
|
|
|
|
* output the textual content of the document
|
|
|
|
* metadata / properties, such as author and title.
|
2016-06-06 19:33:00 -04:00
|
|
|
*
|
|
|
|
* @return the metadata and text extractor
|
2008-08-12 15:02:41 -04:00
|
|
|
*/
|
|
|
|
public abstract POITextExtractor getMetadataTextExtractor();
|
2015-12-20 15:39:01 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Used to ensure file handle cleanup.
|
2016-06-06 19:33:00 -04:00
|
|
|
*
|
|
|
|
* @param fs filesystem to close
|
2015-12-20 15:39:01 -05:00
|
|
|
*/
|
|
|
|
public void setFilesystem(Closeable fs) {
|
|
|
|
fsToClose = fs;
|
|
|
|
}
|
2013-06-17 03:53:59 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Allows to free resources of the Extractor as soon as
|
|
|
|
* it is not needed any more. This may include closing
|
|
|
|
* open file handles and freeing memory.
|
|
|
|
*
|
|
|
|
* The Extractor cannot be used after close has been called.
|
|
|
|
*/
|
2016-06-06 19:33:00 -04:00
|
|
|
@Override
|
|
|
|
public void close() throws IOException {
|
2015-12-20 15:39:01 -05:00
|
|
|
if(fsToClose != null) {
|
|
|
|
fsToClose.close();
|
|
|
|
}
|
2013-06-17 03:53:59 -04:00
|
|
|
}
|
2007-10-27 17:57:10 -04:00
|
|
|
}
|