Packages

com.groupdocs.parser.legacy

Interfaces

Classes

Exceptions

java.lang.Object
- com.groupdocs.parser.legacy.TextExtractor
- - com.groupdocs.parser.legacy.PdfTextExtractor

All Implemented Interfaces:: IContainer, IDocumentContentExtractor, IFastTextExtractor, IHighlightExtractor, IPageTextExtractor, IRegexSearchable, ISearchable, AutoCloseable

public final class PdfTextExtractor
extends TextExtractor
implements IPageTextExtractor, IContainer, ISearchable, IHighlightExtractor, IRegexSearchable, IDocumentContentExtractor, IFastTextExtractor

Provides the text extractor for PDF documents.

Extracting a text from PDF:

 // Create a text extractor for PDFs
 PdfTextExtractor extractor = new PdfTextExtractor(stream);
 // Extract a text
 System.out.println(extractor.extractAll());

Extracting by pages:

 // Create a text extractor for PDFs
 PdfTextExtractor extractor = new PdfTextExtractor(stream);
 // Iterate pages
 for (int pageIndex = 0; pageIndex &lt; extractor.getPageCount(); pageIndex++) {
     // Extract a text from the page which index is pageIndex
     System.out.println(extractor.extractPage(pageIndex));
 }

Constructor Summary

Constructors
Constructor and Description
`PdfTextExtractor(InputStream stream)` Initializes a new instance of the `PdfTextExtractor` class.
`PdfTextExtractor(InputStream stream, LoadOptions loadOptions)` Initializes a new instance of the `PdfTextExtractor` class.
`PdfTextExtractor(String fileName)` Initializes a new instance of the `PdfTextExtractor` class.
`PdfTextExtractor(String fileName, LoadOptions loadOptions)` Initializes a new instance of the `PdfTextExtractor` class.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`dispose(boolean disposing)` Releases the unmanaged resources used by the extractor.
`List<String>`	`extractHighlights(HighlightOptions... highlightOptions)` Extracts highlights.
`String`	`extractPage(int pageIndex)` Reads all characters from the page with `pageIndex` and returns the data as a string.
`protected String`	`extractText()` Extracts all characters from the current position to the end of the text extractor and returns them as one string.
`protected String`	`extractTextLine()` Extracts a line of characters from the text extractor and returns the data as a string.
`DocumentContent`	`getDocumentContent()` Gets an access to the document's content.
`List<Container.Entity>`	`getEntities()` Gets a collection of container's entities.
`int`	`getExtractMode()` Gets a value indicating the mode of text extraction.
`Dictionary<String,String>`	`getFormData()` Extracts a PDF Forms data from document.
`int`	`getPageCount()` Gets a total count of the pages.
`TableAreaDetector`	`getTableAreaDetector()` Gets a table detector.
`TableAreaParser`	`getTableAreaParser()` Gets a table parser.
`InputStream`	`openEntityStream(Container.Entity entity)` Opens a stream with the content of the container's entity.
`protected String`	`prepareLine()` Returns a line of the text.
`void`	`reset()` Resets the current document.
`void`	`search(SearchOptions options, ISearchHandler handler, ISearchEngine searchEngine, List<String> keywords)` Searches the keywords.
`void`	`search(SearchOptions options, ISearchHandler handler, List<String> keywords)` Searches the keywords.
`void`	`searchWithRegex(String expression, ISearchHandler handler, RegexSearchOptions searchOptions)` Searches the expression.
`void`	`setExtractMode(int value)` Sets a value indicating the mode of text extraction.

Methods inherited from class com.groupdocs.parser.legacy.TextExtractor
checkDisposed, close, dispose, extractAll, extractLine, getEncoding, getMediaType, getPassword, isDisposed, setEncoding, setMediaType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PdfTextExtractor
```
public PdfTextExtractor(String fileName)
```
    Initializes a new instance of the PdfTextExtractor class.
    
    Parameters:
    fileName - The path to the file.
  - PdfTextExtractor
```
public PdfTextExtractor(String fileName,
                LoadOptions loadOptions)
```
    Initializes a new instance of the PdfTextExtractor class.
    
    Parameters:
    fileName - The path to the file.
    loadOptions - The options of loading the file.
  - PdfTextExtractor
```
public PdfTextExtractor(InputStream stream)
```
    Initializes a new instance of the PdfTextExtractor class.
    
    Parameters:
    stream - The stream of the document.
  - PdfTextExtractor
```
public PdfTextExtractor(InputStream stream,
                LoadOptions loadOptions)
```
    Initializes a new instance of the PdfTextExtractor class.
    
    Parameters:
    stream - The stream of the document.
    loadOptions - The options of loading the file.
- Method Detail
  - getDocumentContent
```
public DocumentContent getDocumentContent()
```
    Gets an access to the document's content.
    
    Specified by:
    
    getDocumentContent in interface IDocumentContentExtractor
    
    Returns:
    An instance of DocumentContent class.
  - getTableAreaDetector
```
public TableAreaDetector getTableAreaDetector()
```
    Gets a table detector.
    
    Returns:
    An instance of TableAreaDetector.
  - getTableAreaParser
```
public TableAreaParser getTableAreaParser()
```
    Gets a table parser.
    
    Returns:
    An instance of TableAreaParser.
  - getExtractMode
```
public int getExtractMode()
```
    Gets a value indicating the mode of text extraction.
    
    Specified by:
    
    getExtractMode in interface IFastTextExtractor
    
    Returns:
    The mode of text extraction. The default is Standard.
  - setExtractMode
```
public void setExtractMode(int value)
```
    Sets a value indicating the mode of text extraction.
    
    Specified by:
    
    setExtractMode in interface IFastTextExtractor
    
    Parameters:
    value - The mode of text extraction. The default is Standard.
  - getPageCount
```
public int getPageCount()
```
    Gets a total count of the pages.
    
    Specified by:
    
    getPageCount in interface IPageTextExtractor
    
    Returns:
    A total count of the pages.
  - getEntities
```
public List<Container.Entity> getEntities()
```
    Gets a collection of container's entities.
    
    Specified by:
    
    getEntities in interface IContainer
    
    Returns:
    A collection of container's entities.
  - getFormData
```
public Dictionary<String,String> getFormData()
```
    Extracts a PDF Forms data from document.
    
    Returns:
    A dictionary with the PDF Forms data.
  - openEntityStream
```
public InputStream openEntityStream(Container.Entity entity)
```
    Opens a stream with the content of the container's entity.
    
    Specified by:
    
    openEntityStream in interface IContainer
    
    Parameters:
    entity - A container's entity.
    
    Returns:
    A stream with the content of the container's entity.
  - search
```
public void search(SearchOptions options,
          ISearchHandler handler,
          List<String> keywords)
```
    Searches the keywords.
    
    Specified by:
    
    search in interface ISearchable
    
    Parameters:
    options - Options for searching.
    handler - An instance of the search handler.
    keywords - A collection of words to search.
  - search
```
public void search(SearchOptions options,
          ISearchHandler handler,
          ISearchEngine searchEngine,
          List<String> keywords)
```
    Searches the keywords.
    
    Specified by:
    
    search in interface ISearchable
    
    Parameters:
    options - Options for searching.
    handler - An instance of the search handler.
    searchEngine - An instance of the search engine.
    keywords - A collection of words to search.
  - searchWithRegex
```
public void searchWithRegex(String expression,
                   ISearchHandler handler,
                   RegexSearchOptions searchOptions)
```
    Searches the expression.
    
    Specified by:
    
    searchWithRegex in interface IRegexSearchable
    
    Parameters:
    expression - A regular expression.
    handler - An instance of the search handler.
    searchOptions - Options for searching.
  - extractHighlights
```
public List<String> extractHighlights(HighlightOptions... highlightOptions)
```
    Extracts highlights.
    
    Specified by:
    
    extractHighlights in interface IHighlightExtractor
    
    Parameters:
    highlightOptions - A collection of HighlightOptions.
    
    Returns:
    A collection of strings that represent highlights. If no highlight is found, a collection is empty.
  - extractPage
```
public String extractPage(int pageIndex)
```
    Reads all characters from the page with pageIndex and returns the data as a string.
    
    Specified by:
    
    extractPage in interface IPageTextExtractor
    
    Parameters:
    pageIndex - The index of the page.
    
    Returns:
    A string that contains all characters from the page, or null if all characters have been read.
  - reset
```
public void reset()
```
    Resets the current document.
    Resets the cursor's position. ExtractLine method will return the first line of the document.
    
    Overrides:
    
    reset in class TextExtractor
  - dispose
```
protected void dispose(boolean disposing)
```
    Releases the unmanaged resources used by the extractor.
    
    Overrides:
    
    dispose in class TextExtractor
    
    Parameters:
    disposing - A boolean true if invoked from Dispose; otherwise, false.
  - extractTextLine
```
protected String extractTextLine()
```
    Description copied from class: TextExtractor
    
    Extracts a line of characters from the text extractor and returns the data as a string.
    
    Overrides:
    
    extractTextLine in class TextExtractor
    
    Returns:
    The next line from the extractor, or null if all characters have been extracted.
  - extractText
```
protected String extractText()
```
    Extracts all characters from the current position to the end of the text extractor and returns them as one string.
    
    Overrides:
    
    extractText in class TextExtractor
    
    Returns:
    A string that contains all characters from the current position to the end of the text extractor.
  - prepareLine
```
protected String prepareLine()
```
    Returns a line of the text.
    
    Specified by:
    
    prepareLine in class TextExtractor
    
    Returns:
    A string that represents a line of the text, or null if all characters have been read.

Packages

com.groupdocs.parser.legacy

Interfaces

Classes

Exceptions

Class PdfTextExtractor

Constructor Summary

Method Summary

Methods inherited from class com.groupdocs.parser.legacy.TextExtractor

Methods inherited from class java.lang.Object

Constructor Detail

PdfTextExtractor

PdfTextExtractor

PdfTextExtractor

PdfTextExtractor

Method Detail

getDocumentContent

getTableAreaDetector

getTableAreaParser

getExtractMode

setExtractMode

getPageCount

getEntities

getFormData

openEntityStream

search

search

searchWithRegex

extractHighlights

extractPage

reset

dispose

extractTextLine

extractText

prepareLine