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;
022
023import java.io.IOException;
024import java.util.ArrayList;
025
026import org.biojava.nbio.structure.align.util.AtomCache;
027
028/**
029 * A stub StructureIdentifier, representing the full structure in all cases.
030 * @author Spencer Bliven
031 *
032 */
033public class PassthroughIdentifier implements StructureIdentifier {
034
035        private String identifier;
036        public PassthroughIdentifier(String identifier) {
037                this.identifier = identifier;
038        }
039        @Override
040        public String getIdentifier() {
041                return identifier;
042        }
043
044        /**
045         * @return A SubstructureIdentifier without ranges (e.g. including all residues)
046         */
047        @Override
048        public SubstructureIdentifier toCanonical() {
049                return new SubstructureIdentifier(null, new ArrayList<ResidueRange>());
050        }
051
052        @Override
053        public Structure reduce(Structure input) throws StructureException {
054                return input;
055        }
056        /**
057         * Passthrough identifiers don't know how to load a structure
058         * @return null
059         */
060        @Override
061        public Structure loadStructure(AtomCache cache) throws StructureException,
062                        IOException {
063                return null;
064        }
065
066}