Packages

com.groupdocs.parser.legacy

Interfaces

Classes

Exceptions

java.lang.Object
- com.groupdocs.parser.legacy.TextExtractor
- - com.groupdocs.parser.legacy.SlidesTextExtractorBase
  - - com.groupdocs.parser.legacy.SlidesTextExtractor

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

public final class SlidesTextExtractor
extends SlidesTextExtractorBase
implements ISearchable, IHighlightExtractor, IRegexSearchable, IStructuredExtractor, IPageTextExtractor, IDocumentContentExtractor, IFastTextExtractor

Provides the text extractor for presentations.

Supported formats:

.PPT	Microsoft PowerPoint Presentation
.PPTX	Microsoft Office Open XML Presentation
.PPS	Microsoft PowerPoint Slideshow
.PPSX	Microsoft Office Open XML Auto-Play Presentation
.PPSM	PowerPoint Open XML Macro-Enabled Slideshow
.ODP	OpenDocument presentation

Extracting a text from a presentation:

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

Extracting text by slides:

 // Create a text extractor for presentations
 SlidesTextExtractor extractor = new SlidesTextExtractor(stream);
 // Iterate slides
 for (int slideIndex = 0; slideIndex &lt; extractor.getSlideCount(); slideIndex++) {
     // Extract a text from the slide which index is slideIndex
     System.out.println(extractor.extractSlide(slideIndex));
 }

Constructor Summary

Constructors
Constructor and Description
`SlidesTextExtractor(InputStream stream)` Initializes a new instance of the `SlidesTextExtractor` class.
`SlidesTextExtractor(InputStream stream, LoadOptions loadOptions)` Initializes a new instance of the `SlidesTextExtractor` class.
`SlidesTextExtractor(String fileName)` Initializes a new instance of the `SlidesTextExtractor` class.
`SlidesTextExtractor(String fileName, LoadOptions loadOptions)` Initializes a new instance of the `SlidesTextExtractor` 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)` Extracts all characters from the page with pageIndex and returns the data as a string.
`void`	`extractStructured(StructuredHandler handler)` Extracts a structured text.
`protected String`	`extractText()` Extracts all characters from the current position to the end of the text extractor and returns them as one string.
`DocumentContent`	`getDocumentContent()` Gets an access to the document's content.
`int`	`getExtractMode()` Gets a value indicating the mode of text extraction.
`int`	`getPageCount()` Gets a total count of the pages.
`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.SlidesTextExtractorBase
extractSlide, getSlideCount, nextSlide, prepareLine, reset

Methods inherited from class com.groupdocs.parser.legacy.TextExtractor
checkDisposed, close, dispose, extractAll, extractLine, extractTextLine, 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
  - SlidesTextExtractor
```
public SlidesTextExtractor(String fileName)
```
    Initializes a new instance of the SlidesTextExtractor class.
    
    Parameters:
    fileName - The path to the file.
  - SlidesTextExtractor
```
public SlidesTextExtractor(String fileName,
                   LoadOptions loadOptions)
```
    Initializes a new instance of the SlidesTextExtractor class.
    
    Parameters:
    fileName - The path to the file.
    loadOptions - The options of loading the file.
  - SlidesTextExtractor
```
public SlidesTextExtractor(InputStream stream)
```
    Initializes a new instance of the SlidesTextExtractor class.
    
    Parameters:
    stream - The stream of the document.
  - SlidesTextExtractor
```
public SlidesTextExtractor(InputStream stream,
                   LoadOptions loadOptions)
```
    Initializes a new instance of the SlidesTextExtractor 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.
  - 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()
```
    Description copied from interface: IPageTextExtractor
    
    Gets a total count of the pages.
    
    Specified by:
    
    getPageCount in interface IPageTextExtractor
    
    Returns:
    A total count of the pages.
  - extractStructured
```
public void extractStructured(StructuredHandler handler)
```
    Extracts a structured text.
    
    Specified by:
    
    extractStructured in interface IStructuredExtractor
    
    Parameters:
    handler - Structured text extraction handler.
  - 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)
```
    Description copied from interface: IPageTextExtractor
    
    Extracts 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 extracted.
  - dispose
```
protected void dispose(boolean disposing)
```
    Releases the unmanaged resources used by the extractor.
    
    Overrides:
    
    dispose in class SlidesTextExtractorBase
    
    Parameters:
    disposing - A boolean true if invoked from Dispose; otherwise, false.
  - 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.

Packages

com.groupdocs.parser.legacy

Interfaces

Classes

Exceptions

Class SlidesTextExtractor

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

SlidesTextExtractor

SlidesTextExtractor

SlidesTextExtractor

SlidesTextExtractor

Method Detail

getDocumentContent

getExtractMode

setExtractMode

getPageCount

extractStructured

search

search

searchWithRegex

extractHighlights

extractPage

dispose

extractText