org.proteinshader.structure.visitor
Class AminoAcidLabelVisitor

java.lang.Object
  org.proteinshader.structure.visitor.Visitor
      org.proteinshader.structure.visitor.AminoAcidLabelVisitor

public class AminoAcidLabelVisitor
extends Visitor

Traverses the AminoAcids of a Structure and builds a non-redundant list of residueIDs.

Constructor Summary

AminoAcidLabelVisitor()
Constructs an AminoAcidLabelVisitor.

Method Summary

void	clearList() Clears the list of labels.
List<String>	getAminoAcidLabels() Returns the list of non-redundant labels (AminoAcid residueIDs) that
void	visit(AminoAcid aminoAcid) Adds a residueID to the list of labels if it has not been seen before.

Methods inherited from class org.proteinshader.structure.visitor.Visitor

clear, includeAAHetAndWater, setDebug, setMode, setMode, setMode, setMode, setMode, setMode, setVisitSegments, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class java.lang.Object

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

Constructor Detail

AminoAcidLabelVisitor

public AminoAcidLabelVisitor()

Constructs an AminoAcidLabelVisitor.

Method Detail

clearList

public void clearList()

Clears the list of labels.

Also sets the mode to RegionMode.NO_REGIONS and ResidueMode.AMINO_ACIDS.

visit

public void visit(AminoAcid aminoAcid)
           throws VisitorException

Adds a residueID to the list of labels if it has not been seen before.

Overrides:

visit in class Visitor

Parameters:

aminoAcid - the AminoAcid to get a label from.

Throws:

VisitorException - if an error occurs during the traversal.

getAminoAcidLabels

public List<String> getAminoAcidLabels()

Returns the list of non-redundant labels (AminoAcid residueIDs) that

Returns:

The AminoAcid residueIDs as a list of Strings.