Package org.apache.poi.hslf.extractor
Class PowerPointExtractor
java.lang.Object
org.apache.poi.extractor.POITextExtractor
org.apache.poi.extractor.POIOLE2TextExtractor
org.apache.poi.hslf.extractor.PowerPointExtractor
- All Implemented Interfaces:
Closeable
,AutoCloseable
@Deprecated
@Removal(version="5.0.0")
public final class PowerPointExtractor
extends POIOLE2TextExtractor
Deprecated.
This class can be used to extract text from a PowerPoint file. Can optionally
also get the notes from one.
-
Field Summary
Fields inherited from class org.apache.poi.extractor.POIOLE2TextExtractor
document
-
Constructor Summary
ConstructorsConstructorDescriptionPowerPointExtractor
(InputStream iStream) Deprecated.Creates a PowerPointExtractor, from an Input StreamPowerPointExtractor
(String fileName) Deprecated.Creates a PowerPointExtractor, from a filePowerPointExtractor
(HSLFSlideShow slideShow) Deprecated.Deprecated.Creates a PowerPointExtractor, from a HSLFSlideShowDeprecated.Creates a PowerPointExtractor, from a specific place inside an open NPOIFSFileSystemDeprecated.Creates a PowerPointExtractor, from an open POIFSFileSystem -
Method Summary
Modifier and TypeMethodDescriptiongetNotes()
Deprecated.Fetches all the notes text from the slideshow, but not the slide textDeprecated.getText()
Deprecated.Fetches all the slide text from the slideshow, but not the notes, unless you've called setSlidesByDefault() and setNotesByDefault() to change thisgetText
(boolean getSlideText, boolean getNoteText) Deprecated.Fetches text from the slideshow, be it slide text or note text.getText
(boolean getSlideText, boolean getNoteText, boolean getCommentText, boolean getMasterText) Deprecated.static void
Deprecated.Basic extractor.void
setCommentsByDefault
(boolean commentsByDefault) Deprecated.Should a call to getText() return comments text? Default is novoid
setMasterByDefault
(boolean masterByDefault) Deprecated.Should a call to getText() return text from master? Default is novoid
setNotesByDefault
(boolean notesByDefault) Deprecated.Should a call to getText() return notes text? Default is novoid
setSlidesByDefault
(boolean slidesByDefault) Deprecated.Should a call to getText() return slide text? Default is yesMethods inherited from class org.apache.poi.extractor.POIOLE2TextExtractor
getDocSummaryInformation, getDocument, getMetadataTextExtractor, getRoot, getSummaryInformation
Methods inherited from class org.apache.poi.extractor.POITextExtractor
close, setFilesystem
-
Constructor Details
-
PowerPointExtractor
Deprecated. -
PowerPointExtractor
Deprecated.Creates a PowerPointExtractor, from a file- Parameters:
fileName
- The name of the file to extract from- Throws:
IOException
-
PowerPointExtractor
Deprecated.Creates a PowerPointExtractor, from an Input Stream- Parameters:
iStream
- The input stream containing the PowerPoint document- Throws:
IOException
-
PowerPointExtractor
Deprecated.Creates a PowerPointExtractor, from an open POIFSFileSystem- Parameters:
fs
- the POIFSFileSystem containing the PowerPoint document- Throws:
IOException
-
PowerPointExtractor
Deprecated.Creates a PowerPointExtractor, from a specific place inside an open NPOIFSFileSystem- Parameters:
dir
- the POIFS Directory containing the PowerPoint document- Throws:
IOException
-
PowerPointExtractor
Deprecated.Creates a PowerPointExtractor, from a HSLFSlideShow- Parameters:
ss
- the HSLFSlideShow to extract text from
-
-
Method Details
-
main
Deprecated.Basic extractor. Returns all the text, and optionally all the notes- Throws:
IOException
-
setSlidesByDefault
public void setSlidesByDefault(boolean slidesByDefault) Deprecated.Should a call to getText() return slide text? Default is yes -
setNotesByDefault
public void setNotesByDefault(boolean notesByDefault) Deprecated.Should a call to getText() return notes text? Default is no -
setCommentsByDefault
public void setCommentsByDefault(boolean commentsByDefault) Deprecated.Should a call to getText() return comments text? Default is no -
setMasterByDefault
public void setMasterByDefault(boolean masterByDefault) Deprecated.Should a call to getText() return text from master? Default is no -
getText
Deprecated.Fetches all the slide text from the slideshow, but not the notes, unless you've called setSlidesByDefault() and setNotesByDefault() to change this- Specified by:
getText
in classPOITextExtractor
- Returns:
- All the text from the document
-
getText
Deprecated.Fetches text from the slideshow, be it slide text or note text. Because the final block of text in a TextRun normally have their last \n stripped, we add it back- Parameters:
getSlideText
- fetch slide textgetNoteText
- fetch note text
-
getText
public String getText(boolean getSlideText, boolean getNoteText, boolean getCommentText, boolean getMasterText) Deprecated. -
getNotes
Deprecated.Fetches all the notes text from the slideshow, but not the slide text -
getOLEShapes
Deprecated.
-
SlideShowExtractor
instead