org.apache.poi.sl.extractor.SlideShowExtractor Maven / Gradle / Ivy
Show all versions of poi Show documentation
/* ====================================================================
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.sl.extractor;
import java.util.ArrayList;
import java.util.List;
import org.apache.poi.extractor.POITextExtractor;
import org.apache.poi.sl.usermodel.Comment;
import org.apache.poi.sl.usermodel.MasterSheet;
import org.apache.poi.sl.usermodel.Notes;
import org.apache.poi.sl.usermodel.ObjectShape;
import org.apache.poi.sl.usermodel.Placeholder;
import org.apache.poi.sl.usermodel.PlaceholderDetails;
import org.apache.poi.sl.usermodel.Shape;
import org.apache.poi.sl.usermodel.ShapeContainer;
import org.apache.poi.sl.usermodel.Sheet;
import org.apache.poi.sl.usermodel.Slide;
import org.apache.poi.sl.usermodel.SlideShow;
import org.apache.poi.sl.usermodel.TableCell;
import org.apache.poi.sl.usermodel.TableShape;
import org.apache.poi.sl.usermodel.TextParagraph;
import org.apache.poi.sl.usermodel.TextRun;
import org.apache.poi.sl.usermodel.TextShape;
import org.apache.poi.util.LocaleUtil;
import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger;
/**
* Common SlideShow extractor
*
* @since POI 4.0.0
*/
public class SlideShowExtractor<
S extends Shape,
P extends TextParagraph
> extends POITextExtractor {
private static final POILogger LOG = POILogFactory.getLogger(SlideShowExtractor.class);
private SlideShow slideshow;
private boolean slidesByDefault = true;
private boolean notesByDefault;
private boolean commentsByDefault;
private boolean masterByDefault;
public SlideShowExtractor(final SlideShow slideshow) {
setFilesystem(slideshow);
this.slideshow = slideshow;
}
/**
* Returns opened document
*
* @return the opened document
*/
@Override
public final Object getDocument() {
return slideshow.getPersistDocument();
}
/**
* Should a call to getText() return slide text? Default is yes
*/
public void setSlidesByDefault(final boolean slidesByDefault) {
this.slidesByDefault = slidesByDefault;
}
/**
* Should a call to getText() return notes text? Default is no
*/
public void setNotesByDefault(final boolean notesByDefault) {
this.notesByDefault = notesByDefault;
}
/**
* Should a call to getText() return comments text? Default is no
*/
public void setCommentsByDefault(final boolean commentsByDefault) {
this.commentsByDefault = commentsByDefault;
}
/**
* Should a call to getText() return text from master? Default is no
*/
public void setMasterByDefault(final boolean masterByDefault) {
this.masterByDefault = masterByDefault;
}
@Override
public POITextExtractor getMetadataTextExtractor() {
return slideshow.getMetadataTextExtractor();
}
/**
* Fetches all the slide text from the slideshow, but not the notes, unless
* you've called setSlidesByDefault() and setNotesByDefault() to change this
*/
@Override
public String getText() {
final StringBuilder sb = new StringBuilder();
for (final Slide slide : slideshow.getSlides()) {
sb.append(getText(slide));
}
return sb.toString();
}
public String getText(final Slide slide) {
final StringBuilder sb = new StringBuilder();
if (slidesByDefault) {
printShapeText(slide, sb);
}
if (masterByDefault) {
final MasterSheet ms = slide.getMasterSheet();
printSlideMaster(ms, sb);
// only print slide layout, if it's a different instance
final MasterSheet sl = slide.getSlideLayout();
if (sl != ms) {
printSlideMaster(sl, sb);
}
}
if (commentsByDefault) {
printComments(slide, sb);
}
if (notesByDefault) {
printNotes(slide, sb);
}
return sb.toString();
}
private void printSlideMaster(final MasterSheet master, final StringBuilder sb) {
if (master == null) {
return;
}
for (final Shape shape : master) {
if (shape instanceof TextShape) {
final TextShape ts = (TextShape)shape;
final String text = ts.getText();
if (text == null || text.isEmpty() || "*".equals(text)) {
continue;
}
if (ts.isPlaceholder()) {
// don't bother about boiler plate text on master sheets
LOG.log(POILogger.INFO, "Ignoring boiler plate (placeholder) text on slide master:", text);
continue;
}
sb.append(text);
if (!text.endsWith("\n")) {
sb.append("\n");
}
}
}
}
private String printHeaderReturnFooter(final Sheet sheet, final StringBuilder sb) {
final Sheet m = (sheet instanceof Slide) ? sheet.getMasterSheet() : sheet;
final StringBuilder footer = new StringBuilder("\n");
addSheetPlaceholderDatails(sheet, Placeholder.HEADER, sb);
addSheetPlaceholderDatails(sheet, Placeholder.FOOTER, footer);
if (masterByDefault) {
// write header texts and determine footer text
for (Shape s : m) {
if (!(s instanceof TextShape)) {
continue;
}
final TextShape ts = (TextShape) s;
final PlaceholderDetails pd = ts.getPlaceholderDetails();
if (pd == null || !pd.isVisible() || pd.getPlaceholder() == null) {
continue;
}
switch (pd.getPlaceholder()) {
case HEADER:
sb.append(ts.getText());
sb.append('\n');
break;
case SLIDE_NUMBER:
if (sheet instanceof Slide) {
footer.append(ts.getText().replace("‹#›", Integer.toString(((Slide) sheet).getSlideNumber() + 1)));
footer.append('\n');
}
break;
case FOOTER:
footer.append(ts.getText());
footer.append('\n');
break;
case DATETIME:
// currently not supported
default:
break;
}
}
}
return (footer.length() > 1) ? footer.toString() : "";
}
private void addSheetPlaceholderDatails(final Sheet sheet, final Placeholder placeholder, final StringBuilder sb) {
final PlaceholderDetails headerPD = sheet.getPlaceholderDetails(placeholder);
if (headerPD == null) {
return;
}
final String headerStr = headerPD.getText();
if (headerStr == null) {
return;
}
sb.append(headerStr);
}
private void printShapeText(final Sheet sheet, final StringBuilder sb) {
final String footer = printHeaderReturnFooter(sheet, sb);
printShapeText((ShapeContainer)sheet, sb);
sb.append(footer);
}
@SuppressWarnings("unchecked")
private void printShapeText(final ShapeContainer container, final StringBuilder sb) {
for (Shape shape : container) {
if (shape instanceof TextShape) {
printShapeText((TextShape)shape, sb);
} else if (shape instanceof TableShape) {
printShapeText((TableShape)shape, sb);
} else if (shape instanceof ShapeContainer) {
printShapeText((ShapeContainer)shape, sb);
}
}
}
private void printShapeText(final TextShape shape, final StringBuilder sb) {
final List paraList = shape.getTextParagraphs();
if (paraList.isEmpty()) {
sb.append('\n');
return;
}
for (final P para : paraList) {
for (final TextRun tr : para) {
final String str = tr.getRawText().replace("\r", "");
final String newStr;
switch (tr.getTextCap()) {
case ALL:
newStr = str.toUpperCase(LocaleUtil.getUserLocale());
break;
case SMALL:
newStr = str.toLowerCase(LocaleUtil.getUserLocale());
break;
default:
case NONE:
newStr = str;
break;
}
sb.append(newStr);
}
sb.append('\n');
}
}
@SuppressWarnings("Duplicates")
private void printShapeText(final TableShape shape, final StringBuilder sb) {
final int nrows = shape.getNumberOfRows();
final int ncols = shape.getNumberOfColumns();
for (int row = 0; row < nrows; row++){
for (int col = 0; col < ncols; col++){
TableCell cell = shape.getCell(row, col);
//defensive null checks; don't know if they're necessary
if (cell != null){
String txt = cell.getText();
txt = (txt == null) ? "" : txt;
sb.append(txt);
if (col < ncols-1){
sb.append('\t');
}
}
}
sb.append('\n');
}
}
private void printComments(final Slide slide, final StringBuilder sb) {
for (final Comment comment : slide.getComments()) {
sb.append(comment.getAuthor());
sb.append(" - ");
sb.append(comment.getText());
sb.append("\n");
}
}
private void printNotes(final Slide slide, final StringBuilder sb) {
final Notes notes = slide.getNotes();
if (notes == null) {
return;
}
final String footer = printHeaderReturnFooter(notes, sb);
printShapeText(notes, sb);
sb.append(footer);
}
public List> getOLEShapes() {
final List> oleShapes = new ArrayList<>();
for (final Slide slide : slideshow.getSlides()) {
addOLEShapes(oleShapes, slide);
}
return oleShapes;
}
@SuppressWarnings("unchecked")
private void addOLEShapes(final List> oleShapes, ShapeContainer container) {
for (Shape shape : container) {
if (shape instanceof ShapeContainer) {
addOLEShapes(oleShapes, (ShapeContainer)shape);
} else if (shape instanceof ObjectShape) {
oleShapes.add((ObjectShape)shape);
}
}
}
}