neuroml.channel
Class ChannelML

java.lang.Object
  neuroml.channel.ChannelML

public class ChannelML
extends java.lang.Object

Root element containing the ions used in the channel mechanism, the unit system of the file (as attribute), and information on channels and/or ion concentration dynamics

Java class for ChannelML complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ChannelML">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://morphml.org/metadata/schema}metadata"/>
         <element name="ion" type="{http://morphml.org/channelml/schema}Ion" maxOccurs="unbounded" minOccurs="0"/>
         <element name="channel_type" type="{http://morphml.org/channelml/schema}ChannelType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="synapse_type" type="{http://morphml.org/channelml/schema}SynapseType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="ion_concentration" type="{http://morphml.org/channelml/schema}IonConcentration" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="units" use="required" type="{http://morphml.org/channelml/schema}Units" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected Annotation	annotation
protected java.util.List<ChannelType>	channelType
protected java.util.List<java.lang.String>	group
protected java.util.List<Ion>	ion
protected java.util.List<IonConcentration>	ionConcentration
protected java.lang.String	notes
protected Properties	properties
protected java.util.List<SynapseType>	synapseType
protected Units	units

Constructor Summary

ChannelML()

Method Summary

Annotation	getAnnotation() Gets the value of the annotation property.
java.util.List<ChannelType>	getChannelType() Gets the value of the channelType property.
ChannelType	getChannelTypeByName(java.lang.String name) Gets a channel type by name, or null if no such channel exists.
java.util.List<java.lang.String>	getGroup() Gets the value of the group property.
java.util.List<Ion>	getIon() Gets the value of the ion property.
Ion	getIonByName(java.lang.String name) Gets the Ion by name, or null if no such ion exists.
java.util.List<IonConcentration>	getIonConcentration() Gets the value of the ionConcentration property.
java.lang.String	getNotes() Gets the value of the notes property.
Properties	getProperties() Gets the value of the properties property.
java.util.List<SynapseType>	getSynapseType() Gets the value of the synapseType property.
Units	getUnits() Gets the value of the units property.
void	setAnnotation(Annotation value) Sets the value of the annotation property.
void	setNotes(java.lang.String value) Sets the value of the notes property.
void	setProperties(Properties value) Sets the value of the properties property.
void	setUnits(Units value) Sets the value of the units property.

Methods inherited from class java.lang.Object

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

Field Detail

notes

protected java.lang.String notes

properties

protected Properties properties

annotation

protected Annotation annotation

group

protected java.util.List<java.lang.String> group

ion

protected java.util.List<Ion> ion

channelType

protected java.util.List<ChannelType> channelType

synapseType

protected java.util.List<SynapseType> synapseType

ionConcentration

protected java.util.List<IonConcentration> ionConcentration

units

protected Units units

Constructor Detail

ChannelML

public ChannelML()

Method Detail

getNotes

public java.lang.String getNotes()

Gets the value of the notes property.

Returns:

possible object is String

setNotes

public void setNotes(java.lang.String value)

Sets the value of the notes property.

Parameters:

value - allowed object is String

getProperties

public Properties getProperties()

Gets the value of the properties property.

Returns:

possible object is Properties

setProperties

public void setProperties(Properties value)

Sets the value of the properties property.

Parameters:

value - allowed object is Properties

getAnnotation

public Annotation getAnnotation()

Gets the value of the annotation property.

Returns:

possible object is Annotation

setAnnotation

public void setAnnotation(Annotation value)

Sets the value of the annotation property.

Parameters:

value - allowed object is Annotation

getGroup

public java.util.List<java.lang.String> getGroup()

Gets the value of the group property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the group property.

For example, to add a new item, do as follows:

    getGroup().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getIon

public java.util.List<Ion> getIon()

Gets the value of the ion property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the ion property.

For example, to add a new item, do as follows:

    getIon().add(newItem);
 

Objects of the following type(s) are allowed in the list Ion

getChannelType

public java.util.List<ChannelType> getChannelType()

Gets the value of the channelType property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the channelType property.

For example, to add a new item, do as follows:

    getChannelType().add(newItem);
 

Objects of the following type(s) are allowed in the list ChannelType

getSynapseType

public java.util.List<SynapseType> getSynapseType()

Gets the value of the synapseType property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the synapseType property.

For example, to add a new item, do as follows:

    getSynapseType().add(newItem);
 

Objects of the following type(s) are allowed in the list SynapseType

getIonConcentration

public java.util.List<IonConcentration> getIonConcentration()

Gets the value of the ionConcentration property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the ionConcentration property.

For example, to add a new item, do as follows:

    getIonConcentration().add(newItem);
 

Objects of the following type(s) are allowed in the list IonConcentration

getUnits

public Units getUnits()

Gets the value of the units property.

Returns:

possible object is Units

setUnits

public void setUnits(Units value)

Sets the value of the units property.

Parameters:

value - allowed object is Units

getIonByName

public Ion getIonByName(java.lang.String name)

Gets the Ion by name, or null if no such ion exists.

getChannelTypeByName

public ChannelType getChannelTypeByName(java.lang.String name)

Gets a channel type by name, or null if no such channel exists.