peakml.io
Class Vocabulary.Term

java.lang.Object
  peakml.io.Vocabulary.Term

Enclosing class:

Vocabulary

public static class Vocabulary.Term
extends java.lang.Object

This class is a simple implementation, which keeps track of a single term in a controlled vocabulary.

Field Summary

java.util.Vector<java.lang.String>	alt_id Vector with all the alternative id's for this term.
java.lang.String	definition A free-text description of the term.
java.lang.String	id The unique id of the term.
java.util.Vector<java.lang.String>	is_a Vector with all the parents of this term.
boolean	is_obsolete Indicates whether this term is obsolete.
java.lang.String	name The name describing the term.

Constructor Summary

Vocabulary.Term(java.lang.String id, java.lang.String name, java.lang.String definition, java.util.Vector<java.lang.String> is_a, java.util.Vector<java.lang.String> alt_id, boolean is_obsolete)
Constructs a new term with the given parameters.

Method Summary

domsax.XmlAttribute[]	toCVParam()
domsax.XmlAttribute[]	toCVParam(java.lang.String value) Creates the xml-attributes needed for a cvParam element in the mzML standard.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id

public final java.lang.String id

The unique id of the term.

name

public final java.lang.String name

The name describing the term.

definition

public final java.lang.String definition

A free-text description of the term.

is_a

public final java.util.Vector<java.lang.String> is_a

Vector with all the parents of this term. Multiple inheritance is allowed.

alt_id

public final java.util.Vector<java.lang.String> alt_id

Vector with all the alternative id's for this term.

is_obsolete

public final boolean is_obsolete

Indicates whether this term is obsolete.

Constructor Detail

Vocabulary.Term

public Vocabulary.Term(java.lang.String id,
                       java.lang.String name,
                       java.lang.String definition,
                       java.util.Vector<java.lang.String> is_a,
                       java.util.Vector<java.lang.String> alt_id,
                       boolean is_obsolete)

Constructs a new term with the given parameters.

Parameters:

id - The unique id for this term.

name - The name of the term.

definition - The definition (free-text description) of the term.

is_a - Vector containing the id's of all the parents of this term.

alt_id - Vector containing alternative id's for this term.

is_obsolete - Boolean indicating whether this term is obsolete.

Method Detail

toCVParam

public domsax.XmlAttribute[] toCVParam()

See Also:

toCVParam(String)

toCVParam

public domsax.XmlAttribute[] toCVParam(java.lang.String value)

Creates the xml-attributes needed for a cvParam element in the mzML standard. Basically this is a convenience method and up for transfer to mzML writer.

Parameters:

value - An optional value with the value for the value attribute.

Returns:

An array containing all the xml-attributes.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object