| Package | Description |
|---|---|
| com.biomatters.geneious.publicapi.documents |
Provides interfaces and classes for defining documents in Geneious and related
interfaces and classes for dealing with XMLSerialization.
|
| com.biomatters.geneious.publicapi.plugin |
Provides the
GeneiousPlugin interface and plugin
related interfaces. |
| Modifier and Type | Method and Description |
|---|---|
DocumentType<T> |
DocumentSearchCache.getDocumentType() |
| Modifier and Type | Method and Description |
|---|---|
static <T extends PluginDocument> |
DocumentSearchCache.getDocumentSearchCacheFor(DocumentType<T> documentType)
Gets a cache for the given document type, creating the cache if necessary and caching the cache so that future calls to this method
return the same cache.
|
| Modifier and Type | Field and Description |
|---|---|
static DocumentType<SequenceAlignmentDocument> |
DocumentType.ALIGNMENT_TYPE
SequenceAlignmentDocument document type
|
static DocumentType<AminoAcidSequenceDocument> |
DocumentType.AMINO_ACID_SEQUENCE_TYPE
AminoAcidSequenceDocument document type
|
static DocumentType<JournalArticleDocument> |
DocumentType.ARTICLE_TYPE
JournalArticleDocument document type
|
static DocumentType<SequenceAlignmentDocument> |
DocumentType.CONTIG_TYPE
Contig document type
|
static DocumentType<MolecularStructureDocument> |
DocumentType.MOLECULAR_STRUCTURE_TYPE
MolecularStructureDocument document type
|
static DocumentType<?> |
DocumentType.NUCLEOTIDE_SEQUENCE_LIST_TYPE
Nucleotide Sequence List document type
|
static DocumentType<NucleotideSequenceDocument> |
DocumentType.NUCLEOTIDE_SEQUENCE_TYPE
NucleotideSequenceDocument document type
|
static DocumentType<OligoSequenceDocument> |
DocumentType.OLIGO_DOC_TYPE
Primer/Oligo sequence document type
|
static DocumentType<?> |
DocumentType.PROTEIN_SEQUENCE_LIST_TYPE
Protein Sequence List document type
|
static DocumentType<PublicationDocument> |
DocumentType.PUBLICATION_TYPE
PublicationDocument document type
|
static DocumentType<SequenceListDocument> |
DocumentType.SEQUENCE_LIST_TYPE
Sequence list document type which matches either nucleotide or protein sequence lists.
|
static DocumentType<CombinedAlignmentAndAminoAcidSequenceDocument> |
DocumentType.SEQUENCE_SEARCH_AMINO_ACID_HIT
CombinedAlignmentAndAminoAcidSequenceDocument document type
|
static DocumentType<CombinedAlignmentAndNucleotideSequenceDocument> |
DocumentType.SEQUENCE_SEARCH_NUCLEOTIDE_HIT
CombinedAlignmentAndNucleotideSequenceDocument document type
|
static DocumentType<SequenceDocument> |
DocumentType.SEQUENCE_TYPE
SequenceDocument document type
|
static DocumentType<TaxonomyDocument> |
DocumentType.TAXONOMY_TYPE
TaxonomyDocument document type
|
static DocumentType<TreeDocument> |
DocumentType.TREE_TYPE
TreeDocument document type
|
| Modifier and Type | Method and Description |
|---|---|
DocumentType[] |
GeneiousPlugin.getDocumentTypes()
get possible document types.
|
| Modifier and Type | Method and Description |
|---|---|
DocumentSelectionOption |
Options.addDocumentSelectionOption(String name,
String label,
DocumentSelectionOption.FolderOrDocuments defaultValue,
DocumentType documentType,
List<DocumentField> fieldsToDisplay,
boolean allowMultipleSelections,
List<AnnotatedPluginDocument> additionalDocuments)
Equivalent to
addDocumentSelectionOption(name, label, defaultValue, Collections.singleton(documentType), null, null, fieldsToDisplay, allowMultipleSelections, additionalDocuments (which takes a Set of DocumentTypes instead of a single DocumentType) |
| Modifier and Type | Method and Description |
|---|---|
DocumentSelectionOption |
Options.addDocumentSelectionOption(String name,
String label,
DocumentSelectionOption.FolderOrDocuments defaultValue,
Set<DocumentType> documentTypes,
DocumentFilter documentFilter,
String documentTypeDescription,
List<DocumentField> fieldsToDisplay,
boolean allowMultipleSelections,
List<AnnotatedPluginDocument> additionalDocuments)
An option to allow the user to select a number of documents of a particular type from their local database.
|
static DocumentSelectionOption.FolderOrDocuments |
PluginUtilities.displayDocumentSearchDialog(String preferenceKey,
DocumentSearchCache searchCache,
Set<DocumentType> documentTypes,
DocumentFilter documentFilter,
String documentTypeDescription,
List<AnnotatedPluginDocument> extraDocuments,
DocumentSelectionOption.FolderOrDocuments initialSelection,
List<DocumentField> fieldsToDisplay,
boolean allowMultipleSelection,
boolean showUseAllButton,
JComponent owner)
Display a dialog allowing the user to choose document(s) from their local database (or connected shared databases).
|
static boolean |
DocumentType.matches(Set<DocumentType> documentTypes,
AnnotatedPluginDocument document)
Returns true if the given document is at least one of the given document types.
|