Package org.biojava.nbio.structure.scop
Class RemoteScopInstallation
java.lang.Object
org.biojava.nbio.structure.scop.RemoteScopInstallation
- All Implemented Interfaces:
ScopDatabase
A class that fetches information about SCOP from a remote data-source. It requires port 80 to open for HTTP connection.
- Author:
- Andreas Prlic
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfilterByClassificationId(String query) Get all scop descriptions that start with a classification ID, e.g.filterByDescription(String query) Get all scop descriptions that start with a certain name.filterByDomainName(String query) search through SCOP and filter based on domain namegetByCategory(ScopCategory category) Get all records of a particular classification.getComments(int sunid) Get comments about a SCOP domain by its sunidgetDomainByScopID(String scopId) get a ScopDomain by its SCOP ID (warning, they are not stable between releases!)getDomainsForPDB(String pdbId) Get a list of ScopDomains that have been assigned to a PDB IDgetScopDescriptionBySunid(int sunid) Return the SCOP description for a node in the hierarchy by its "sunid" id.getScopDomainsBySunid(Integer sunid) Get a SCOP domain by its sunidgetScopNode(int sunid) Access a particular ScopNode.Returns the SCOP versiongetTree(ScopDomain domain) get the SCOP sub-tree for a particular domain.static voidvoidsetScopVersion(String version) Sets the scop version used.void
-
Field Details
-
DEFAULT_SERVER
- See Also:
-
-
Constructor Details
-
RemoteScopInstallation
public RemoteScopInstallation()
-
-
Method Details
-
main
-
getServer
-
setServer
-
getByCategory
Description copied from interface:ScopDatabaseGet all records of a particular classification.- Specified by:
getByCategoryin interfaceScopDatabase- Parameters:
category- e.g. "superfamily"- Returns:
- all records of this type
-
filterByClassificationId
Description copied from interface:ScopDatabaseGet all scop descriptions that start with a classification ID, e.g. b.1.18- Specified by:
filterByClassificationIdin interfaceScopDatabase- Returns:
- list of scop descriptions
-
getTree
Description copied from interface:ScopDatabaseget the SCOP sub-tree for a particular domain.- Specified by:
getTreein interfaceScopDatabase- Returns:
- list of ScopNodes providing the path to this domain
-
filterByDomainName
Description copied from interface:ScopDatabasesearch through SCOP and filter based on domain name- Specified by:
filterByDomainNamein interfaceScopDatabase- Parameters:
query- a (part) of a name- Returns:
- list of matchin ScopDomains
-
filterByDescription
Description copied from interface:ScopDatabaseGet all scop descriptions that start with a certain name. e.g. Globin- Specified by:
filterByDescriptionin interfaceScopDatabase- Returns:
- list of scop descriptions
-
getScopDescriptionBySunid
Description copied from interface:ScopDatabaseReturn the SCOP description for a node in the hierarchy by its "sunid" id.- Specified by:
getScopDescriptionBySunidin interfaceScopDatabase- Returns:
- a ScopDescription object
-
getDomainsForPDB
Description copied from interface:ScopDatabaseGet a list of ScopDomains that have been assigned to a PDB ID- Specified by:
getDomainsForPDBin interfaceScopDatabase- Parameters:
pdbId- the PDB entry- Returns:
- a list of ScopDomains
-
getDomainByScopID
Description copied from interface:ScopDatabaseget a ScopDomain by its SCOP ID (warning, they are not stable between releases!)- Specified by:
getDomainByScopIDin interfaceScopDatabase- Parameters:
scopId- e.g. d2bq6a1- Returns:
- a ScopDomain or null if no domain with the particular ID could be found
-
getScopNode
Description copied from interface:ScopDatabaseAccess a particular ScopNode. The scopNode then allows to traverse through the scop hierarchy...- Specified by:
getScopNodein interfaceScopDatabase- Parameters:
sunid- the scop unique id- Returns:
- a ScopNode that matches this sunid
-
getScopVersion
Description copied from interface:ScopDatabaseReturns the SCOP version- Specified by:
getScopVersionin interfaceScopDatabase- Returns:
- version of SCOP
-
setScopVersion
Description copied from interface:ScopDatabaseSets the scop version used.- Specified by:
setScopVersionin interfaceScopDatabase
-
getScopDomainsBySunid
Description copied from interface:ScopDatabaseGet a SCOP domain by its sunid- Specified by:
getScopDomainsBySunidin interfaceScopDatabase- Parameters:
sunid- the scop unique id- Returns:
- a list of scop domains that match this sunid
-
getComments
Description copied from interface:ScopDatabaseGet comments about a SCOP domain by its sunid- Specified by:
getCommentsin interfaceScopDatabase- Returns:
-