|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.pdfbox.util.PDFStreamEngine
org.pdfbox.util.PDFTextStripper
This class will take a pdf document and strip out all of the text and ignore the formatting and such.
| Constructor Summary | |
PDFTextStripper()
Instantiate a new PDFTextStripper object. |
|
| Method Summary | |
PDOutlineItem |
getEndBookmark()
Get the bookmark where text extraction should end, inclusive. |
int |
getEndPage()
This will get the last page that will be extracted. |
String |
getLineSeparator()
This will get the line separator. |
String |
getPageSeparator()
This will get the page separator. |
PDOutlineItem |
getStartBookmark()
Get the bookmark where text extraction should start, inclusive. |
int |
getStartPage()
This is the page that the text extraction will start on. |
String |
getText(COSDocument doc)
Deprecated. |
String |
getText(PDDocument doc)
This will return the text of a document. |
String |
getText(PDDocument doc,
String encoding)
This will return the text of a document. |
String |
getWordSeparator()
This will get the word separator. |
void |
setEndBookmark(PDOutlineItem aEndBookmark)
Set the bookmark where the text extraction should stop. |
void |
setEndPage(int endPageValue)
This will set the last page to be extracted by this class. |
void |
setFirstPageRotation(int Rotation)
the rotation of the first page 0|90|180|270 |
void |
setGetFirstPageRotationFromThis(boolean newFirstPageRotationFromThis)
tells if rotation of first handled page should be concerned |
void |
setLineSeparator(String separator)
Set the desired line separator for output text. |
void |
setPageSeparator(String separator)
Set the desired page separator for output text. |
void |
setShouldSeparateByBeads(boolean aShouldSeparateByBeads)
Set if the text stripper should group the text output by a list of beads. |
void |
setSortByPosition(boolean newSortByPosition)
The order of the text tokens in a PDF file may not be in the same as they appear visually on the screen. |
void |
setStartBookmark(PDOutlineItem aStartBookmark)
Set the bookmark where text extraction should start, inclusive. |
void |
setStartPage(int startPageValue)
This will set the first page to be extracted by this class. |
void |
setSuppressDuplicateOverlappingText(boolean suppressDuplicateOverlappingTextValue)
By default the text stripper will attempt to remove text that overlapps each other. |
void |
setWordSeparator(String separator)
Set the desired word separator for output text. |
boolean |
shouldSeparateByBeads()
This will tell if the text stripper should separate by beads. |
boolean |
shouldSortByPosition()
This will tell if the text stripper should sort the text tokens before writing to the stream. |
boolean |
shouldSuppressDuplicateOverlappingText()
|
void |
writeText(COSDocument doc,
Writer outputStream)
Deprecated. |
void |
writeText(PDDocument doc,
Writer outputStream)
This will take a PDDocument and write the text of that document to the print writer. |
| Methods inherited from class org.pdfbox.util.PDFStreamEngine |
getColorSpaces, getCurrentPage, getFonts, getGraphicsStack, getGraphicsState, getGraphicsStates, getResources, getTextLineMatrix, getTextMatrix, getXObjects, processOperator, processStream, processSubStream, setColorSpaces, setFonts, setGraphicsStack, setGraphicsState, setGraphicsStates, setTextLineMatrix, setTextMatrix, showString |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public PDFTextStripper()
throws IOException
IOException - If there is an error loading the properties.| Method Detail |
public String getText(PDDocument doc)
throws IOException
doc - The document to get the text from.
IOException - if the doc state is invalid or it is encrypted.
public String getText(PDDocument doc,
String encoding)
throws IOException
doc - The document to get the text from.encoding - Use this encoding for undefined extracted chars
IOException - if the doc state is invalid or it is encrypted.
public String getText(COSDocument doc)
throws IOException
doc - The document to extract the text from.
IOException - If there is an error extracting the text.getText( PDDocument )
public void writeText(COSDocument doc,
Writer outputStream)
throws IOException
doc - The document to extract the text.outputStream - The stream to write the text to.
IOException - If there is an error extracting the text.writeText( PDDocument, Writer )
public void writeText(PDDocument doc,
Writer outputStream)
throws IOException
doc - The document to get the data from.outputStream - The location to put the text.
IOException - If the doc is in an invalid state.public int getStartPage()
public void setStartPage(int startPageValue)
startPageValue - New value of property startPage.public int getEndPage()
public void setEndPage(int endPageValue)
endPageValue - New value of property endPage.public void setLineSeparator(String separator)
separator - The desired line separator string.public String getLineSeparator()
public void setPageSeparator(String separator)
separator - The desired page separator string.public String getWordSeparator()
public void setWordSeparator(String separator)
separator - The desired page separator string.public String getPageSeparator()
public boolean shouldSuppressDuplicateOverlappingText()
public void setSuppressDuplicateOverlappingText(boolean suppressDuplicateOverlappingTextValue)
suppressDuplicateOverlappingTextValue - The suppressDuplicateOverlappingText to set.public boolean shouldSeparateByBeads()
public void setShouldSeparateByBeads(boolean aShouldSeparateByBeads)
aShouldSeparateByBeads - The new grouping of beads.public PDOutlineItem getEndBookmark()
public void setEndBookmark(PDOutlineItem aEndBookmark)
aEndBookmark - The ending bookmark.public PDOutlineItem getStartBookmark()
public void setStartBookmark(PDOutlineItem aStartBookmark)
aStartBookmark - The starting bookmark.public boolean shouldSortByPosition()
public void setSortByPosition(boolean newSortByPosition)
newSortByPosition - Tell PDFBox to sort the text positions.public void setFirstPageRotation(int Rotation)
Rotation - public void setGetFirstPageRotationFromThis(boolean newFirstPageRotationFromThis)
newFirstPageRotationFromThis - boolean
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||