Package org.biojava.nbio.structure.ecod
Interface EcodDatabase
- All Known Implementing Classes:
EcodInstallation
public interface EcodDatabase
General API for interacting with ECOD.
- Author:
- Spencer Bliven
-
Method Summary
Modifier and TypeMethodDescriptionfilterByHierarchy
(String hierarchy) Get a list of domains within a particular level of the hierarchyGet all ECOD domainsgetDomainsById
(String ecodId) Get a particular ECOD domain by the domain ID (e.g.getDomainsForPdb
(String pdbId) Get a list of all ECOD domains for a particular PDB IDReturn the release version.
-
Method Details
-
getVersion
Return the release version.- Returns:
- version
- Throws:
IOException
-
getDomainsById
Get a particular ECOD domain by the domain ID (e.g. "e4hhbA1")- Parameters:
ecodId
-- Returns:
- Throws:
IOException
-
getDomainsForPdb
Get a list of all ECOD domains for a particular PDB ID- Parameters:
pdbId
-- Returns:
- the list of domains, or null if no matching domains were found
- Throws:
IOException
-
filterByHierarchy
Get a list of domains within a particular level of the hierarchy- Parameters:
hierarchy
- A dot-separated list giving the X-group, H-group, and/or T-group (e.g. "1.1" for all members of the RIFT-related H-group)- Returns:
- Throws:
IOException
-
getAllDomains
Get all ECOD domains- Returns:
- Throws:
IOException
-