org.sbml.jsbml.ext.groups

Enum Group.Kind

java.lang.Object

java.lang.Enum<Group.Kind>

org.sbml.jsbml.ext.groups.Group.Kind

All Implemented Interfaces:

Serializable, Comparable<Group.Kind>

Enclosing class:

Group

public static enum Group.Kind
extends Enum<Group.Kind>

This is a collection of possible values for the kind attribute within a Group.

Enum Constant Summary

Enum Constants

Enum Constant and Description
classification The group represents a class, and its members have an is-a relationship to the group.
collection The grouping is merely a collection for convenience, without an implied relationship between the members.
partonomy The group represents a collection of parts, and its members have a part-of relationship to the group.

Method Summary

Modifier and Type	Method and Description
static Group.Kind	valueOf(String name) Returns the enum constant of this type with the specified name.
static Group.Kind[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

classification

public static final Group.Kind classification

The group represents a class, and its members have an is-a relationship to the group. For example, the group could represent a type of molecule such as ATP, and the members could be species located in different compartments, thereby establishing that the species are pools of the same molecule in different locations.

partonomy

public static final Group.Kind partonomy

The group represents a collection of parts, and its members have a part-of relationship to the group. For example, the group could represent a cellular structure, and individual compartments could be made members of the group to indicate they represent subparts of that cellular structure

collection

public static final Group.Kind collection

The grouping is merely a collection for convenience, without an implied relationship between the members. For example, the group could be used to collect together multiple disparate components of a model—species, reactions, events—involved in a particular phenotype, and apply a common annotation rather than having to copy the same annotation to each component individually.

Method Detail

values

public static Group.Kind[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Group.Kind c : Group.Kind.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Group.Kind valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null