com.atlassian.confluence.search.v2.extractor

Class BaseAttachmentContentExtractor

java.lang.Object

com.atlassian.confluence.search.v2.extractor.BaseAttachmentContentExtractor

All Implemented Interfaces:

Extractor2

Direct Known Subclasses:

LimitedTextContentExtractor

public abstract class BaseAttachmentContentExtractor
extends Object
implements Extractor2

A base template for attachment content extractors to extend.

Since:

7.17

Constructor Summary

Constructors

Constructor and Description
BaseAttachmentContentExtractor()

Method Summary

Modifier and Type	Method and Description
Collection<FieldDescriptor>	extractFields(Object searchable) Extract fields from the searchable object.
protected abstract String	extractText(InputStream is, com.atlassian.bonnie.search.SearchableAttachment attachment)
StringBuilder	extractText(Object searchable) Returns a buffer of text that will be appended onto the end of a larger buffer of text that will eventually become the searchable body text.
protected Optional<CharSequence>	extractText(com.atlassian.bonnie.search.SearchableAttachment attachment)
protected abstract boolean	shouldExtractFrom(String fileName, String contentType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseAttachmentContentExtractor

public BaseAttachmentContentExtractor()

Method Detail

extractText

@Nonnull
protected Optional<CharSequence> extractText(com.atlassian.bonnie.search.SearchableAttachment attachment)

extractFields

public Collection<FieldDescriptor> extractFields(Object searchable)

Description copied from interface: Extractor2

Extract fields from the searchable object.

Specified by:

extractFields in interface Extractor2

Parameters:

searchable - a searchable object

Returns:

list of fields extracted from the searchable object

extractText

public StringBuilder extractText(Object searchable)

Description copied from interface: Extractor2

Returns a buffer of text that will be appended onto the end of a larger buffer of text that will eventually become the searchable body text.

Specified by:

extractText in interface Extractor2

Parameters:

searchable - a searchable object

Returns:

Returns a buffer of text that will be appended onto the end of a larger buffer of text that will eventually become the searchable body text.

shouldExtractFrom

protected abstract boolean shouldExtractFrom(String fileName,
                                             String contentType)

extractText

protected abstract String extractText(InputStream is,
                                      com.atlassian.bonnie.search.SearchableAttachment attachment)
                               throws com.atlassian.bonnie.search.extractor.ExtractorException

Parameters:

is - a stream containing the attachment contents

attachment - contains useful attachment metadata, e.g. filename

Returns:

a String with a textual representation of the attachment's contents

Throws:

com.atlassian.bonnie.search.extractor.ExtractorException - if there is a problem with converting the attachment content into text. A wrapper around the original exception.