Class RemoteDomainProvider
- java.lang.Object
-
- org.biojava.nbio.structure.domain.SerializableCache<java.lang.String,java.util.SortedSet<java.lang.String>>
-
- org.biojava.nbio.structure.domain.RemoteDomainProvider
-
- All Implemented Interfaces:
DomainProvider
public class RemoteDomainProvider extends SerializableCache<java.lang.String,java.util.SortedSet<java.lang.String>> implements DomainProvider
A DomainProvider that uses a mixture of SCOP and PDP domains. SCOP domains are preferred, with PDP providing a backup for structures where SCOP has not been assigned. As of 2015, this class is equivalent to the method used by RCSB to define representatives for structural similarity comparisons.
-
-
Field Summary
Fields Modifier and Type Field Description java.lang.String
url
-
Fields inherited from class org.biojava.nbio.structure.domain.SerializableCache
cacheFileName, serializedCache
-
-
Constructor Summary
Constructors Constructor Description RemoteDomainProvider()
RemoteDomainProvider(boolean cache)
initialize this provider with caching enabled
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
flushCache()
java.util.SortedSet<java.lang.String>
getDomainNames(java.lang.String name)
Get a list of constituent domain identifiersjava.util.SortedSet<java.lang.String>
getRepresentativeDomains()
Get the full list of representative domains for the PDB.static void
main(java.lang.String[] args)
-
Methods inherited from class org.biojava.nbio.structure.domain.SerializableCache
cache, disableCache, enableCache, get, isCacheEnabled, reloadFromFile
-
-
-
-
Method Detail
-
getDomainNames
public java.util.SortedSet<java.lang.String> getDomainNames(java.lang.String name) throws java.io.IOException, StructureException
Description copied from interface:DomainProvider
Get a list of constituent domain identifiers- Specified by:
getDomainNames
in interfaceDomainProvider
- Parameters:
name
- a structure identifier- Returns:
- A list of domain names
- Throws:
java.io.IOException
- For IO errors getting the domainsStructureException
- For errors converting name to a valid identifier
-
main
public static void main(java.lang.String[] args) throws java.io.IOException, StructureException
- Throws:
java.io.IOException
StructureException
-
flushCache
public void flushCache()
- Overrides:
flushCache
in classSerializableCache<java.lang.String,java.util.SortedSet<java.lang.String>>
-
getRepresentativeDomains
public java.util.SortedSet<java.lang.String> getRepresentativeDomains() throws java.io.IOException
Description copied from interface:DomainProvider
Get the full list of representative domains for the PDB. The exact definition representatives is implementation-specific, but should cover as many structures as possible.- Specified by:
getRepresentativeDomains
in interfaceDomainProvider
- Returns:
- A full list of all representative domains recognized by this provider
- Throws:
java.io.IOException
- For IO errors getting the representatives
-
-