Page History
...
Below is a listing of all currently available Media Filters, and what they actually do:
Name | Java Class | Function | Default input formats | Enabled by Default? |
|---|---|---|---|---|
| Text Extractor (7.3 or above) | org.dspace.app.mediafilter.TikaTextExtractionFilter | As of 7.3, all text extraction for Full text indexing takes place in a single filter. This filter uses Apache Tika which supports a wide variety of formats (e.g. Microsoft products, PDF, HTML, Text, etc). Additional formats may be configured from the Tika supported formats list at https://tika.apache.org/2.3.0/formats.html | Adobe PDF, | yes |
PDF Text Extractor |
| extracts the full text of Adobe PDF documents (only if text-based or OCRed) for full text indexing. (Uses the Apache PDFBox tool) | Adobe PDF | yes |
HTML Text Extractor |
| extracts the full text of HTML documents for full text indexing. (Uses Swing's HTML Parser) | HTML, Text | yes |
Word Text Extractor |
| extracts the full text of Microsoft Word and Microsoft Word XML documents for full text indexing. (Uses the "Apache POI" tools.) | Microsoft Word, Microsoft Word XML | yes |
Excel Text Extractor | org.dspace.app.mediafilter.ExcelFilter | extracts the full text of Microsoft Excel documents for full text indexing. (Uses the "Apache POI" tools.) | Microsoft Excel, Microsoft Excel XML | yes |
PowerPoint Text Extractor |
| extracts the full text of slides and notes in Microsoft PowerPoint and PowerPoint XML documents for full text indexing. (Uses the Apache POI tools.) | Microsoft Powerpoint, Microsoft Powerpoint XML | yes |
| PDFBox JPEG Thumbnail | org.dspace.app.mediafilter.PDFBoxThumbnail | creates thumbnail images of the first page of PDF files | Adobe PDF | yes |
JPEG Thumbnail |
| creates thumbnail images of GIF, JPEG and PNG files | BMP, GIF, JPEG, image/png | yes |
Branded Preview JPEG |
| creates a branded preview image for GIF, JPEG and PNG files | BMP, GIF, JPEG, image/png | no |
| ImageMagick Image Thumbnail Generator |
| Uses ImageMagick to generate thumbnails for image bitstreams. Requires installation of ImageMagick on your server. See ImageMagick Media Filters. | BMP, GIF, image/png, JPG, TIFF, JPEG, JPEG 2000 | no |
| ImageMagick PDF Thumbnail Generator | org.dspace.app.mediafilter.ImageMagickPdfThumbnailFilter | Uses ImageMagick and Ghostscript to generate thumbnails for PDF bitstreams. Requires installation of ImageMagick and Ghostscript on your server. See ImageMagick Media Filters. | Adobe PDF | no |
Please note that the filter-media script will automatically update the DSpace search index by default.
...
| Code Block |
|---|
#Get "outputFormat" configuration from dspace.cfg String outputFormat = ConfigurationManager.getProperty(MediaFilterManager.FILTER_PREFIX + "." + MyComplexMediaFilter.class.getName() + "." + this.getPluginInstanceName() + ".outputFormat"); |
Configuration parameters
| Property | textextractor.max-chars (only in 7.3 or above) |
| Example Value | textextractor.max-chars = 100000 |
| Informational Note | By default, the "Text Extractor" only extracts the first 100,000 characters of text for full-text indexing. This setting allows you to increase or decrease that default. Set to -1 for no maximum. Keep in mind that larger values (or -1) are more likely to encounter OutOfMemoryException errors when extracting text from very large files. In those scenarios, you may wish to consider instead enabling "textextractor.use-temp-file" below to better control memory usage. |
| Property | textextractor.use-temp-file (only in 7.3 or above) |
| Example Value | textextractor.use-temp-file = false |
| Informational Note | By default, the "Text Extractor" will perform all text extraction in memory (i.e. textextractor.use-temp-file=false). This ensures text extraction runs quickly, but it has the risk of hitting OutOfMemoryException errors if you either increase "textextractor.max-chars" or simply don't have much available memory on the server. In those scenarios, you can set "textextractor.use-temp-file=true" in order to tell the text extraction process to extract all text using a temporary file. This decreases the memory usage of the text extraction process, but will run slightly slower. |
| Property | filter.org.dspace.app.mediafilter.publicPermission |
|---|---|
| Example Value | filter.org.dspace.app.mediafilter.publicPermission = JPEGFilter |
| Informational Note | By default mediafilter derivatives / thumbnails inherit the permissions of the parent bitstream, but you can override this, in case you want to make publicly accessible derivative / thumbnail content, typically the thumbnails of objects for the browse list. List the MediaFilter names that would get public accessible permissions. Any media filters not listed will instead inherit the permissions of the parent bitstream. |
...
Overview
Content Tools