public abstract static class Assembler.Callback extends Object
Assembler.assemble(Options, AssemblerInput, jebl.util.ProgressListener, com.biomatters.geneious.publicapi.plugin.Assembler.Callback)| Constructor and Description |
|---|
Assembler.Callback() |
| Modifier and Type | Method and Description |
|---|---|
void |
addAssemblyReportText(String textAsHtmlFragment)
Adds some text to be included in the assembly report (if the user chooses to generate or display one).
|
abstract void |
addContigDocument(SequenceAlignmentDocument contig,
NucleotideSequenceDocument contigConsensus,
boolean isThisTheOnlyContigGeneratedByDeNovoAssembly,
ProgressListener progressListener)
Adds a contig generated by this assembler.
|
void |
addDocument(AnnotatedPluginDocument document,
ProgressListener progressListener)
Adds a document generated by this assembler.
|
abstract void |
addUnusedRead(AssemblerInput.Read read,
ProgressListener progressListener)
Adds a read that was not assembled.
|
void |
addUnusedReads(SequenceListDocument unusedReads,
ProgressListener progressListener)
Adds a list of reads that were not assembled.
|
void |
addUsedRead(AssemblerInput.Read read,
ProgressListener progressListener)
Adds a read that was assembled.
|
public abstract void addContigDocument(SequenceAlignmentDocument contig, NucleotideSequenceDocument contigConsensus, boolean isThisTheOnlyContigGeneratedByDeNovoAssembly, ProgressListener progressListener) throws DocumentOperationException
contig - the generated contig. If the assembler returned Assembler.ContigOutputSupport.ConsensusOnly from Assembler.getContigOutputSupport() this may be null.contigConsensus - the consensus of the generated contig. If the assembler returned Assembler.ContigOutputSupport.ContigsOnly from Assembler.getContigOutputSupport() this may be null.progressListener - progress for Geneious to report to while it saves the data to the user's local database.isThisTheOnlyContigGeneratedByDeNovoAssembly - if this is a de novo (rather than reference sequence) assembly and only a single result is being generated, this should be true to assist Geneious in naming the results more appropriately. If in doubt set this to false.DocumentOperationException - if the document cannot be saved.public abstract void addUnusedRead(AssemblerInput.Read read, ProgressListener progressListener) throws DocumentOperationException
Assembler.providesUnusedReads()read - the unused read.progressListener - progress for Geneious to report to while it saves the data to the user's local database.DocumentOperationException - if the document cannot be saved.public void addUsedRead(AssemblerInput.Read read, ProgressListener progressListener) throws DocumentOperationException
Assembler.providesUsedReads() ()}read - the used read (which may include an unmapped mate if AssemblerInput.isSaveUsedReadsIncludeMates() returned true)progressListener - progress for Geneious to report to while it saves the data to the user's local database.DocumentOperationException - if the document cannot be saved.public void addDocument(AnnotatedPluginDocument document, ProgressListener progressListener) throws DocumentOperationException
addContigDocument
or addUnusedRead
or addUnusedReads
or addAssemblyReportText instead.document - the document to addprogressListener - progress for Geneious to report to while it saves the data to the user's local database.DocumentOperationException - if the document cannot be saved.UnsupportedOperationException - if this callback doesn't implement this methodpublic void addUnusedReads(SequenceListDocument unusedReads, ProgressListener progressListener) throws DocumentOperationException
Assembler.providesUnusedReads().
This is a convenience method whose functionality is implemented as a series of calls to addUnusedRead(com.biomatters.geneious.publicapi.plugin.AssemblerInput.Read, jebl.util.ProgressListener)
and is intended for use with assembly algorithms which call external command line programs which return unused reads in a file which is imported into Geneious as a SequenceListDocument.unusedReads - the unused reads.progressListener - progress for Geneious to report to while it saves the data to the user's local database.DocumentOperationException - if the document cannot be saved.public void addAssemblyReportText(String textAsHtmlFragment)
textAsHtmlFragment - the text to display in the report which should be an html fragment. (i.e. < and > are treated as html tags)