001/*
002 *                    BioJava development code
003 *
004 * This code may be freely distributed and modified under the
005 * terms of the GNU Lesser General Public Licence.  This should
006 * be distributed with the code.  If you do not have a copy,
007 * see:
008 *
009 *      http://www.gnu.org/copyleft/lesser.html
010 *
011 * Copyright for this code is held jointly by the individual
012 * authors.  These should be listed in @author doc comments.
013 *
014 * For more information on the BioJava project and its aims,
015 * or to join the biojava-l mailing list, visit the home page
016 * at:
017 *
018 *      http://www.biojava.org/
019 *
020 */
021package org.biojava.nbio.structure.domain;
022
023import java.io.IOException;
024import java.util.SortedSet;
025
026import org.biojava.nbio.structure.StructureException;
027
028/**
029 * Decomposes a structure from the PDB into representative domains
030 */
031public interface DomainProvider {
032
033        /**
034         * Get a list of constituent domain identifiers
035         * @param name a structure identifier
036         * @return A list of domain names
037         * @throws IOException For IO errors getting the domains
038         * @throws StructureException For errors converting name to a valid identifier
039         */
040        public SortedSet<String> getDomainNames(String name) throws IOException, StructureException;
041        /**
042         * Get the full list of representative domains for the PDB.
043         *
044         * The exact definition representatives is implementation-specific, but
045         * should cover as many structures as possible.
046         * @return A full list of all representative domains recognized by this provider
047         * @throws IOException For IO errors getting the representatives
048         */
049        public SortedSet<String> getRepresentativeDomains() throws IOException;
050}