Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> biomage >> [ Protocol overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.biomage.Protocol
Class Parameterizable  

java.lang.Object
  org.biomage.Common.Extendable
      org.biomage.Common.Describable
          org.biomage.Common.Identifiable
              org.biomage.Protocol.Parameterizable

All Implemented Interfaces:

org.biomage.Interface.HasAuditTrail, org.biomage.Interface.HasDescriptions, org.biomage.Interface.HasParameterTypes, org.biomage.Interface.HasPropertySets, org.biomage.Interface.HasSecurity, java.io.Serializable

Direct Known Subclasses:

Hardware, Protocol, Software

---

public abstract class Parameterizable

extends org.biomage.Common.Identifiable

implements java.io.Serializable, org.biomage.Interface.HasParameterTypes

The Parameterizable interface encapsulates the association of Parameters with ParameterValues.

---

Nested Class Summary

 

Nested classes inherited from class org.biomage.Interface.HasParameterTypes

org.biomage.Interface.HasParameterTypes.ParameterTypes_list

 

Nested classes inherited from class org.biomage.Interface.HasAuditTrail

org.biomage.Interface.HasAuditTrail.AuditTrail_list

 

Nested classes inherited from class org.biomage.Interface.HasDescriptions

org.biomage.Interface.HasDescriptions.Descriptions_list

 

Nested classes inherited from class org.biomage.Interface.HasPropertySets

org.biomage.Interface.HasPropertySets.PropertySets_list

 

Field Summary
private  org.biomage.Interface.HasParameterTypes.ParameterTypes_list	parameterTypes           The description of the parameters for the Parameterizable class instance.
(package private)  java.lang.String	URI           Where an instantiated Parameterizable is located.

 

Fields inherited from class org.biomage.Common.Identifiable

 

Fields inherited from class org.biomage.Common.Describable

 

Fields inherited from class org.biomage.Common.Extendable

 

Constructor Summary

Parameterizable()           Default constructor.

Parameterizable(org.xml.sax.Attributes atts)           Attribute constructor.

 

Method Summary
void	addToParameterTypes(int position, Parameter parameter)           Method to add Parameter at position to ParameterTypes_list
void	addToParameterTypes(Parameter parameter)           Method to add Parameter to ParameterTypes_list
Parameter	getFromParameterTypes(int position)           Method to get Parameter from ParameterTypes_list
org.biomage.Interface.HasParameterTypes.ParameterTypes_list	getParameterTypes()           Get method for parameterTypes
java.lang.String	getURI()           Get method for URI
void	removeElementAtFromParameterTypes(int position)           Method to remove by position from ParameterTypes_list
void	removeFromParameterTypes(Parameter parameter)           Method to remove first Parameter from ParameterTypes_list
void	setParameterTypes(org.biomage.Interface.HasParameterTypes.ParameterTypes_list parameterTypes)           Set method for parameterTypes
void	setURI(java.lang.String URI)           Set method for URI
void	writeAssociations(java.io.Writer out)           writeAssociations
void	writeAttributes(java.io.Writer out)           writeAttributes
void	writeMAGEML(java.io.Writer out)           writeMAGEML

 

Methods inherited from class org.biomage.Common.Identifiable

getIdentifier, getName, setIdentifier, setName

 

Methods inherited from class org.biomage.Common.Describable

addToAuditTrail, addToAuditTrail, addToDescriptions, addToDescriptions, getAuditTrail, getDescriptions, getFromAuditTrail, getFromDescriptions, getSecurity, removeElementAtFromAuditTrail, removeElementAtFromDescriptions, removeFromAuditTrail, removeFromDescriptions, setAuditTrail, setDescriptions, setSecurity

 

Methods inherited from class org.biomage.Common.Extendable

addToPropertySets, addToPropertySets, getFromPropertySets, getPropertySets, removeElementAtFromPropertySets, removeFromPropertySets, setPropertySets

 

Methods inherited from class java.lang.Object

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

 

Field Detail

URI

java.lang.String URI

Where an instantiated Parameterizable is located.

---

parameterTypes

private org.biomage.Interface.HasParameterTypes.ParameterTypes_list parameterTypes

The description of the parameters for the Parameterizable class instance.

Constructor Detail

Parameterizable

public Parameterizable()

Default constructor.

---

Parameterizable

public Parameterizable(org.xml.sax.Attributes atts)

Attribute constructor. Looks up the attributes in the parameter and casts them from strings appropriately

Method Detail

writeMAGEML

public void writeMAGEML(java.io.Writer out)
                 throws java.io.IOException

writeMAGEML

This method is responsible for assembling the attribute and association data into XML. It creates the object tag and then calls the writeAttributes and writeAssociation methods.

---

writeAttributes

public void writeAttributes(java.io.Writer out)
                     throws java.io.IOException

writeAttributes

This method is responsible for assembling the attribute data into XML. It calls the super method to write out all attributes of this class and it's ancestors.

---

writeAssociations

public void writeAssociations(java.io.Writer out)
                       throws java.io.IOException

writeAssociations

This method is responsible for assembling the association data into XML. It calls the super method to write out all associations of this class's ancestors.

---

setURI

public void setURI(java.lang.String URI)

Set method for URI

---

getURI

public java.lang.String getURI()

Get method for URI

---

setParameterTypes

public void setParameterTypes(org.biomage.Interface.HasParameterTypes.ParameterTypes_list parameterTypes)

Set method for parameterTypes

Specified by:

setParameterTypes in interface org.biomage.Interface.HasParameterTypes

---

getParameterTypes

public org.biomage.Interface.HasParameterTypes.ParameterTypes_list getParameterTypes()

Get method for parameterTypes

Specified by:

getParameterTypes in interface org.biomage.Interface.HasParameterTypes

---

addToParameterTypes

public void addToParameterTypes(Parameter parameter)

Method to add Parameter to ParameterTypes_list

Specified by:

addToParameterTypes in interface org.biomage.Interface.HasParameterTypes

---

addToParameterTypes

public void addToParameterTypes(int position,
                                Parameter parameter)

Method to add Parameter at position to ParameterTypes_list

Specified by:

addToParameterTypes in interface org.biomage.Interface.HasParameterTypes

---

getFromParameterTypes

public Parameter getFromParameterTypes(int position)

Method to get Parameter from ParameterTypes_list

Specified by:

getFromParameterTypes in interface org.biomage.Interface.HasParameterTypes

---

removeElementAtFromParameterTypes

public void removeElementAtFromParameterTypes(int position)

Method to remove by position from ParameterTypes_list

Specified by:

removeElementAtFromParameterTypes in interface org.biomage.Interface.HasParameterTypes

---

removeFromParameterTypes

public void removeFromParameterTypes(Parameter parameter)

Method to remove first Parameter from ParameterTypes_list

Specified by:

removeFromParameterTypes in interface org.biomage.Interface.HasParameterTypes

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> biomage >> [ Protocol overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---