ReactionGroup Class Reference

A grouping of several similar Reactions. More...

Inheritance diagram for ReactionGroup:

[legend]

Collaboration diagram for ReactionGroup:

[legend]

List of all members.

Public Member Functions
	ReactionGroup ()
	Default constructor.
	ReactionGroup (String name)
	Constructor with a name.
String	getName ()
	Get name of reaction group.
ReactionGroup	setName (String name)
	Set name of reaction group.
String	getComment ()
	Get comment.
ReactionGroup	setComment (String comment)
	Set comment.
Set< Reaction >	getReactions ()
ReactionGroup	setReactions (Set< Reaction > reactions)
ReactionGroup	addReaction (Reaction reaction)
ReactionGroup	removeReaction (Reaction reaction)
String	toString ()
	Default String representation: declares that method is not properly defined by default.
Package Functions
Logger	log ()
	Neat method to allow every class to get hold of a custom-named Logger.

---

Detailed Description

A grouping of several similar Reactions.

Author:

Andy Buckley

Version:

Date

Revision

Definition at line 16 of file ReactionGroup.java.

---

Constructor & Destructor Documentation

ReactionGroup

(

)

Default constructor.

Definition at line 42 of file ReactionGroup.java.

{}

ReactionGroup

(

String

name

)

Constructor with a name.

Definition at line 45 of file ReactionGroup.java.

                                      {
        setName(name);
    }

---

Member Function Documentation

String getName

(

)

Get name of reaction group.

Definition at line 54 of file ReactionGroup.java.

                            {
        return _name;
    }

ReactionGroup setName

(

String

name

)

Set name of reaction group.

Definition at line 58 of file ReactionGroup.java.

                                              {
        _name = name;
        return this;
    }

String getComment

(

)

Get comment.

Definition at line 65 of file ReactionGroup.java.

                               {
        return _comment;
    }

ReactionGroup setComment

(

String

comment

)

Set comment.

Definition at line 69 of file ReactionGroup.java.

                                                    {
        _comment = comment;
        return this;
    }

Set<Reaction> getReactions

(

)

Definition at line 76 of file ReactionGroup.java.

Referenced by Reaction.addReactionGroup(), and Reaction.removeReactionGroup().

                                        {
        return _reactions;
    }

ReactionGroup setReactions

(

Set< Reaction >

reactions

)

Definition at line 79 of file ReactionGroup.java.

                                                               {
        for (Reaction r : getReactions()) removeReaction(r);
        for (Reaction r : reactions) addReaction(r);
        return this;
    }

ReactionGroup addReaction

(

Reaction

reaction

)

Definition at line 84 of file ReactionGroup.java.

References Reaction.getReactionGroups().

                                                        {
        if (reaction != null) {
            reaction.getReactionGroups().add(this);
            getReactions().add(reaction);
        } else {
            log().warn("Tried to add a null reaction to a reaction group");
        }
        return this;
    }

ReactionGroup removeReaction

(

Reaction

reaction

)

Definition at line 93 of file ReactionGroup.java.

References Reaction.getReactionGroups().

                                                           {
        if (reaction != null) {
            reaction.getReactionGroups().remove(this);
            getReactions().remove(reaction);
        } else {
            log().warn("Tried to remove a null reaction from a reaction group");
        }
        return this;
    }

Logger log

(

)

[package, inherited]

Neat method to allow every class to get hold of a custom-named Logger.

Definition at line 14 of file Storeable.java.

Referenced by Uncertainty.compareTo(), Reference.compareTo(), PointError.compareTo(), Modification.compareTo(), Experiment.compareTo(), DatasetError.compareTo(), AxisError.compareTo(), Data.makeExample(), Data.makeExampleDataset(), Data.makeExampleExperiment(), Data.makeExamplePaper(), Data.makeExampleXAxes(), Data.makeExampleYAxes(), DatasetError.setNormType(), and Uncertainty.toString().

                 {
        return Logger.getLogger(this.getClass());
    }

String toString

(

)

[inherited]

Default String representation: declares that method is not properly defined by default.

Reimplemented in Axis, Bin, Data, Dataset, Experiment, Modification, Paper, Particle, Point, Property, Reaction, Reference, Uncertainty, XAxis, and YAxis.

Definition at line 19 of file Storeable.java.

                             {
        StringBuffer s = new StringBuffer();
        s.append(this.getClass().getName() + ".toString() is not overloaded.");
        return s.toString();
    }

---

The documentation for this class was generated from the following file:

• /home/buckley/hepdata/codedocs/src/hepdata/hepdata-model/src/main/java/cedar/hepdata/model/ReactionGroup.java

---