Experiment Class Reference

An experiment which collected some data stored in the database. More...

Inheritance diagram for Experiment:

[legend]

Collaboration diagram for Experiment:

[legend]

List of all members.

Public Member Functions
	Experiment ()
	Default constructor.
	Experiment (String name)
	Named constructor.
	Experiment (String name, String informalName)
	Constructor which specifies both the formal and informal expt names.
String	getName ()
	Get the experiment name.
Experiment	setName (String name)
	Set the experiment name.
String	getInformalName ()
	Get the informal name for this experiment.
Experiment	setInformalName (String informalName)
	Set the informal name for this experiment.
String	getCollider ()
	Get the associated collider.
Experiment	setCollider (String collider)
	Set the associated collider.
String	getLaboratory ()
	Get associated laboratory.
Experiment	setLaboratory (String laboratory)
	Set associated laboratory.
String	getComment ()
Experiment	setComment (String comment)
int	compareTo (Experiment other)
boolean	equals (Object other)
int	hashCode ()
String	toString ()
	String representation.
Package Functions
Logger	log ()
	Neat method to allow every class to get hold of a custom-named Logger.

---

Detailed Description

An experiment which collected some data stored in the database.

This object is specifically the particular run of an experiment, associated with a period of institutional funding, so for example CDF Run 1 and CDF Run 2 are different experiments in this scheme, as are NA48, NA482a, etc.

Author:

Andy Buckley

Version:

Date

2007-09-25 15:44:34 +0100 (Tue, 25 Sep 2007)

Revision

1077

Definition at line 18 of file Experiment.java.

---

Constructor & Destructor Documentation

Experiment

(

)

Default constructor.

Definition at line 46 of file Experiment.java.

{ }

Experiment

(

String

name

)

Named constructor.

Definition at line 50 of file Experiment.java.

References Experiment.setName().

                                   {
        this();
        setName(name);
    }

Experiment	(	String	name,
		String	informalName
	)

Constructor which specifies both the formal and informal expt names.

Definition at line 57 of file Experiment.java.

References Experiment.setInformalName().

                                                        {
        this(name);
        setInformalName(informalName);
    }

---

Member Function Documentation

String getName

(

)

Get the experiment name.

Definition at line 67 of file Experiment.java.

Referenced by Experiment.compareTo(), Experiment.hashCode(), and Experiment.toString().

                            {
        return _name;
    }

Experiment setName

(

String

name

)

Set the experiment name.

Definition at line 71 of file Experiment.java.

Referenced by Experiment.Experiment().

                                           {
        _name = name;
        return this;
    }

String getInformalName

(

)

Get the informal name for this experiment.

Definition at line 78 of file Experiment.java.

Referenced by Experiment.hashCode().

                                    {
        return _informalName;
    }

Experiment setInformalName

(

String

informalName

)

Set the informal name for this experiment.

Definition at line 82 of file Experiment.java.

Referenced by Experiment.Experiment().

                                                           {
        _informalName = informalName;
        return this;
    }

String getCollider

(

)

Get the associated collider.

Definition at line 89 of file Experiment.java.

Referenced by Experiment.hashCode().

                                {
        return _collider;
    }

Experiment setCollider

(

String

collider

)

Set the associated collider.

Definition at line 93 of file Experiment.java.

                                                   {
        _collider = collider;
        return this;
    }

String getLaboratory

(

)

Get associated laboratory.

Definition at line 100 of file Experiment.java.

Referenced by Experiment.hashCode().

                                  {
        return _laboratory;
    }

Experiment setLaboratory

(

String

laboratory

)

Set associated laboratory.

Definition at line 104 of file Experiment.java.

                                                       {
        _laboratory = laboratory;
        return this;
    }

String getComment

(

)

Definition at line 111 of file Experiment.java.

Referenced by Experiment.hashCode(), and Experiment.toString().

                               {
        return _comment;
    }

Experiment setComment

(

String

comment

)

Definition at line 114 of file Experiment.java.

Referenced by Data.makeExampleExperiment().

                                                 {
        _comment = comment;
        return this;
    }

int compareTo

(

Experiment

other

)

Definition at line 123 of file Experiment.java.

References Experiment.getName(), and Storeable.log().

                                           {
        log().debug("Comparing experiments...");
        return getName().compareTo(other.getName());
    }

boolean equals

(

Object

other

)

Definition at line 129 of file Experiment.java.

References Experiment.hashCode().

                                        {
        if (this == other) return true;
        if (! (other instanceof Experiment)) return false;
        return hashCode() == other.hashCode();
    }

int hashCode

(

)

Definition at line 136 of file Experiment.java.

References Experiment.getCollider(), Experiment.getComment(), Experiment.getInformalName(), Experiment.getLaboratory(), and Experiment.getName().

Referenced by Experiment.equals().

                          {
        int code = 61;
        if (getName() != null)         code ^= getName().hashCode();
        if (getInformalName() != null) code ^= getInformalName().hashCode();
        if (getCollider() != null)     code ^= getCollider().hashCode();
        if (getLaboratory() != null)   code ^= getLaboratory().hashCode();
        if (getComment() != null)      code ^= getComment().hashCode();
        return code;
    }

String toString

(

)

String representation.

Reimplemented from Storeable.

Definition at line 151 of file Experiment.java.

References Experiment.getComment(), and Experiment.getName().

                             {
        StringBuffer s = new StringBuffer();
        s.append("Experiment: " + getName() + "\n");
        s.append("  Comment: " + getComment() + "\n");
        return s.toString();
    }

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(), AxisError.setAxis(), DatasetError.setDataset(), DatasetError.setNormType(), PointError.setPoint(), and Uncertainty.toString().

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

---

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/Experiment.java