RbDe rbde-349 (20120127151154)

edu.mssm.crover.tools.tm
Interface TmPredictor

All Known Implementing Classes:
HmmTop, HmmTopLocal, TmHmmSocket, TmHmmWeb

public interface TmPredictor

Engine to predict trans-membrane domains of protein sequences.


Method Summary
 String getDescription()
          Return a string which describes the method, its availability, etc.
 String getReferenceURL()
          Return an URL which describe the method, its availability, etc.
 boolean installed()
          Is this predictor available on this machine?
 TmDomain_Annotation predict(BiologicalSequence seq)
          Predict the trans-membrane domain of a protein sequence.
 TmDomain_Annotation[] predict(BiologicalSequence[] seq)
          Predict the trans-membrane domains of a set of protein sequences.
 boolean useWebAccess()
          Return whether this predictor uses an HTTP connection to the prediction web service.
 

Method Detail

predict

TmDomain_Annotation predict(BiologicalSequence seq)
                            throws WrapperFailed
Predict the trans-membrane domain of a protein sequence.

Throws:
WrapperFailed

predict

TmDomain_Annotation[] predict(BiologicalSequence[] seq)
                              throws WrapperFailed
Predict the trans-membrane domains of a set of protein sequences.

Throws:
WrapperFailed

getReferenceURL

String getReferenceURL()
Return an URL which describe the method, its availability, etc.


getDescription

String getDescription()
Return a string which describes the method, its availability, etc. The description can contain the literature reference, author names, short explanation of how the method works, etc.


useWebAccess

boolean useWebAccess()
Return whether this predictor uses an HTTP connection to the prediction web service.

Returns:
true if the predictor connects to a web service through the web, false otherwise (in this case the tool must be installed locally).

installed

boolean installed()
Is this predictor available on this machine?

Returns:
True when the predictor can be used from this machine, False otherwise.

RbDe rbde-349 (20120127151154)

Copyright © 2003-2012 Institute for Computational Biomedicine, All Rights Reserved.