2005-05-28 15:28:22 -04:00
<?xml version="1.0" encoding="UTF-8"?>
<!-- Copyright (C) 2004 The Apache Software Foundation. All rights reserved. -->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "../dtd/document-v11.dtd">
<document >
<header >
<title > POI-HSLF - A Quick Guide</title>
<subtitle > Overview</subtitle>
<authors >
<person name= "Nick Burch" email= "nick at torchbox dot com" />
</authors>
</header>
<body >
<section > <title > Basic Text Extraction</title>
<p > For basic text extraction, make use of
<code > org.apache.poi.extractor.PowerPointExtractor</code> . It accepts a file or an input
2005-06-09 09:12:59 -04:00
stream. The <code > getText()</code> method can be used to get the text from the slides, and the <code > getNotes()</code> method can be used to get the text
from the notes. Finally, <code > getText(true,true)</code> will get the text
from both.
2005-05-28 15:28:22 -04:00
</p>
</section>
<section > <title > Specific Text Extraction</title>
<p > To get specific bits of text, first create a <code > org.apache.poi.usermodel.SlideShow</code>
(from a <code > org.apache.poi.HSLFSlideShow</code> , which accepts a file or an input
stream). Use <code > getSlides()</code> and <code > getNotes()</code> to get the slides and notes.
These can be queried to get their page ID (though they should be returned
in the right order). You can also call <code > getTextRuns()</code> on these, to get their
blocks of text. From the <code > TextRun</code> , you can extract the text, and check
what type of text it is (eg Body, Title)
</p>
</section>
2005-06-09 09:12:59 -04:00
<section > <title > Poor Quality Text Extraction</title>
<p > If speed is the most important thing for you, you don't care
about getting duplicate blocks of text, you don't care about
getting text from master sheets, and you don't care about getting
old text, then
<code > org.apache.poi.extractor.QuickButCruddyTextExtractor</code>
might be of use.</p>
<p > QuickButCruddyTextExtractor doesn't use the normal record
parsing code, instead it uses a tree structure blind search
method to get all text holding records. You will get all the text,
including lots of text you normally wouldn't ever want. However,
you will get it back very very fast!</p>
<p > There are two ways of getting the text back.
<code > getTextAsString()</code> will return a single string with all
the text in it. <code > getTextAsVector()</code> will return a
vector of strings, one for each text record found in the file.
</p>
</section>
2005-05-28 15:28:22 -04:00
<section > <title > Changing Text</title>
2005-06-09 09:12:59 -04:00
<p > It is possible to change the text via
<code > TextRun.setText(String)</code> . However, if the length of
the text is changed, things will break because PowerPoint has
internal file references in byte offsets. We currently update all
of these byte references that we know about when writing out, but
there are a few more still to be found.
2005-05-28 15:28:22 -04:00
</p>
</section>
<section > <title > Guide to key classes</title>
<ul >
<li > <code > org.apache.poi.hslf.HSLFSlideShow</code>
2005-06-09 09:12:59 -04:00
Handles reading in and writing out files. Calls
<code > org.apache.poi.hslf.record.record</code> to build a tree
of all the records in the file, which it allows access to.
</li>
<li > <code > org.apache.poi.hslf.record.record</code>
Base class of all records. Also provides the main record generation
code, which will build up a tree of records for a file.
2005-05-28 15:28:22 -04:00
</li>
<li > <code > org.apache.poi.hslf.usermode.SlideShow</code>
Builds up model entries from the records, and presents a user facing
view of the file
</li>
<li > <code > org.apache.poi.hslf.extractor.PowerPointExtractor</code>
Uses the model code to allow extraction of text from files
</li>
</ul>
</section>
</body>
2005-06-09 09:12:59 -04:00
</document>
