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.in POI 4.0.0, useSlideShowExtractor
insteadThis class can be used to extract text from a PowerPoint file. Can optionally also get the notes from one.
-
-
Constructor Summary
Constructors Constructor Description PowerPointExtractor(InputStream iStream)
Deprecated.Creates a PowerPointExtractor, from an Input StreamPowerPointExtractor(String fileName)
Deprecated.Creates a PowerPointExtractor, from a filePowerPointExtractor(HSLFSlideShow slideShow)
Deprecated.PowerPointExtractor(HSLFSlideShowImpl ss)
Deprecated.Creates a PowerPointExtractor, from a HSLFSlideShowPowerPointExtractor(DirectoryNode dir)
Deprecated.Creates a PowerPointExtractor, from a specific place inside an open NPOIFSFileSystemPowerPointExtractor(POIFSFileSystem fs)
Deprecated.Creates a PowerPointExtractor, from an open POIFSFileSystem
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
getNotes()
Deprecated.Fetches all the notes text from the slideshow, but not the slide textList<HSLFObjectShape>
getOLEShapes()
Deprecated.String
getText()
Deprecated.Fetches all the slide text from the slideshow, but not the notes, unless you've called setSlidesByDefault() and setNotesByDefault() to change thisString
getText(boolean getSlideText, boolean getNoteText)
Deprecated.Fetches text from the slideshow, be it slide text or note text.String
getText(boolean getSlideText, boolean getNoteText, boolean getCommentText, boolean getMasterText)
Deprecated.static void
main(String[] args)
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 yes-
Methods 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 Detail
-
PowerPointExtractor
public PowerPointExtractor(HSLFSlideShow slideShow)
Deprecated.
-
PowerPointExtractor
public PowerPointExtractor(String fileName) throws IOException
Deprecated.Creates a PowerPointExtractor, from a file- Parameters:
fileName
- The name of the file to extract from- Throws:
IOException
-
PowerPointExtractor
public PowerPointExtractor(InputStream iStream) throws IOException
Deprecated.Creates a PowerPointExtractor, from an Input Stream- Parameters:
iStream
- The input stream containing the PowerPoint document- Throws:
IOException
-
PowerPointExtractor
public PowerPointExtractor(POIFSFileSystem fs) throws IOException
Deprecated.Creates a PowerPointExtractor, from an open POIFSFileSystem- Parameters:
fs
- the POIFSFileSystem containing the PowerPoint document- Throws:
IOException
-
PowerPointExtractor
public PowerPointExtractor(DirectoryNode dir) throws IOException
Deprecated.Creates a PowerPointExtractor, from a specific place inside an open NPOIFSFileSystem- Parameters:
dir
- the POIFS Directory containing the PowerPoint document- Throws:
IOException
-
PowerPointExtractor
public PowerPointExtractor(HSLFSlideShowImpl ss)
Deprecated.Creates a PowerPointExtractor, from a HSLFSlideShow- Parameters:
ss
- the HSLFSlideShow to extract text from
-
-
Method Detail
-
main
public static void main(String[] args) throws IOException
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
public String 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
public String getText(boolean getSlideText, boolean getNoteText)
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
public String getNotes()
Deprecated.Fetches all the notes text from the slideshow, but not the slide text
-
getOLEShapes
public List<HSLFObjectShape> getOLEShapes()
Deprecated.
-
-