Axis Class Reference

An Axis is a property of a Dataset, containing a header and description and a set of either bins or points. More...

Inheritance diagram for Axis:

[legend]

Collaboration diagram for Axis:

[legend]

List of all members.

Public Member Functions
	Axis ()
	Default constructor.
	Axis (String header)
	Axis (String header, Unit unit)
String	getHeader ()
	Get the axis header.
Axis	setHeader (String header)
	Set the axis header.
Unit	getUnit ()
	Get the Unit in which values on this axis are measured.
Axis	setUnit (Unit unit)
	Set the Unit in which values on this axis are measured.
String	toString ()
	Do-nothing string representation of this axis: should be overridden.
Package Functions
.hibernate.annotations.	Type (type="cedar.hepdata.db.UnitUserType") private Unit _unit
	Unit which the points on this axis are measured in.
Logger	log ()
	Neat method to allow every class to get hold of a custom-named Logger.

---

Detailed Description

An Axis is a property of a Dataset, containing a header and description and a set of either bins or points.

XAxis and YAxis are concrete implementations. One Dataset may have multiple Axes. Every Axis has an associated Unit.

Author:

Andy Buckley

Version:

Date

2007-06-06 18:04:02 +0100 (Wed, 06 Jun 2007)

Revision

1002

Definition at line 18 of file Axis.java.

---

Constructor & Destructor Documentation

Axis

(

)

Default constructor.

Definition at line 38 of file Axis.java.

{}

Axis

(

String

header

)

Definition at line 40 of file Axis.java.

                               {
        this();
        setHeader(header);
    }

Axis	(	String	header,
		Unit	unit
	)

Definition at line 45 of file Axis.java.

                                          {
        this(header);
        setUnit(unit);
    }

---

Member Function Documentation

.hibernate.annotations. Type

(

type

= "cedar.hepdata.db.UnitUserType"

)

[package]

Unit which the points on this axis are measured in.

String getHeader

(

)

Get the axis header.

Definition at line 55 of file Axis.java.

                              {
        return _header;
    }

Axis setHeader

(

String

header

)

Set the axis header.

Definition at line 59 of file Axis.java.

                                         {
        _header = header;
        return this;
    }

Unit getUnit

(

)

Get the Unit in which values on this axis are measured.

Definition at line 66 of file Axis.java.

                          {
        return _unit;
    }

Axis setUnit

(

Unit

unit

)

Set the Unit in which values on this axis are measured.

Definition at line 71 of file Axis.java.

                                   {
        _unit = unit;
        return this;
    }

String toString

(

)

Do-nothing string representation of this axis: should be overridden.

Reimplemented from Storeable.

Reimplemented in XAxis, and YAxis.

Definition at line 81 of file Axis.java.

                             {
       return "";
    }

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