Package org.apache.poi.hdgf.extractor

Class VisioTextExtractor

java.lang.Object

org.apache.poi.hdgf.extractor.VisioTextExtractor

All Implemented Interfaces:

Closeable, AutoCloseable, POIOLE2TextExtractor, POITextExtractor

public final class VisioTextExtractor
extends Object
implements POIOLE2TextExtractor

Class to find all the text in a Visio file, and return it. Can operate on the command line (outputs to stdout), or can return the text for you (example: for use with Lucene).

Constructor Summary

Constructors

Constructor	Description
VisioTextExtractor(InputStream inp)
VisioTextExtractor(HDGFDiagram hdgf)
VisioTextExtractor(DirectoryNode dir)
VisioTextExtractor(POIFSFileSystem fs)

Method Summary

Modifier and Type	Method	Description
String[]	getAllText()	Locates all the text entries in the file, and returns their contents.
HDGFDiagram	getDocument()	Return the underlying POIDocument
HDGFDiagram	getFilesystem()
String	getText()	Returns the textual contents of the file.
boolean	isCloseFilesystem()
void	setCloseFilesystem(boolean doCloseFilesystem)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getDocSummaryInformation, getMetadataTextExtractor, getRoot, getSummaryInformation

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

close

Constructor Details

VisioTextExtractor

public VisioTextExtractor(HDGFDiagram hdgf)

VisioTextExtractor

public VisioTextExtractor(POIFSFileSystem fs)
                   throws IOException

Throws:

IOException

VisioTextExtractor

public VisioTextExtractor(DirectoryNode dir)
                   throws IOException

Throws:

IOException

VisioTextExtractor

public VisioTextExtractor(InputStream inp)
                   throws IOException

Throws:

IOException

Method Details

getAllText

public String[] getAllText()

Locates all the text entries in the file, and returns their contents.

Returns:

An array of each Text item in the document

getText

public String getText()

Returns the textual contents of the file. Each textual object's text will be separated by a newline

Specified by:

getText in interface POITextExtractor

Returns:

All text contained in this document, separated by \n

getDocument

public HDGFDiagram getDocument()

Description copied from interface: POIOLE2TextExtractor

Return the underlying POIDocument

Specified by:

getDocument in interface POIOLE2TextExtractor

Specified by:

getDocument in interface POITextExtractor

Returns:

the underlying POIDocument

setCloseFilesystem

public void setCloseFilesystem(boolean doCloseFilesystem)

Specified by:

setCloseFilesystem in interface POITextExtractor

Parameters:

doCloseFilesystem - true (default), if underlying resources/filesystem should be closed on POITextExtractor.close()

isCloseFilesystem

public boolean isCloseFilesystem()

Specified by:

isCloseFilesystem in interface POITextExtractor

Returns:

true, if resources/filesystem should be closed on POITextExtractor.close()

getFilesystem

public HDGFDiagram getFilesystem()

Specified by:

getFilesystem in interface POITextExtractor

Returns:

The underlying resources/filesystem