Package com.atlassian.confluence.plugins.index.api

Interface Extractor2

All Known Implementing Classes:
AddressableExtractor, AttachmentExtractedTextExtractor, AttachmentMetadataExtractor, AttachmentMimeTypeExtractor, AttachmentOwnerContentTypeExtractor, BaseAttachmentContentExtractor, CommentExtractor, ConfluenceAttachmentMetadataExtractor, ContentEntityMetadataExtractor, ContentPermissionsExtractor, ContentPropertiesExtractor, CustomContentSearchExtractor, DefaultSearchableContentExtractor, DeletingRetentionPolicyExtractor, EntityDateExtractor, HomePageExtractor, LabelExtractor, LastModifierNameContentExtractor, LastModifierNameExtractor, LimitedTextContentExtractor, LuceneChangeExtractor, LuceneContentExtractor, MacroExtractor, PersonalInformationExtractor, RetentionPolicyPropertyExtractor, SpaceDescriptionExtractor, SpaceDescriptionUsernameExtractor, SpaceExtractor, SpaceKeyAndNameExtractor, SpaceTypeExtractor, TitleExtractor, UntokenizedTitleExtractor, VersionCommentExtractor, VersionNumberExtractor
public interface Extractor2
This interface provides clients with the ability add additional fields and body text to the index documents produced for each searchable object in Confluence.
Since:
7.17

  • Method Summary

    Modifier and Type
    Method
    Description
    Collection<FieldDescriptor>
    extractFields(Object searchable)
    Extract fields from the searchable object.
    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.

  • Method Details

    • extractText

      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.
      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.

    • extractFields

      Collection<FieldDescriptor> extractFields(Object searchable)
      Extract fields from the searchable object.
      Parameters:
      searchable - a searchable object
      Returns:
      list of fields extracted from the searchable object