You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
108 lines
3.9 KiB
108 lines
3.9 KiB
/* ====================================================================
|
|
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.
|
|
==================================================================== */
|
|
namespace NPOI
|
|
{
|
|
using NPOI.HPSF;
|
|
using NPOI.HPSF.Extractor;
|
|
using NPOI.POIFS.FileSystem;
|
|
|
|
/// <summary>
|
|
/// Common Parent for OLE2 based Text Extractors
|
|
/// of POI Documents, such as .doc, .xls
|
|
/// You will typically find the implementation of
|
|
/// a given format's text extractor under NPOI.Format.Extractor
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// @see org.apache.poi.hssf.extractor.ExcelExtractor
|
|
/// @see org.apache.poi.hslf.extractor.PowerPointExtractor
|
|
/// @see org.apache.poi.hdgf.extractor.VisioTextExtractor
|
|
/// @see org.apache.poi.hwpf.extractor.WordExtractor
|
|
/// </remarks>
|
|
public abstract class POIOLE2TextExtractor : POITextExtractor
|
|
{
|
|
/** The POIDocument that's open */
|
|
protected POIDocument document;
|
|
|
|
/// <summary>
|
|
/// Creates a new text extractor for the given document
|
|
/// </summary>
|
|
/// <param name="document"></param>
|
|
public POIOLE2TextExtractor(POIDocument document)
|
|
{
|
|
this.document = document;
|
|
// Ensure any underlying resources, such as open files,
|
|
// will get cleaned up if the user calls #close()
|
|
SetFilesystem(document);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a new text extractor, using the same document as another
|
|
/// text extractor. Normally only used by properties extractors.
|
|
/// </summary>
|
|
/// <param name="otherExtractor"></param>
|
|
protected POIOLE2TextExtractor(POIOLE2TextExtractor otherExtractor)
|
|
{
|
|
this.document = otherExtractor.document;
|
|
}
|
|
/// <summary>
|
|
/// Returns the document information metadata for the document
|
|
/// </summary>
|
|
/// <value>The doc summary information.</value>
|
|
public virtual DocumentSummaryInformation DocSummaryInformation
|
|
{
|
|
get
|
|
{
|
|
return document.DocumentSummaryInformation;
|
|
}
|
|
}
|
|
/// <summary>
|
|
/// Returns the summary information metadata for the document
|
|
/// </summary>
|
|
/// <value>The summary information.</value>
|
|
public virtual SummaryInformation SummaryInformation
|
|
{
|
|
get
|
|
{
|
|
return document.SummaryInformation;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns an HPSF powered text extractor for the
|
|
/// document properties metadata, such as title and author.
|
|
/// </summary>
|
|
/// <value></value>
|
|
public override POITextExtractor MetadataTextExtractor
|
|
{
|
|
get
|
|
{
|
|
return new HPSFPropertiesExtractor(this);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the underlying DirectoryEntry of this document.
|
|
*
|
|
* @return the DirectoryEntry that is associated with the POIDocument of this extractor.
|
|
*/
|
|
public DirectoryEntry Root
|
|
{
|
|
get { return document.Directory; }
|
|
|
|
}
|
|
}
|
|
}
|