Package com.biomatters.geneious.publicapi.documents

Interface AdditionalSearchContent

public interface AdditionalSearchContent

Interface implemented by a document which has text stored in places other than the document fields and want that text available for search.

Those cases requires additional help from the document.

For example, a PDF document stores content in binary form. Other cases may apply. A binary content document may need an external viewer to properly show its content.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AdditionalSearchContent.Result	Searchable content for a single category.
static class	AdditionalSearchContent.Utilities	Small helpers for extracting searchable content from XML data.

Method Summary

Modifier and Type	Method	Description
AdditionalSearchContent.Result[]	getSearchContent()	List containing search content for geneious to index.

Method Details

getSearchContent

AdditionalSearchContent.Result[] getSearchContent()

List containing search content for geneious to index.

Returns:

search content. Must not be null but may be an empty array.