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.symmetry.internal;
022
023import org.biojava.nbio.structure.Atom;
024import org.biojava.nbio.structure.align.model.AFPChain;
025
026/**
027 * A method to decide the order of symmetry (number of subunits)
028 * given a structure self-alignment, calculated by CE-Symm.
029 *
030 * @author dmyersturnbull
031 * @since 4.2.0
032 *
033 */
034public interface OrderDetector {
035
036        public int calculateOrder(AFPChain afpChain, Atom[] ca)
037                        throws RefinerFailedException;
038
039}