org.apache.poi.hpsf.extractor

Class HPSFPropertiesExtractor

java.lang.Object

org.apache.poi.hpsf.extractor.HPSFPropertiesExtractor

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, POIOLE2TextExtractor, POITextExtractor

public class HPSFPropertiesExtractor
extends java.lang.Object
implements POIOLE2TextExtractor

Extracts all of the HPSF properties, both build in and custom, returning them in textual form. (提取所有内置和自定义的 HPSF 属性，并以文本形式返回它们。)

Constructor Summary

Constructors

Constructor and Description
HPSFPropertiesExtractor(POIDocument document)
HPSFPropertiesExtractor(POIFSFileSystem fs)
HPSFPropertiesExtractor(POIOLE2TextExtractor mainExtractor)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
POIDocument	getDocument() Return the underlying POIDocument (返回底层 POIDocument)
java.lang.String	getDocumentSummaryInformationText()
POIDocument	getFilesystem()
POITextExtractor	getMetadataTextExtractor() Prevent recursion! (防止递归！)
java.lang.String	getSummaryInformationText()
java.lang.String	getText() Retrieves all the text from the document. (从文档中检索所有文本。)
int	hashCode()
boolean	isCloseFilesystem()
void	setCloseFilesystem(boolean doCloseFilesystem)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.poi.extractor.POIOLE2TextExtractor

getDocSummaryInformation, getRoot, getSummaryInformation

Methods inherited from interface org.apache.poi.extractor.POITextExtractor

close

Constructor Detail

HPSFPropertiesExtractor

public HPSFPropertiesExtractor(POIOLE2TextExtractor mainExtractor)

HPSFPropertiesExtractor

public HPSFPropertiesExtractor(POIDocument document)

HPSFPropertiesExtractor

public HPSFPropertiesExtractor(POIFSFileSystem fs)

Method Detail

getDocumentSummaryInformationText

public java.lang.String getDocumentSummaryInformationText()

getSummaryInformationText

public java.lang.String getSummaryInformationText()

getText

public java.lang.String getText()

Description copied from interface: POITextExtractor

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. (从文档中检索所有文本。单元格、段落等在文本中的分隔方式是特定于实现的 - 有关详细信息，请参阅特定项目的 javadocs。)

Specified by:

getText in interface POITextExtractor (接口 POITextExtractor 中的 getText)

Returns:

the text of all the properties defined in the document. (文档中定义的所有属性的文本。)

getMetadataTextExtractor

public POITextExtractor getMetadataTextExtractor()

Prevent recursion! (防止递归！)

Specified by:

getMetadataTextExtractor in interface POIOLE2TextExtractor (POIOLE2TextExtractor 接口中的getMetadataTextExtractor)

Specified by:

getMetadataTextExtractor in interface POITextExtractor (接口 POITextExtractor 中的 getMetadataTextExtractor)

Returns:

an instance of POIExtractor that can extract meta-data. (可以提取元数据的 POIExtractor 实例。)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getDocument

public POIDocument getDocument()

Description copied from interface: POIOLE2TextExtractor

Return the underlying POIDocument (返回底层 POIDocument)

Specified by:

getDocument in interface POIOLE2TextExtractor (POIOLE2TextExtractor 接口中的getDocument)

Specified by:

getDocument in interface POITextExtractor (接口 POITextExtractor 中的 getDocument)

Returns:

the underlying POIDocument (基础 POIDocument)

setCloseFilesystem

public void setCloseFilesystem(boolean doCloseFilesystem)

Specified by:

setCloseFilesystem in interface POITextExtractor (接口 POITextExtractor 中的 setCloseFilesystem)

Parameters:

doCloseFilesystem - true (default), if underlying resources/filesystem should be closed on POITextExtractor.close() (doCloseFilesystem - true（默认），如果底层资源/文件系统应该在 POITextExtractor.close() 上关闭)

isCloseFilesystem

public boolean isCloseFilesystem()

Specified by:

isCloseFilesystem in interface POITextExtractor (接口 POITextExtractor 中的 isCloseFilesystem)

Returns:

true, if resources/filesystem should be closed on POITextExtractor.close() (true，如果资源/文件系统应该在 POITextExtractor.close() 上关闭)

getFilesystem

public POIDocument getFilesystem()

Specified by:

getFilesystem in interface POITextExtractor (接口 POITextExtractor 中的 getFilesystem)

Returns:

The underlying resources/filesystem (底层资源/文件系统)