cedar.hepdata.model.Property

Property Class Reference

A Property is an abstract base class for the properties stored by YAxiss and Datasets. More...

Inheritance diagram for Property:

Inheritance graph
[legend]

Collaboration diagram for Property:

Collaboration graph
[legend]

List of all members.


Public Member Functions

 Property ()
 No-arg constructor.
 Property (String name)
 Useful constructor.
 Property (String name, Unit unit, Double lowValue, Double highValue)
 Really useful constructor.
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

A Property is an abstract base class for the properties stored by YAxiss and Datasets.

Todo:
Current implementation assumes that properties have continuous numeric values... other possibilities?
Author:
Andy Buckley
Version:
Date
Revision

Definition at line 16 of file Property.java.

Constructor & Destructor Documentation

Property (  ) 

No-arg constructor.

Definition at line 44 of file Property.java.

00044 {}

Property ( String  name  ) 

Useful constructor.

Definition at line 47 of file Property.java.

00047                                  {
00048         setName(name);
00049     }

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

Really useful constructor.

Definition at line 52 of file Property.java.

00052                                                                                {
00053         setName(name);
00054         setValues(unit, lowValue, highValue);
00055     }

Member Function Documentation

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

Units of property.

Property setValues ( Unit  unit,
Double  lowValue,
Double  highValue 
)

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

Definition at line 62 of file Property.java.

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

String getName (  ) 

Get the name of this property.

Definition at line 74 of file Property.java.

00074                             {
00075         return _name;
00076     }

Property setName ( String  name  ) 

Set the name of this property.

Definition at line 79 of file Property.java.

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

Double getLowValue (  ) 

Get the low bound on the property's value.

Definition at line 86 of file Property.java.

00086                                 {
00087         return _lowValue;
00088     }

Property setLowValue ( Double  lowValue  ) 

Set the low bound on the property's value.

Definition at line 91 of file Property.java.

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

Double getHighValue (  ) 

Get the high bound on the property's value.

Definition at line 98 of file Property.java.

00098                                  {
00099         return _highValue;
00100     }

Property setHighValue ( Double  highValue  ) 

Set the high bound on the property's value.

Definition at line 103 of file Property.java.

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

Unit getUnit (  ) 

Get the unit in which this property is measured.

Definition at line 110 of file Property.java.

00110                           {
00111         return _unit;
00112     }

Property setUnit ( Unit  unit  ) 

Set the unit in which this property is measured.

Definition at line 115 of file Property.java.

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

String toString (  ) 

String representation.

Reimplemented from Storeable.

Definition at line 125 of file Property.java.

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

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

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

The documentation for this class was generated from the following file:
Generated on Thu Sep 20 11:41:39 2007 by  doxygen 1.5.3