src/java/org/apache/poi/POIOLE2TextExtractor.java

   1 /* ====================================================================
   2    Licensed to the Apache Software Foundation (ASF) under one or more
   3    contributor license agreements.  See the NOTICE file distributed with
   4    this work for additional information regarding copyright ownership.
   5    The ASF licenses this file to You under the Apache License, Version 2.0
   6    (the "License"); you may not use this file except in compliance with
   7    the License.  You may obtain a copy of the License at
   8
   9        http://www.apache.org/licenses/LICENSE-2.0
  10
  11    Unless required by applicable law or agreed to in writing, software
  12    distributed under the License is distributed on an "AS IS" BASIS,
  13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14    See the License for the specific language governing permissions and
  15    limitations under the License.
  16 ==================================================================== */
  17 package org.apache.poi;
  18
  19 import org.apache.poi.hpsf.DocumentSummaryInformation;
  20 import org.apache.poi.hpsf.SummaryInformation;
  21
  22 /**
  23  * Common Parent for OLE2 based Text Extractors
  24  *  of POI Documents, such as .doc, .xls
  25  * You will typically find the implementation of
  26  *  a given format's text extractor under
  27  *  org.apache.poi.[format].extractor .
  28  * @see org.apache.poi.hssf.extractor.ExcelExtractor
  29  * @see org.apache.poi.hslf.extractor.PowerPointExtractor
  30  * @see org.apache.poi.hdgf.extractor.VisioTextExtractor
  31  * @see org.apache.poi.hwpf.extractor.WordExtractor
  32  */
  33 public abstract class POIOLE2TextExtractor extends POITextExtractor {
  34         /**
  35          * Creates a new text extractor for the given document
  36          */
  37         public POIOLE2TextExtractor(POIDocument document) {
  38                 super(document);
  39         }
  40
  41         /**
  42          * Returns the document information metadata for the document
  43          */
  44         public DocumentSummaryInformation getDocSummaryInformation() {
  45                 return document.getDocumentSummaryInformation();
  46         }
  47         /**
  48          * Returns the summary information metadata for the document
  49          */
  50         public SummaryInformation getSummaryInformation() {
  51                 return document.getSummaryInformation();
  52         }
  53 }