cedar.hepdata.model.DatasetProperty

DatasetProperty Class Reference

A DatasetProperty is an attribute of a Dataset. More...

Inheritance diagram for DatasetProperty:

Inheritance graph
[legend]

Collaboration diagram for DatasetProperty:

Collaboration graph
[legend]

List of all members.


Public Member Functions

 DatasetProperty ()
 No-arg constructor.
 DatasetProperty (String name)
 Useful constructor.
 DatasetProperty (Dataset dataset, String name)
 Useful constructor.
 DatasetProperty (String name, Unit unit, Double lowValue, Double highValue)
 Really useful constructor.
 DatasetProperty (Dataset dataset, String name, Unit unit, Double lowValue, Double highValue)
 Really useful constructor.
Dataset getDataset ()
DatasetProperty setDataset (Dataset dataset)
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 DatasetProperty is an attribute of a Dataset.

Author:
Andy Buckley
Version:
Date
Revision

Definition at line 14 of file DatasetProperty.java.

Constructor & Destructor Documentation

DatasetProperty (  ) 

No-arg constructor.

Definition at line 24 of file DatasetProperty.java.

00024 {}

DatasetProperty ( String  name  ) 

Useful constructor.

Definition at line 27 of file DatasetProperty.java.

00027                                         {
00028         super(name);
00029     }

DatasetProperty ( Dataset  dataset,
String  name 
)

Useful constructor.

Definition at line 32 of file DatasetProperty.java.

00032                                                          {
00033         this(name);
00034         setDataset(dataset);
00035     }

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

Really useful constructor.

Definition at line 38 of file DatasetProperty.java.

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

DatasetProperty ( Dataset  dataset,
String  name,
Unit  unit,
Double  lowValue,
Double  highValue 
)

Really useful constructor.

Definition at line 43 of file DatasetProperty.java.

00043                                                                                                        {
00044         this(name, unit, lowValue, highValue);
00045         setDataset(dataset);
00046     }

Member Function Documentation

Dataset getDataset (  ) 

Definition at line 53 of file DatasetProperty.java.

00053                                 {
00054         return _dataset;
00055     }

DatasetProperty setDataset ( Dataset  dataset  ) 

Definition at line 56 of file DatasetProperty.java.

00056                                                        {
00057         if (getDataset() != null) {
00058             getDataset().getProperties().add(this);
00059         }
00060         _dataset = dataset;
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 62 of file Property.java.

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

String getName (  )  [inherited]

Get the name of this property.

Definition at line 74 of file Property.java.

00074                             {
00075         return _name;
00076     }

Property setName ( String  name  )  [inherited]

Set the name of this property.

Definition at line 79 of file Property.java.

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

Double getLowValue (  )  [inherited]

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  )  [inherited]

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 (  )  [inherited]

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  )  [inherited]

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 (  )  [inherited]

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  )  [inherited]

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 (  )  [inherited]

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