T
- executable type / web service typepublic interface SequenceAnnotation<T> extends JABAService, JManagement, Metadata<T>
JABAWS_VERSION, SERVICE_NAMESPACE, V2_SERVICE_NAMESPACE, V3_SERVICE_NAMESPACE
Modifier and Type | Method and Description |
---|---|
java.lang.String |
analize(java.util.List<FastaSequence> sequences)
Analyse the sequences.
|
java.lang.String |
customAnalize(java.util.List<FastaSequence> sequences,
java.util.List<Option<T>> options)
Analyse the sequences according to custom settings defined in options
list.
|
ScoreManager |
getAnnotation(java.lang.String jobId)
Return the result of the job.
|
java.lang.String |
presetAnalize(java.util.List<FastaSequence> sequences,
Preset<T> preset)
Analyse the sequences according to the preset settings.
|
cancelJob, getJobStatus, pullExecStatistics
getLimit, getLimits, getPresets, getRunnerOptions
java.lang.String analize(java.util.List<FastaSequence> sequences) throws UnsupportedRuntimeException, LimitExceededException, JobSubmissionException
sequences
- List of FastaSequence objects. The programme does not perform
any sequence validity checks. Nor does it checks whether the
sequences names are unique. It is responsibility of the caller
to validate this informationJobSubmissionException
- is thrown when the job could not be submitted due to the
following reasons: 1) The number of sequences in the
submission or their average length is greater then defined by
the default Limit. 2) Any problems on the server side e.g. it
is misconfigured or malfunction, is reported via this
exception. In the first case the information on the limit
could be obtained from an exception.java.security.InvalidParameterException
- thrown if input list of fasta sequence is null or emptyUnsupportedRuntimeException
- thrown if server OS does not support native executables for a
given web service, e.g. JABAWS is deployed on Windows and
Mafft service is calledLimitExceededException
- is throw if the input sequences number or average length
exceeds what is defined by the limitjava.lang.String customAnalize(java.util.List<FastaSequence> sequences, java.util.List<Option<T>> options) throws UnsupportedRuntimeException, LimitExceededException, JobSubmissionException, WrongParameterException
sequences
- List of FastaSequence objects. The programme does not perform
any sequence validity checks. Nor does it checks whether the
sequences names are unique. It is responsibility of the caller
to validate this informationoptions
- A list of OptionsJobSubmissionException
- is thrown when the job could not be submitted due to the
following reasons: 1) The number of sequences in the
submission or their average length is greater then defined by
the default Limit. 2) Any problems on the server side e.g. it
is misconfigured or malfunction, is reported via this
exception. In the first case the information on the limit
could be obtained from an exception.WrongParameterException
- is throws when 1) One of the Options provided is not
supported, 2) The value of the option is defined outside the
boundaries. In both cases exception object contain the
information on the violating Option.java.security.InvalidParameterException
- thrown if input list of fasta sequence is null or emptyUnsupportedRuntimeException
- thrown if server OS does not support native executables for a
given web service, e.g. JABAWS is deployed on Windows and
Mafft service is calledLimitExceededException
- is throw if the input sequences number or average length
exceeds what is defined by the limitOption
java.lang.String presetAnalize(java.util.List<FastaSequence> sequences, Preset<T> preset) throws UnsupportedRuntimeException, LimitExceededException, JobSubmissionException, WrongParameterException
sequences
- List of FastaSequence objects. The programme does not perform
any sequence validity checks. Nor does it checks whether the
sequences names are unique. It is responsibility of the caller
to validate this informationpreset
- A list of OptionsJobSubmissionException
- is thrown when the job could not be submitted due to the
following reasons: 1) The number of sequences in the
submission or their average length is greater then defined by
the default Limit. 2) Any problems on the server side e.g. it
is misconfigured or malfunction, is reported via this
exception. In the first case the information on the limit
could be obtained from an exception.WrongParameterException
- is throws when 1) One of the Options provided is not
supported, 2) The value of the option is defined outside the
boundaries. In both cases exception object contain the
information on the violating Option.java.security.InvalidParameterException
- thrown if input list of fasta sequence is null or emptyUnsupportedRuntimeException
- thrown if server OS does not support native executables for a
given web service, e.g. JABAWS is deployed on Windows and
Mafft service is calledLimitExceededException
- is throw if the input sequences number or average length
exceeds what is defined by the limitScoreManager getAnnotation(java.lang.String jobId) throws ResultNotAvailableException
jobId
- a unique job identifierResultNotAvailableException
- this exception is throw if the job execution was not
successful or the result of the execution could not be found.
(e.g. removed). Exception could also be thrown is dues to the
lower level problems on the server i.e. IOException,
FileNotFoundException problems as well as
UnknownFileFormatException.java.security.InvalidParameterException
- thrown if jobId is empty or cannot be recognised e.g. in
invalid format