Package org.apache.poi.hdgf.extractor
Class VisioTextExtractor
- java.lang.Object
-
- org.apache.poi.hdgf.extractor.VisioTextExtractor
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,POIOLE2TextExtractor
,POITextExtractor
public final class VisioTextExtractor extends java.lang.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(java.io.InputStream inp)
VisioTextExtractor(HDGFDiagram hdgf)
VisioTextExtractor(DirectoryNode dir)
VisioTextExtractor(POIFSFileSystem fs)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String[]
getAllText()
Locates all the text entries in the file, and returns their contents.HDGFDiagram
getDocument()
Return the underlying POIDocumentHDGFDiagram
getFilesystem()
java.lang.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 Detail
-
VisioTextExtractor
public VisioTextExtractor(HDGFDiagram hdgf)
-
VisioTextExtractor
public VisioTextExtractor(POIFSFileSystem fs) throws java.io.IOException
- Throws:
java.io.IOException
-
VisioTextExtractor
public VisioTextExtractor(DirectoryNode dir) throws java.io.IOException
- Throws:
java.io.IOException
-
VisioTextExtractor
public VisioTextExtractor(java.io.InputStream inp) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
getAllText
public java.lang.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 java.lang.String getText()
Returns the textual contents of the file. Each textual object's text will be separated by a newline- Specified by:
getText
in interfacePOITextExtractor
- 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 interfacePOIOLE2TextExtractor
- Specified by:
getDocument
in interfacePOITextExtractor
- Returns:
- the underlying POIDocument
-
setCloseFilesystem
public void setCloseFilesystem(boolean doCloseFilesystem)
- Specified by:
setCloseFilesystem
in interfacePOITextExtractor
- Parameters:
doCloseFilesystem
-true
(default), if underlying resources/filesystem should be closed onPOITextExtractor.close()
-
isCloseFilesystem
public boolean isCloseFilesystem()
- Specified by:
isCloseFilesystem
in interfacePOITextExtractor
- Returns:
true
, if resources/filesystem should be closed onPOITextExtractor.close()
-
getFilesystem
public HDGFDiagram getFilesystem()
- Specified by:
getFilesystem
in interfacePOITextExtractor
- Returns:
- The underlying resources/filesystem
-
-