AxisProperty Class Reference

An AxisProperty is an attribute of a YAxis. More...

Inheritance diagram for AxisProperty:

Collaboration diagram for AxisProperty:


Public Member Functions
	AxisProperty ()
	No-arg constructor.
	AxisProperty (String name)
	Useful constructor.
	AxisProperty (YAxis yAxis, String name)
	Useful constructor.
	AxisProperty (String name, Unit unit, Double lowValue, Double highValue)
	Really useful constructor.
	AxisProperty (YAxis yAxis, String name, Unit unit, Double lowValue, Double highValue)
	Really useful constructor.
YAxis	getYAxis ()
	Get parent y-axis.
AxisProperty	setYAxis (YAxis yAxis)
	Set parent y-axis.
Property	setValues (Unit unit, Double lowValue, Double highValue)
	Convenient way to set the unit and bounds at one go.
String	getName ()
	Get the name of this property.
Property	setName (String name)
	Set the name of this property.
Double	getLowValue ()
	Get the low bound on the property's value.
Property	setLowValue (Double lowValue)
	Set the low bound on the property's value.
Double	getHighValue ()
	Get the high bound on the property's value.
Property	setHighValue (Double highValue)
	Set the high bound on the property's value.
Unit	getUnit ()
	Get the unit in which this property is measured.
Property	setUnit (Unit unit)
	Set the unit in which this property is measured.
String	toString ()
	String representation.
Package Functions
.hibernate.annotations.	Type (type="cedar.hepdata.db.UnitUserType") private Unit _unit
	Units of property.
Logger	log ()
	Neat method to allow every class to get hold of a custom-named Logger.

Detailed Description

An AxisProperty is an attribute of a YAxis.

Author:: Andy Buckley

Version:

Date: 2006-11-01 15:51:43 +0000 (Wed, 01 Nov 2006)

Revision: 728

Definition at line 14 of file AxisProperty.java.

Constructor & Destructor Documentation

AxisProperty ( )

No-arg constructor.

Definition at line 24 of file AxisProperty.java.

00024 {}

AxisProperty ( String name )

Useful constructor.

Definition at line 27 of file AxisProperty.java.

00027                                      {
00028         super(name);
00029     }

AxisProperty	(	YAxis	yAxis,
		String	name
	)

Useful constructor.

Definition at line 32 of file AxisProperty.java.

00032                                                   {
00033         this(name);
00034         setYAxis(yAxis);
00035     }

AxisProperty	(	String	name,
		Unit	unit,
		Double	lowValue,
		Double	highValue
	)

Really useful constructor.

Definition at line 38 of file AxisProperty.java.

00038                                                                                    {
00039         super(name, unit, lowValue, highValue);
00040     }

AxisProperty	(	YAxis	yAxis,
		String	name,
		Unit	unit,
		Double	lowValue,
		Double	highValue
	)

Really useful constructor.

Definition at line 43 of file AxisProperty.java.

00043                                                                                                 {
00044         this(name, unit, lowValue, highValue);
00045         setYAxis(yAxis);
00046     }

Member Function Documentation

YAxis getYAxis ( )

Get parent y-axis.

Definition at line 53 of file AxisProperty.java.

00053                             {
00054         return _yAxis;
00055     }

AxisProperty setYAxis ( YAxis yAxis )

Set parent y-axis.

Definition at line 58 of file AxisProperty.java.

00058                                               {
00059         if (getYAxis() != null) getYAxis().getProperties().add(this);
00060         _yAxis = yAxis;
00061         return this;
00062     }

.hibernate.annotations. Type ( type = "cedar.hepdata.db.UnitUserType" ) [package, inherited]

Units of property.

Property setValues	(	Unit	unit,
		Double	lowValue,
		Double	highValue
	)			`[inherited]`

Convenient way to set the unit and bounds at one go.

Definition at line 61 of file Property.java.

00061                                                                             {
00062         setUnit(unit);
00063         setLowValue(lowValue);
00064         setHighValue(highValue);
00065         return this;
00066     }

String getName ( ) [inherited]

Get the name of this property.

Definition at line 73 of file Property.java.

00073                             {
00074         return _name;
00075     }

Property setName ( String name ) [inherited]

Set the name of this property.

Definition at line 78 of file Property.java.

00078                                          {
00079         _name = name;
00080         return this;
00081     }

Double getLowValue ( ) [inherited]

Get the low bound on the property's value.

Definition at line 85 of file Property.java.

00085                                 {
00086         return _lowValue;
00087     }

Property setLowValue ( Double lowValue ) [inherited]

Set the low bound on the property's value.

Definition at line 90 of file Property.java.

00090                                                  {
00091         _lowValue = lowValue;
00092         return this;
00093     }

Double getHighValue ( ) [inherited]

Get the high bound on the property's value.

Definition at line 97 of file Property.java.

00097                                  {
00098         return _highValue;
00099     }

Property setHighValue ( Double highValue ) [inherited]

Set the high bound on the property's value.

Definition at line 102 of file Property.java.

00102                                                    {
00103         _highValue = highValue;
00104         return this;
00105     }

Unit getUnit ( ) [inherited]

Get the unit in which this property is measured.

Definition at line 109 of file Property.java.

00109                           {
00110         return _unit;
00111     }

Property setUnit ( Unit unit ) [inherited]

Set the unit in which this property is measured.

Definition at line 114 of file Property.java.

00114                                        {
00115         _unit = unit;
00116         return this;
00117     }

String toString ( ) [inherited]

String representation.

Reimplemented from Storeable.

Definition at line 124 of file Property.java.

00124                              {
00125         StringBuffer s = new StringBuffer();
00126         s.append("(" + getLowValue() + "-" + getHighValue() + ") " + getUnit().toString());
00127         return s.toString();
00128     }

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().

00014                  {
00015         return Logger.getLogger(this.getClass());
00016     }

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

AxisProperty Class Reference

Public Member Functions

Package Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation