edu.mssm.crover.domain2d.rbdg.xml
Class Links

java.lang.Object
  |
  +--edu.mssm.crover.domain2d.rbdg.xml.Links
All Implemented Interfaces:
java.io.Serializable

public class Links
extends java.lang.Object
implements java.io.Serializable

Describes hyperlinks attached to various components of the diagram.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
Links()
           
 
Method Summary
 void addResidue(int index, Residue vResidue)
           
 void addResidue(Residue vResidue)
           
 void addSubunitRef(int index, SubunitRef vSubunitRef)
           
 void addSubunitRef(SubunitRef vSubunitRef)
           
 void clearResidue()
           
 void clearSubunitRef()
           
 java.util.Enumeration enumerateResidue()
           
 java.util.Enumeration enumerateSubunitRef()
           
 Residue[] getResidue()
           
 Residue getResidue(int index)
           
 int getResidueCount()
           
 SubunitRef[] getSubunitRef()
           
 SubunitRef getSubunitRef(int index)
           
 int getSubunitRefCount()
           
 boolean isValid()
           
 void marshal(org.xml.sax.DocumentHandler handler)
           
 void marshal(java.io.Writer out)
           
 boolean removeResidue(Residue vResidue)
           
 boolean removeSubunitRef(SubunitRef vSubunitRef)
           
 void setResidue(int index, Residue vResidue)
           
 void setResidue(Residue[] residueArray)
           
 void setSubunitRef(int index, SubunitRef vSubunitRef)
           
 void setSubunitRef(SubunitRef[] subunitRefArray)
           
static Links unmarshal(java.io.Reader reader)
           
 void validate()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Links

public Links()
Method Detail

addResidue

public void addResidue(Residue vResidue)
                throws java.lang.IndexOutOfBoundsException
Parameters:
vResidue -
java.lang.IndexOutOfBoundsException

addResidue

public void addResidue(int index,
                       Residue vResidue)
                throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vResidue -
java.lang.IndexOutOfBoundsException

addSubunitRef

public void addSubunitRef(SubunitRef vSubunitRef)
                   throws java.lang.IndexOutOfBoundsException
Parameters:
vSubunitRef -
java.lang.IndexOutOfBoundsException

addSubunitRef

public void addSubunitRef(int index,
                          SubunitRef vSubunitRef)
                   throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vSubunitRef -
java.lang.IndexOutOfBoundsException

clearResidue

public void clearResidue()

clearSubunitRef

public void clearSubunitRef()

enumerateResidue

public java.util.Enumeration enumerateResidue()

enumerateSubunitRef

public java.util.Enumeration enumerateSubunitRef()

getResidue

public Residue getResidue(int index)
                   throws java.lang.IndexOutOfBoundsException
Parameters:
index -
java.lang.IndexOutOfBoundsException

getResidue

public Residue[] getResidue()

getResidueCount

public int getResidueCount()

getSubunitRef

public SubunitRef getSubunitRef(int index)
                         throws java.lang.IndexOutOfBoundsException
Parameters:
index -
java.lang.IndexOutOfBoundsException

getSubunitRef

public SubunitRef[] getSubunitRef()

getSubunitRefCount

public int getSubunitRefCount()

isValid

public boolean isValid()

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
out -
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.DocumentHandler handler)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
handler -
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

removeResidue

public boolean removeResidue(Residue vResidue)
Parameters:
vResidue -

removeSubunitRef

public boolean removeSubunitRef(SubunitRef vSubunitRef)
Parameters:
vSubunitRef -

setResidue

public void setResidue(int index,
                       Residue vResidue)
                throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vResidue -
java.lang.IndexOutOfBoundsException

setResidue

public void setResidue(Residue[] residueArray)
Parameters:
residueArray -

setSubunitRef

public void setSubunitRef(int index,
                          SubunitRef vSubunitRef)
                   throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vSubunitRef -
java.lang.IndexOutOfBoundsException

setSubunitRef

public void setSubunitRef(SubunitRef[] subunitRefArray)
Parameters:
subunitRefArray -

unmarshal

public static Links unmarshal(java.io.Reader reader)
                       throws org.exolab.castor.xml.MarshalException,
                              org.exolab.castor.xml.ValidationException
Parameters:
reader -
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
org.exolab.castor.xml.ValidationException


Copyright @ 2003 Mount Sinai School of Medicine. All Rights Reserved.