Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hslf » extractor » [javadoc | source]
org.apache.poi.hslf.extractor
public class: PowerPointExtractor [javadoc | source]
java.lang.Object
   org.apache.poi.POITextExtractor
      org.apache.poi.POIOLE2TextExtractor
         org.apache.poi.hslf.extractor.PowerPointExtractor
This class can be used to extract text from a PowerPoint file. Can optionally also get the notes from one.
Fields inherited from org.apache.poi.POITextExtractor:
document
Constructor:
 public PowerPointExtractor(String fileName) throws IOException 
    Creates a PowerPointExtractor, from a file
    Parameters:
    fileName - The name of the file to extract from
 public PowerPointExtractor(InputStream iStream) throws IOException 
    Creates a PowerPointExtractor, from an Input Stream
    Parameters:
    iStream - The input stream containing the PowerPoint document
 public PowerPointExtractor(POIFSFileSystem fs) throws IOException 
    Creates a PowerPointExtractor, from an open POIFSFileSystem
    Parameters:
    fs - the POIFSFileSystem containing the PowerPoint document
 public PowerPointExtractor(HSLFSlideShow ss) throws IOException 
    Creates a PowerPointExtractor, from a HSLFSlideShow
    Parameters:
    ss - the HSLFSlideShow to extract text from
Method from org.apache.poi.hslf.extractor.PowerPointExtractor Summary:
close,   getNotes,   getText,   getText,   main,   setNotesByDefault,   setSlidesByDefault
Methods from org.apache.poi.POIOLE2TextExtractor:
getDocSummaryInformation,   getSummaryInformation
Methods from org.apache.poi.POITextExtractor:
getText
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hslf.extractor.PowerPointExtractor Detail:
 public  void close() throws IOException 
    Shuts down the underlying streams
 public String getNotes() 
    Fetches all the notes text from the slideshow, but not the slide text
 public String getText() 
    Fetches all the slide text from the slideshow, but not the notes, unless you've called setSlidesByDefault() and setNotesByDefault() to change this
 public String getText(boolean getSlideText,
    boolean getNoteText) 
    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
 public static  void main(String[] args) throws IOException 
    Basic extractor. Returns all the text, and optionally all the notes
 public  void setNotesByDefault(boolean notesByDefault) 
    Should a call to getText() return notes text? Default is no
 public  void setSlidesByDefault(boolean slidesByDefault) 
    Should a call to getText() return slide text? Default is yes