Package org.biojava.nbio.structure.align

Class StructureAlignmentFactory

java.lang.Object

org.biojava.nbio.structure.align.StructureAlignmentFactory

public class StructureAlignmentFactory
extends Object

Constructor Summary

Constructors

Constructor	Description
StructureAlignmentFactory()

Method Summary

Modifier and Type	Method	Description
static void	addAlgorithm(StructureAlignment alg)	Adds a new StructureAlignment algorithm to the list.
static void	clearAlgorithms()	Removes all algorithms from the list
static StructureAlignment	getAlgorithm(String name)
static String[]	getAllAlgorithmNames()
static StructureAlignment[]	getAllAlgorithms()
static boolean	removeAlgorithm(String name)	Removes the specified algorithm from the list of options

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StructureAlignmentFactory

public StructureAlignmentFactory()

Method Details

addAlgorithm

public static void addAlgorithm(StructureAlignment alg)

Adds a new StructureAlignment algorithm to the list. Only one instance is stored for each algorithmName, so it is possible that a different instance may be returned by getAlgorithm(alg.getAlgorithmName())

Parameters:

alg - the alignment algorithm

removeAlgorithm

public static boolean removeAlgorithm(String name)

Removes the specified algorithm from the list of options

Parameters:

name - the name of the algorithm to remove

Returns:

true if the specified algorithm was found and removed

clearAlgorithms

public static void clearAlgorithms()

Removes all algorithms from the list

getAlgorithm

public static StructureAlignment getAlgorithm(String name)
                                       throws StructureException

Throws:

StructureException

getAllAlgorithms

public static StructureAlignment[] getAllAlgorithms()

getAllAlgorithmNames

public static String[] getAllAlgorithmNames()