ObservableGroup Class Reference

A grouping of several similar Observables. More...

Inheritance diagram for ObservableGroup:

[legend]

Collaboration diagram for ObservableGroup:

[legend]

List of all members.

Public Member Functions
	ObservableGroup ()
	Default constructor.
	ObservableGroup (String name)
	Named constructor.
String	getName ()
	Get name of observable class.
ObservableGroup	setName (String name)
	Set name of observable class.
String	getComment ()
	Get comment.
ObservableGroup	setComment (String comment)
	Set comment.
Set< Observable >	getObservables ()
ObservableGroup	setObservables (Set< Observable > observables)
ObservableGroup	addObservable (Observable observable)
ObservableGroup	removeObservable (Observable observable)
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 Observables.

Author:

Andy Buckley

Version:

Date

Revision

Definition at line 16 of file ObservableGroup.java.

---

Constructor & Destructor Documentation

ObservableGroup

(

)

Default constructor.

Definition at line 41 of file ObservableGroup.java.

{}

ObservableGroup

(

String

name

)

Named constructor.

Definition at line 44 of file ObservableGroup.java.

                                        {
        setName(name);
    }

---

Member Function Documentation

String getName

(

)

Get name of observable class.

Definition at line 52 of file ObservableGroup.java.

                            {
        return _name;
    }

ObservableGroup setName

(

String

name

)

Set name of observable class.

Definition at line 56 of file ObservableGroup.java.

                                                {
        _name = name;
        return this;
    }

String getComment

(

)

Get comment.

Definition at line 62 of file ObservableGroup.java.

                               {
        return _comment;
    }

ObservableGroup setComment

(

String

comment

)

Set comment.

Definition at line 66 of file ObservableGroup.java.

                                                      {
        _comment = comment;
        return this;
    }

Set<Observable> getObservables

(

)

Definition at line 73 of file ObservableGroup.java.

Referenced by Observable.addObservableGroup(), and Observable.removeObservableGroup().

                                            {
        return _observables;
    }

ObservableGroup setObservables

(

Set< Observable >

observables

)

Definition at line 76 of file ObservableGroup.java.

                                                                       {
        for (Observable o : getObservables()) removeObservable(o);
        for (Observable o : observables) addObservable(o);
        return this;
    }

ObservableGroup addObservable

(

Observable

observable

)

Definition at line 81 of file ObservableGroup.java.

References Observable.getObservableGroups().

                                                                {
        if (observable != null) {
            observable.getObservableGroups().add(this);
            getObservables().add(observable);
        } else {
            log().warn("Tried to add a null observable to an observable group");
        }
        return this;
    }

ObservableGroup removeObservable

(

Observable

observable

)

Definition at line 90 of file ObservableGroup.java.

References Observable.getObservableGroups().

                                                                   {
        if (observable != null) {
            observable.getObservableGroups().remove(this);
            getObservables().remove(observable);
        } else {
            log().warn("Tried to remove a null observable from an observable 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/ObservableGroup.java

---