Package org.ivoa.dm.caom2

Class Energy

java.lang.Object
org.ivoa.dm.caom2.Energy
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="caom2:Energy", role=objectType) public class Energy extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
description of the energy coverage and sampling of the data. objectType: Energy

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • bounds

      @VoDml(id="caom2:Energy.bounds", role=attribute, type="caom2:types.Interval", typeRole=dataType) protected Interval bounds
      simple outer bounds of energy coverage of the data (CHANGED cardinality in CAOM-2.5). : Attribute bounds : multiplicity 1

    • samples

      @VoDml(id="caom2:Energy.samples", role=composition, type="caom2:types.IntervalM", typeRole=objectType) protected List<IntervalM> samples
      detailed energy coverage of the data (CHANGED in CAOM-2.5). composition samples : ( Multiplicity : 1..* )

    • energyBands

      @VoDml(id="caom2:Energy.energyBands", role=attribute, type="caom2:EnergyBand", typeRole=enumeration) protected List<EnergyBand> energyBands
      standard name of the energy regime(s) included in the data. : Attribute energyBands : multiplicity 0..*

    • dimension

      @VoDml(id="caom2:Energy.dimension", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer dimension
      number of measurements (pixels) on the energy axis. : Attribute dimension : multiplicity 0..1

    • resolvingPower

      @VoDml(id="caom2:Energy.resolvingPower", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double resolvingPower
      mean spectral resolving power per pixel (relative resolution). : Attribute resolvingPower : multiplicity 0..1

    • resolvingPowerBounds

      @VoDml(id="caom2:Energy.resolvingPowerBounds", role=attribute, type="caom2:types.Interval", typeRole=dataType) protected Interval resolvingPowerBounds
      range of resolving power within the bounds (relative resolution). : Attribute resolvingPowerBounds : multiplicity 0..1

    • resolution

      @VoDml(id="caom2:Energy.resolution", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double resolution
      mean absolute spectral resolution per pixel (new in CAOM-2.5). : Attribute resolution : multiplicity 0..1

    • resolutionBounds

      @VoDml(id="caom2:Energy.resolutionBounds", role=attribute, type="caom2:types.Interval", typeRole=dataType) protected Interval resolutionBounds
      range of absolute spectral resolution within the bounds (new in CAOM-2.5). : Attribute resolutionBounds : multiplicity 0..1

    • sampleSize

      @VoDml(id="caom2:Energy.sampleSize", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double sampleSize
      mean pixel size. : Attribute sampleSize : multiplicity 0..1

    • bandpassName

      @VoDml(id="caom2:Energy.bandpassName", role=attribute, type="ivoa:string", typeRole=primitiveType) protected List<String> bandpassName
      telescope- and instrument-specific name for the energy band(s) included; multiple bands may be included if energies from all specified bands are included in the data (in the sense of union). : Attribute bandpassName : multiplicity 0..*

    • restwav

      @VoDml(id="caom2:Energy.restwav", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double restwav
      rest energy of the target energy transition (name changed in CAOM-2.5). : Attribute restwav : multiplicity 0..1

    • calibration

      @VoDml(id="caom2:Energy.calibration", role=attribute, type="caom2:CalibrationStatus", typeRole=dataType) protected CalibrationStatus calibration
      term describing the calibration of the energy axis values (new in CAOM-2.5). : Attribute calibration : multiplicity 0..1

    • transition

      @VoDml(id="caom2:Energy.transition", role=attribute, type="caom2:EnergyTransition", typeRole=dataType) protected EnergyTransition transition
      target energy transition for this data. : Attribute transition : multiplicity 0..1

  • Constructor Details

    • Energy

      public Energy()
      Creates a new Energy

    • Energy

      public Energy(Interval bounds, List<IntervalM> samples, List<EnergyBand> energyBands, Integer dimension, Double resolvingPower, Interval resolvingPowerBounds, Double resolution, Interval resolutionBounds, Double sampleSize, List<String> bandpassName, Double restwav, CalibrationStatus calibration, EnergyTransition transition)
      full parameter constructor.
      Parameters:
      bounds - simple outer bounds of energy coverage of the data (CHANGED cardinality in CAOM-2.5).
      samples - detailed energy coverage of the data (CHANGED in CAOM-2.5).
      energyBands - standard name of the energy regime(s) included in the data.
      dimension - number of measurements (pixels) on the energy axis.
      resolvingPower - mean spectral resolving power per pixel (relative resolution).
      resolvingPowerBounds - range of resolving power within the bounds (relative resolution).
      resolution - mean absolute spectral resolution per pixel (new in CAOM-2.5).
      resolutionBounds - range of absolute spectral resolution within the bounds (new in CAOM-2.5).
      sampleSize - mean pixel size.
      bandpassName - telescope- and instrument-specific name for the energy band(s) included; multiple bands may be included if energies from all specified bands are included in the data (in the sense of union).
      restwav - rest energy of the target energy transition (name changed in CAOM-2.5).
      calibration - term describing the calibration of the energy axis values (new in CAOM-2.5).
      transition - target energy transition for this data.

    • Energy

      public Energy(Energy other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

  • Method Details

    • getId

      public Long getId()
      Specified by:
      getId in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
      Returns:
      the id

    • updateUsing

      public void updateUsing(Energy other)
      Update this object with the content of the given object. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • getBounds

      public Interval getBounds()
      Returns bounds Attribute.
      Returns:
      bounds Attribute

    • setBounds

      public void setBounds(Interval pBounds)
      Set bounds Attribute.
      Parameters:
      pBounds - value to set

    • withBounds

      public Energy withBounds(Interval pBounds)
      fluent setter for bounds Attribute.
      Parameters:
      pBounds - value to set
      Returns:
      Energy

    • getSamples

      public List<IntervalM> getSamples()
      Returns samples composition as an immutable list.
      Returns:
      samples composition.

    • setSamples

      public void setSamples(List<IntervalM> pSamples)
      Defines whole samples composition.
      Parameters:
      pSamples - composition to set.

    • addToSamples

      public void addToSamples(IntervalM p)
      Add a org.ivoa.dm.caom2.types.IntervalM to the composition.
      Parameters:
      p - org.ivoa.dm.caom2.types.IntervalM to add

    • removeFromSamples

      public void removeFromSamples(IntervalM p)
      Remove a org.ivoa.dm.caom2.types.IntervalM from the composition.
      Parameters:
      p - org.ivoa.dm.caom2.types.IntervalM to remove

    • replaceInSamples

      public void replaceInSamples(IntervalM _p)
      update a org.ivoa.dm.caom2.types.IntervalM in the composition.
      Parameters:
      _p - org.ivoa.dm.caom2.types.IntervalM to update the match is done via the database key

    • getEnergyBands

      public List<EnergyBand> getEnergyBands()
      Returns energyBands Attribute.
      Returns:
      energyBands Attribute

    • setEnergyBands

      public void setEnergyBands(List<EnergyBand> pEnergyBands)
      Set energyBands Attribute.
      Parameters:
      pEnergyBands - value to set

    • withEnergyBands

      public Energy withEnergyBands(List<EnergyBand> pEnergyBands)
      fluent setter for energyBands Attribute.
      Parameters:
      pEnergyBands - value to set
      Returns:
      Energy

    • getDimension

      public Integer getDimension()
      Returns dimension Attribute.
      Returns:
      dimension Attribute

    • setDimension

      public void setDimension(Integer pDimension)
      Set dimension Attribute.
      Parameters:
      pDimension - value to set

    • withDimension

      public Energy withDimension(Integer pDimension)
      fluent setter for dimension Attribute.
      Parameters:
      pDimension - value to set
      Returns:
      Energy

    • getResolvingPower

      public Double getResolvingPower()
      Returns resolvingPower Attribute.
      Returns:
      resolvingPower Attribute

    • setResolvingPower

      public void setResolvingPower(Double pResolvingPower)
      Set resolvingPower Attribute.
      Parameters:
      pResolvingPower - value to set

    • withResolvingPower

      public Energy withResolvingPower(Double pResolvingPower)
      fluent setter for resolvingPower Attribute.
      Parameters:
      pResolvingPower - value to set
      Returns:
      Energy

    • getResolvingPowerBounds

      public Interval getResolvingPowerBounds()
      Returns resolvingPowerBounds Attribute.
      Returns:
      resolvingPowerBounds Attribute

    • setResolvingPowerBounds

      public void setResolvingPowerBounds(Interval pResolvingPowerBounds)
      Set resolvingPowerBounds Attribute.
      Parameters:
      pResolvingPowerBounds - value to set

    • withResolvingPowerBounds

      public Energy withResolvingPowerBounds(Interval pResolvingPowerBounds)
      fluent setter for resolvingPowerBounds Attribute.
      Parameters:
      pResolvingPowerBounds - value to set
      Returns:
      Energy

    • getResolution

      public Double getResolution()
      Returns resolution Attribute.
      Returns:
      resolution Attribute

    • setResolution

      public void setResolution(Double pResolution)
      Set resolution Attribute.
      Parameters:
      pResolution - value to set

    • withResolution

      public Energy withResolution(Double pResolution)
      fluent setter for resolution Attribute.
      Parameters:
      pResolution - value to set
      Returns:
      Energy

    • getResolutionBounds

      public Interval getResolutionBounds()
      Returns resolutionBounds Attribute.
      Returns:
      resolutionBounds Attribute

    • setResolutionBounds

      public void setResolutionBounds(Interval pResolutionBounds)
      Set resolutionBounds Attribute.
      Parameters:
      pResolutionBounds - value to set

    • withResolutionBounds

      public Energy withResolutionBounds(Interval pResolutionBounds)
      fluent setter for resolutionBounds Attribute.
      Parameters:
      pResolutionBounds - value to set
      Returns:
      Energy

    • getSampleSize

      public Double getSampleSize()
      Returns sampleSize Attribute.
      Returns:
      sampleSize Attribute

    • setSampleSize

      public void setSampleSize(Double pSampleSize)
      Set sampleSize Attribute.
      Parameters:
      pSampleSize - value to set

    • withSampleSize

      public Energy withSampleSize(Double pSampleSize)
      fluent setter for sampleSize Attribute.
      Parameters:
      pSampleSize - value to set
      Returns:
      Energy

    • getBandpassName

      public List<String> getBandpassName()
      Returns bandpassName Attribute.
      Returns:
      bandpassName Attribute

    • setBandpassName

      public void setBandpassName(List<String> pBandpassName)
      Set bandpassName Attribute.
      Parameters:
      pBandpassName - value to set

    • withBandpassName

      public Energy withBandpassName(List<String> pBandpassName)
      fluent setter for bandpassName Attribute.
      Parameters:
      pBandpassName - value to set
      Returns:
      Energy

    • getRestwav

      public Double getRestwav()
      Returns restwav Attribute.
      Returns:
      restwav Attribute

    • setRestwav

      public void setRestwav(Double pRestwav)
      Set restwav Attribute.
      Parameters:
      pRestwav - value to set

    • withRestwav

      public Energy withRestwav(Double pRestwav)
      fluent setter for restwav Attribute.
      Parameters:
      pRestwav - value to set
      Returns:
      Energy

    • getCalibration

      public CalibrationStatus getCalibration()
      Returns calibration Attribute.
      Returns:
      calibration Attribute

    • setCalibration

      public void setCalibration(CalibrationStatus pCalibration)
      Set calibration Attribute.
      Parameters:
      pCalibration - value to set

    • withCalibration

      public Energy withCalibration(CalibrationStatus pCalibration)
      fluent setter for calibration Attribute.
      Parameters:
      pCalibration - value to set
      Returns:
      Energy

    • getTransition

      public EnergyTransition getTransition()
      Returns transition Attribute.
      Returns:
      transition Attribute

    • setTransition

      public void setTransition(EnergyTransition pTransition)
      Set transition Attribute.
      Parameters:
      pTransition - value to set

    • withTransition

      public Energy withTransition(EnergyTransition pTransition)
      fluent setter for transition Attribute.
      Parameters:
      pTransition - value to set
      Returns:
      Energy

    • createEnergy

      public static Energy createEnergy(Consumer<Energy.EnergyBuilder> f)
      create a Energy in functional builder style.
      Parameters:
      f - the functional builder.
      Returns:
      an object initialized from the builder.

    • forceLoad

      public void forceLoad()
      Specified by:
      forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations

    • delete

      public void delete(jakarta.persistence.EntityManager em)
      Specified by:
      delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>