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.
74 lines
3.0 KiB
74 lines
3.0 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.Core
|
|
{
|
|
using System;
|
|
/// <summary>
|
|
/// Common Parent for Text Extractors
|
|
/// of POI Documents.
|
|
/// You will typically find the implementation of
|
|
/// a given format's text extractor under
|
|
/// org.apache.poi.[format].extractor .
|
|
/// </summary>
|
|
/// @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
|
|
public abstract class POITextExtractor
|
|
{
|
|
/** The POIDocument that's open */
|
|
protected POIDocument document;
|
|
|
|
/// <summary>
|
|
/// Creates a new text extractor for the given document
|
|
/// </summary>
|
|
/// <param name="document">The document.</param>
|
|
public POITextExtractor(POIDocument document)
|
|
{
|
|
this.document = 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">The other extractor.</param>
|
|
protected POITextExtractor(POITextExtractor otherExtractor)
|
|
{
|
|
this.document = otherExtractor.document;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Retrieves all the text from the document.
|
|
/// How cells, paragraphs etc are separated in the text
|
|
/// is implementation specific - see the javadocs for
|
|
/// a specific project for details.
|
|
/// </summary>
|
|
/// <value>All the text from the document.</value>
|
|
public abstract String Text{get;}
|
|
|
|
/// <summary>
|
|
/// Returns another text extractor, which is able to
|
|
/// output the textual content of the document
|
|
/// metadata / properties, such as author and title.
|
|
/// </summary>
|
|
/// <value>The metadata text extractor.</value>
|
|
public abstract POITextExtractor MetadataTextExtractor{get;}
|
|
|
|
public virtual void Close() { }
|
|
}
|
|
}
|