Package org.biojava.nbio.structure.scop
Interface ScopDatabase
- All Known Subinterfaces:
LocalScopDatabase
- All Known Implementing Classes:
BerkeleyScopInstallation
,CachedRemoteScopInstallation
,RemoteScopInstallation
,ScopInstallation
public interface ScopDatabase
General API how to interact with SCOP
- Since:
- 3.0.2
- Author:
- Andreas Prlic
- See Also:
-
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.void
setScopVersion
(String version) Sets the scop version used.
-
Method Details
-
getByCategory
Get all records of a particular classification.- Parameters:
category
- e.g. "superfamily"- Returns:
- all records of this type
-
filterByClassificationId
Get all scop descriptions that start with a classification ID, e.g. b.1.18- Parameters:
query
-- Returns:
- list of scop descriptions
-
getTree
get the SCOP sub-tree for a particular domain.- Parameters:
domain
-- Returns:
- list of ScopNodes providing the path to this domain
-
filterByDomainName
search through SCOP and filter based on domain name- Parameters:
query
- a (part) of a name- Returns:
- list of matchin ScopDomains
-
filterByDescription
Get all scop descriptions that start with a certain name. e.g. Globin- Parameters:
query
-- Returns:
- list of scop descriptions
-
getScopDescriptionBySunid
Return the SCOP description for a node in the hierarchy by its "sunid" id.- Parameters:
sunid
-- Returns:
- a ScopDescription object
-
getDomainsForPDB
Get a list of ScopDomains that have been assigned to a PDB ID- Parameters:
pdbId
- the PDB entry- Returns:
- a list of ScopDomains
-
getDomainByScopID
get a ScopDomain by its SCOP ID (warning, they are not stable between releases!)- Parameters:
scopId
- e.g. d2bq6a1- Returns:
- a ScopDomain or null if no domain with the particular ID could be found
-
getScopNode
Access a particular ScopNode. The scopNode then allows to traverse through the scop hierarchy...- Parameters:
sunid
- the scop unique id- Returns:
- a ScopNode that matches this sunid
-
getScopVersion
String getScopVersion()Returns the SCOP version- Returns:
- version of SCOP
-
setScopVersion
Sets the scop version used.- Parameters:
version
-- Throws:
UnsupportedOperationException
- If the version cannot be changed
-
getScopDomainsBySunid
Get a SCOP domain by its sunid- Parameters:
sunid
- the scop unique id- Returns:
- a list of scop domains that match this sunid
-
getComments
Get comments about a SCOP domain by its sunid- Parameters:
sunid
-- Returns:
-