| Package | Description |
|---|---|
| com.biomatters.geneious.publicapi.databaseservice |
Provides the interface and associated classes for
defining a database service which is a service that
appears on the left-hand side of the main Geneious window
and provides the user with access to a database, for example
NCBI or the local database for storing the user's documents.
|
| 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.documents.sequence |
Provides interfaces specifying the types of
sequence and
alignment
documents in Geneious, together with concrete classes used by sequence documents
such as SequenceAnnotation
and SequenceCharSequence. |
| com.biomatters.geneious.publicapi.implementations |
Provides implementations for many of the document interfaces defined
in the package com.biomatters.geneious.publicapi.documents.types
together with some utility classes for dealing with some of these
document types.
|
| com.biomatters.geneious.publicapi.implementations.sequence |
Provides
SequenceDocument
implementations for nucelotide, amino acid, and nucleotide graph (chromatogram) sequences. |
| com.biomatters.geneious.publicapi.implementations.structure |
Provides
MolecularStructureDocument
implementations for many commonly used 3D structure documents. |
| com.biomatters.geneious.publicapi.plugin |
Provides the
GeneiousPlugin interface and plugin
related interfaces. |
| Modifier and Type | Field and Description |
|---|---|
DocumentField |
QueryField.field
Field to search on.
|
| Modifier and Type | Method and Description |
|---|---|
DocumentField |
FolderView.getDefaultSortingField()
Get the default field on which to sort documents.
|
DocumentField |
AdvancedSearchQueryTerm.getField()
Field to search in.
|
| Modifier and Type | Method and Description |
|---|---|
List<DocumentField> |
FolderView.getPropertyFields()
Get the field definitions for any properties that may appear on documents.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
PartiallyWritableDatabaseService.canEditDocumentField(AnnotatedPluginDocument document,
DocumentField field)
Returns true if it is possible to edit the given document field for the given document.
|
static Query |
Query.Factory.createFieldQuery(DocumentField field,
Condition condition,
Object value)
This creates a query to see if a given field value matches a condition.
|
static Query |
Query.Factory.createFieldQuery(DocumentField field,
Condition condition,
Object[] values)
This creates a query to see if a given field value matches a condition.
|
static Query |
Query.Factory.createFieldQuery(DocumentField field,
Condition condition,
Object[] values,
Map<String,Object> extendedOptions)
This creates a query to see if a given field value matches a condition.
|
void |
RetrieveCallback.setPropertyFields(List<DocumentField> searchResultProperties,
DocumentField defaultSortingField)
Set query specific properties.
|
| Modifier and Type | Method and Description |
|---|---|
void |
WritableDatabaseService.SearchResultPropertiesAdjuster.adjustPropertyFields(List<DocumentField> searchResultPropertyFields)
Adjust the contents of searchResultPropertyFields.
|
void |
RetrieveCallback.setPropertyFields(List<DocumentField> searchResultProperties,
DocumentField defaultSortingField)
Set query specific properties.
|
| Constructor and Description |
|---|
FolderView(List<DocumentField> propertyFields,
DocumentField defaultSortingField)
Constuct a new FolderView
|
QueryField(DocumentField field,
Condition[] conditions)
Constructor.
|
| Constructor and Description |
|---|
FolderView(List<DocumentField> propertyFields,
DocumentField defaultSortingField)
Constuct a new FolderView
|
| Modifier and Type | Field and Description |
|---|---|
static DocumentField |
DocumentField.ACCESSION_FIELD
Visible, non-editable field representing a document's accession.
|
static DocumentField |
DocumentField.ALIGNMENT_MATCH_REGIONS_FIELD
The regions in the original sequences that the local alignment matched on
|
static DocumentField |
DocumentField.ALIGNMENT_METHOD_FIELD
The method/algorithm used to build an alignment.
|
static DocumentField |
DocumentField.ALIGNMENT_OPTIONS_FIELD
The options used to create the alignment
|
static DocumentField |
DocumentField.ALIGNMENT_PERCENTAGE_IDENTICAL
The percentage of columns in the alignment for which all sequence are identical.
|
static DocumentField |
DocumentField.ALIGNMENT_SCORE_FIELD
The score of an alignment (the exact meaning of this depends on the particular alignment implementation)
|
static DocumentField |
DocumentField.ALIGNMENT_SIMILARITY
The percentage of pairwise residues that are identical in the alignment, including gap versus non-gap residues, but excluding gap versus gap residues.
|
static DocumentField |
DocumentField.ALL
A DocumentField representing an option to search all fields.
|
static DocumentField |
DocumentField.AMBIGUITIES
The number of untrimmed amibguity bases or residues in a chromatogram.
|
static DocumentField |
DocumentField.BIN
Each chromatogram or alignment is assigned to a "Low", "Medium" or "High" quality bin based on its properties.
|
static DocumentField |
DocumentField.BIN_REASON
Each chromatogram or alignment is assigned to a "Low", "Medium" or "High" quality bin based on its properties.
|
static DocumentField |
DocumentField.BINNING_FRAME
The translation frame and direction which gives the least number of stop codons in the consensus sequence of a contig.
|
static DocumentField |
DocumentField.BINNING_GENETIC_CODE
The genetic code which produces the least number of stop codons in the consensus sequence of a contig.
|
static DocumentField |
DocumentField.COLOR
The color of a document in the document table.
|
static DocumentField |
DocumentField.COMMON_NAME_FIELD
Visible, editable field representing the common name for the organism of a sequence.
|
static DocumentField |
DocumentField.CONSENSUS_SEQUENCE_LENGTH
The approximate length of the consensus sequence in a contig.
|
static DocumentField |
DocumentField.CONSENSUS_SOURCE_SEQUENCES_FIELD
The number of sequences in the contig that a consensus sequence was generated from
|
static DocumentField |
DocumentField.CONTIG_MEAN_COVERAGE
Mean number of sequences covering a column in an assembly
All
SequenceAlignmentDocuments created in 7.0 or later (or just small ones created prior to 7.0) with
SequenceAlignmentDocument.isContig()==true have this field |
static DocumentField |
DocumentField.CONTIG_PERCENTAGE_OF_REFERENCE_SEQUENCE_COVERED
The percentage of the reference sequence in a contig that is covered by one or more reads.
|
static DocumentField |
DocumentField.CONTIG_REFERENCE_SEQUENCE_INDEX
The index of the reference sequence in an alignment contig or -1 if there is no reference sequence.
|
static DocumentField |
DocumentField.CONTIG_REFERENCE_SEQUENCE_LENGTH
The length of the reference sequence (if any) in an alignment or contig.
|
static DocumentField |
DocumentField.CREATED_FIELD
Non-visible, editable field representing a document's creation date.
|
static DocumentField |
DocumentField.DELETED_DOCUMENT_ORIGINAL_LOCATION_FIELD
The folder from which a deleted document originally came from
|
static DocumentField |
DocumentField.DESCRIPTION_FIELD
Visible, editable field representing a document's description.
|
static DocumentField |
DocumentField.DISAGREEMENTS
The number of alignment columns with a disagreement between two or more sequences (including internal gap vs non-gap)
All small
SequenceAlignmentDocuments have this field. |
static DocumentField |
DocumentField.FIRST_SEQUENCE_RESIDUES
The first few residues or bases in a sequence.
|
static DocumentField |
DocumentField.GC_PERCENT
The GC percentage of a nucleotide sequence, contig, or alignment.
|
static DocumentField |
DocumentField.GENETIC_CODE_FIELD
Visible, editable field representing a sequence's genetic code.
|
static DocumentField |
DocumentField.HAS_ANY_READS_MAPPED_TO_MULTIPLE_LOCATIONS
SequenceAlignmentDocuments may have this field to indicate whether or not any reads in it
are mapped to multiple locations. |
static DocumentField |
DocumentField.HIGH_QUALITY_PERCENT
The percentage of untrimmed bases in a chromatogram that are high quality.
|
static DocumentField |
DocumentField.INDEL_DISAGREEMENTS
The number of alignment columns with a disagreement between two or more sequences and at least one is a gap
All small
SequenceAlignmentDocuments have this field. |
static DocumentField |
DocumentField.IS_FREE_END_GAPS
Whether this alignment has free end gaps.
|
static DocumentField |
DocumentField.LOW_QUALITY_PERCENT
The percentage of untrimmed bases in a chromatogram that are low quality.
|
static DocumentField |
DocumentField.MAPPING_QUALITY
SequenceDocuments in a contig may have this field to indicate the confidence that this read is mapped to the correct location. |
static DocumentField |
DocumentField.MAXIMUM_SEQUENCE_LENGTH
SequenceListDocuments may have this field which indicates the maximum length of all the sequences in the document.
|
static DocumentField |
DocumentField.MEDIMUM_QUALITY_PERCENT
The percentage of untrimmed bases in a chromatogram that are medium quality.
|
static DocumentField |
DocumentField.MINIMUM_SEQUENCE_LENGTH
SequenceListDocuments may have this field which indicates the minimum length of all the sequences in the document.
|
static DocumentField |
PluginDocument.MODIFIED_DATE_FIELD
A field indicating when a document was last modified.
|
static DocumentField |
DocumentField.MOLECULE_TYPE_FIELD
Visible, editable field representing the molecule type of a sequence (eg, mRNA or AA)
Use this field in all documents which should have a displayable molecule type value.
|
static DocumentField |
DocumentField.NAME_FIELD
Visible, editable field representing a document's name
All documents have this field.
|
static DocumentField |
DocumentField.NOTES
Free text entered by the user
|
static DocumentField |
DocumentField.NUCLEOTIDE_SEQUENCE_COUNT
The number of nucleotide sequences in an alignment or set of sequences.
|
static DocumentField |
DocumentField.NUCLEOTIDE_SEQUENCES_WITH_MATES_COUNT
The number of nucleotide sequences in an alignment or set of sequences that have mates (i.e.
|
static DocumentField |
DocumentField.NUCLEOTIDE_SEQUENCES_WITH_QUALITY_COUNT
The number of nucleotide sequences in an alignment or set of sequences that have quality data (i.e.
|
static DocumentField |
DocumentField.NUCLEOTIDES_COUNT
SequenceListDocuments may have this field which indicates the total number of nucleotides in all sequences in the document
|
static DocumentField |
DocumentField.NUMBER_OF_MAPPED_LOCATIONS
SequenceDocuments may have this field to indicate the number of places the read maps to the reference sequence(s). |
static DocumentField |
DocumentField.NUMBER_OF_STOP_CODONS
The minimum number of stop codons for this sequence (for a single frame, across all frames)
|
static DocumentField |
DocumentField.ORGANISM_FIELD
Visible, editable field representing a document's organism
Use this field in all documents which should have a displayable organism value.
|
static DocumentField |
DocumentField.POST_TRIM_LENGTH
The length of a chromatogram after trimming.
|
static DocumentField |
DocumentField.PROTEIN_SEQUENCE_COUNT
The number of amino acid sequences in an alignment or set of sequences.
|
static DocumentField |
DocumentField.REFERENCE_SEQUENCE_NAME
The name of the reference sequence (if any) in an alignment or contig.
|
DocumentField |
AdditionalSearchContent.Result.searchField
Field search for advanced search.
|
static DocumentField |
DocumentField.SEQUENCE_COUNT
The number of sequences in an alignment or set of sequences.
|
static DocumentField |
DocumentField.SEQUENCE_DIRECTION
Deprecated.
no longer used by binning, replaced by
BINNING_FRAME |
static DocumentField |
DocumentField.SEQUENCE_LENGTH
The number of residues or bases in a sequence or the length of an alignment.
|
static DocumentField |
DocumentField.SEQUENCE_LIST_ORDERING_REVISION_NUMBER
A cache of the value returned from
EditableSequenceListDocument.getOrderingRevisionNumber()
All EditableSequenceListDocuments created in Geneious 6.0.5 or later have this field. |
static DocumentField |
DocumentField.SEQUENCE_TYPE
Allows marking of special types of sequence like vectors and references.
|
static DocumentField |
DocumentField.TAXONOMY_FIELD
Visible, editable field representing a sequence's taxonomy.
|
static DocumentField |
DocumentField.TOPOLOGY_FIELD
Visible, editable field representing the topology of a sequence - either
"linear" or "circular"
Always displayed for sequence document (handled by core). |
static DocumentField |
DocumentField.TREE_BUILDER_METHOD_FIELD
The method/algorithm used to build a tree.
|
static DocumentField |
DocumentField.TRIMMED_SEQUENCES_COUNT
The number of sequences in an alignment or set of sequences that have trim annotations or are
ImmutableSequences with either ImmutableSequence.getLeadingTrimLength() or ImmutableSequence.getTrailingTrimLength() greater than 0. |
static DocumentField |
DocumentField.UNREAD_FIELD
Visible, non-editable field representing whether a document is unread.
|
static DocumentField |
DocumentField.URN_FIELD
Visible, non-editable field containing the
AnnotatedPluginDocument
URN as a String. |
| Modifier and Type | Field and Description |
|---|---|
static List<DocumentField> |
DocumentField.ALL_STANDARD_FIELDS
A list of all standard DocumentFields defined either in this class or other public API locations that are displayable to the user.
|
| Modifier and Type | Method and Description |
|---|---|
static DocumentField |
DocumentField.createBooleanField(String name,
String desc,
String code,
boolean defaultVisible,
boolean editable)
Creates a DocumentField with a Boolean value.
|
static DocumentField |
DocumentField.createCustomField(String name,
String desc,
String code,
Class<? extends XMLSerializable> valueType)
Creates a DocumentField with a value of arbitrary type.
|
static DocumentField |
DocumentField.createCustomField(String name,
String desc,
String code,
Class<? extends XMLSerializable> valueType,
boolean defaultVisible,
boolean editable)
Creates a DocumentField with a value of arbitrary type.
|
static DocumentField |
DocumentField.createDateField(String name,
String desc,
String code)
Creates a DocumentField with a Date value.
|
static DocumentField |
DocumentField.createDateField(String name,
String desc,
String code,
boolean defaultVisible,
boolean editable)
Creates a DocumentField with a Date value.
|
static DocumentField |
DocumentField.createDoubleField(String name,
String desc,
String code)
Creates a DocumentField with a Double value.
|
static DocumentField |
DocumentField.createDoubleField(String name,
String desc,
String code,
boolean defaultVisible,
boolean editable)
Creates a DocumentField with a Double value.
|
static DocumentField |
DocumentField.createEnumeratedField(String[] enumerationValues,
String name,
String desc,
String code,
boolean defaultVisible,
boolean editable)
Creates a DocumentField with an enumerated set of possible String values.
|
static DocumentField |
DocumentField.createIntegerField(String name,
String desc,
String code)
Creates a DocumentField with an Integer value.
|
static DocumentField |
DocumentField.createIntegerField(String name,
String desc,
String code,
boolean defaultVisible,
boolean editable)
Creates a DocumentField with an Integer value.
|
static DocumentField |
DocumentField.createLongField(String name,
String desc,
String code,
boolean defaultVisible,
boolean editable)
Creates a DocumentField with a Long value.
|
static DocumentField |
DocumentField.createStringField(String name,
String desc,
String code)
Creates a DocumentField with a String value.
|
static DocumentField |
DocumentField.createStringField(String name,
String desc,
String code,
boolean defaultVisible,
boolean editable)
Creates a DocumentField with a String value, that may or may not be
visible and may or may not be editable.
|
static DocumentField |
DocumentField.createURLField(String name,
String desc,
String code)
Creates a DocumentField with a URL value.
|
DocumentField |
DocumentNoteField.getDocumentFieldCopy() |
DocumentField |
DocumentFieldAndValue.getField() |
static DocumentField |
DocumentField.getStandardDisplayableField(String fieldCode)
If fieldCode is for one of the standard fields listed in
ALL_STANDARD_FIELDS, then returns that field |
| Modifier and Type | Method and Description |
|---|---|
static List<DocumentField> |
DocumentUtilities.getAllDisplayableFields()
Gets a list of all the displayable fields on any document in the user's database
|
List<DocumentField> |
AbstractPluginDocument.getDisplayableFields() |
abstract List<DocumentField> |
AnnotatedPluginDocument.getDisplayableFields()
Get a list of all displayable fields available on the PluginDocument
contained within this AnnotatedPluginDocument.
|
List<DocumentField> |
OperationRecordDocument.getDisplayableFields() |
List<DocumentField> |
PluginDocument.getDisplayableFields()
A list of columns for display in the main document panel.
|
abstract List<DocumentField> |
AnnotatedPluginDocument.getExtendedDisplayableFields()
Gets a list of all displayable document fields, which includes all those returned by
AnnotatedPluginDocument.getDisplayableFields() as well as the document name, description, creation date
and all note fields with getCode()s
of the form "noteCode.fieldCode". |
Map<DocumentField,List<Object>> |
AnnotatedPluginDocument.getSearchableFieldsAndValues()
Equivalent to
getSearchableFieldsAndValues(ProgressListener.EMPTY) |
abstract Map<DocumentField,List<Object>> |
AnnotatedPluginDocument.getSearchableFieldsAndValues(ProgressListener progressListener)
Gets a set of fields and associated values that are indexed
for search purposes.
|
abstract Map<DocumentField,List<Object>> |
AnnotatedPluginDocument.getSearchableFieldsAndValuesForAnnotatedDocumentOnly()
The same as
AnnotatedPluginDocument.getSearchableFieldsAndValues() except that only fields and values for the annotated
document are returned. |
| Modifier and Type | Method and Description |
|---|---|
void |
AbstractPluginDocument.addDisplayableField(DocumentField field)
adds a displayable field to the document that is stored with the documents.
|
abstract Object |
AnnotatedPluginDocument.getFieldValue(DocumentField field)
Get value of a field - either a displayable field or a hidden field.
|
void |
AbstractPluginDocument.setFieldValue(DocumentField field,
Object value)
Set value of one data item (field).
|
abstract void |
AnnotatedPluginDocument.setFieldValue(DocumentField field,
Object value)
Set the value of field which is visible in the user interface.
|
abstract void |
AnnotatedPluginDocument.setHiddenFieldValue(DocumentField field,
Object value)
Set the value of field which is not visible in the user interface.
|
| Constructor and Description |
|---|
AdditionalSearchContent.Result(DocumentField field,
String text)
Constructor.
|
DocumentFieldAndValue(DocumentField field,
Object value)
Construct a
DocumentField together with its value. |
| Modifier and Type | Method and Description |
|---|---|
List<DocumentField> |
ImmutableSequenceImplementation.getDisplayableFields() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
SequenceAlignmentDocument.canSetFieldValue(int sequenceIndex,
DocumentField field)
Returns true if this alignment supports updating field values using
SequenceAlignmentDocument.setFieldValue(int, com.biomatters.geneious.publicapi.documents.DocumentField, Object, boolean) |
void |
SequenceAlignmentDocument.setFieldValue(int sequenceIndex,
DocumentField field,
Object fieldValue,
boolean allowModifyingOriginals)
Sets the value of a displayable field on one of the sequences in the alignment.
|
| Modifier and Type | Method and Description |
|---|---|
List<DocumentField> |
DefaultAlignmentDocument.getDisplayableFields() |
List<DocumentField> |
DefaultSameTaxaTreesDocument.getDisplayableFields() |
List<DocumentField> |
DefaultTreeDocument.getDisplayableFields() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
DefaultAlignmentDocument.canSetFieldValue(int sequenceIndex,
DocumentField field) |
void |
DefaultAlignmentDocument.setFieldValue(int sequenceIndex,
DocumentField field,
Object fieldValue,
boolean allowModifyingOriginals) |
| Modifier and Type | Field and Description |
|---|---|
static DocumentField |
OligoSequenceDocument.HAIRPIN_FIELD
Displayable field for the hairpin alignment score of the oligo
|
static DocumentField |
OligoSequenceDocument.OLIGO_TYPE_FIELD
Displayable field for the type of oligo (see
OligoSequenceDocument.OligoType)
The value of this field is the toString() value of the OligoType object |
static DocumentField |
OligoSequenceDocument.PERCENT_GC_FIELD
Displayable field for GC percent of the oligo
|
static DocumentField |
OligoSequenceDocument.PRIMER_DIMER_FIELD
Displayable field for the primer-dimer alignment score of the oligo
|
static DocumentField |
OligoSequenceDocument.TM_FIELD
Displayable field for the melting point of the oligo
|
| Modifier and Type | Method and Description |
|---|---|
List<DocumentField> |
CombinedAlignmentAndSequenceDocument.getDisplayableFields() |
List<DocumentField> |
DefaultSequenceDocument.getDisplayableFields() |
List<DocumentField> |
SequencePropertiesStorage.getDisplayableFields()
This method is not implemented.
|
| Modifier and Type | Method and Description |
|---|---|
List<DocumentField> |
DefaultMolecularStructureDocument.getDisplayableFields() |
List<DocumentField> |
PdbDocument.getDisplayableFields() |
| Modifier and Type | Field and Description |
|---|---|
static DocumentField |
DocumentType.DOCUMENT_TYPE_FIELD
A field used for searching databases based on the document type.
|
| 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) |
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).
|