Package org.ivoa.dm.caom2

Class Position

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

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • bounds

      @VoDml(id="caom2:Position.bounds", role=composition, type="caom2:types.Shape", typeRole=objectType) protected Shape bounds
      spatial boundary that includes the data (CHANGED cardinality in CAOM-2.5). composition bounds : ( Multiplicity : 1 )

    • samples

      @VoDml(id="caom2:Position.samples", role=composition, type="caom2:types.MultiShape", typeRole=objectType) protected MultiShape samples
      detailed sub-samples of the bounds (CHANGED in CAOM-2.5). composition samples : ( Multiplicity : 1 )

    • minBounds

      @VoDml(id="caom2:Position.minBounds", role=composition, type="caom2:types.Shape", typeRole=objectType) protected Shape minBounds
      minimum spatial boundary that includes the data; this value is smaller than the bounds (maximum) when the field-of-view varies because it is dependent on another axis (usually energy) (new in CAOM-2.5). composition minBounds : ( Multiplicity : 0..1 )

    • dimension

      @VoDml(id="caom2:Position.dimension", role=attribute, type="caom2:types.Dimension2D", typeRole=dataType) protected Dimension2D dimension
      number of separate measurements (pixels) along each axis. : Attribute dimension : multiplicity 0..1

    • maxRecoverableScale

      @VoDml(id="caom2:Position.maxRecoverableScale", role=attribute, type="caom2:types.Interval", typeRole=dataType) protected Interval maxRecoverableScale
      maximum size of spatial structure (signal) that can be recovered or seen in the data (new in CAOM-2.5). : Attribute maxRecoverableScale : multiplicity 0..1

    • resolution

      @VoDml(id="caom2:Position.resolution", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double resolution
      mean spatial resolution (full-width-half-max) per pixel. : Attribute resolution : multiplicity 0..1

    • resolutionBounds

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

    • sampleSize

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

    • calibration

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

  • Constructor Details

    • Position

      public Position()
      Creates a new Position

    • Position

      public Position(Shape bounds, MultiShape samples, Shape minBounds, Dimension2D dimension, Interval maxRecoverableScale, Double resolution, Interval resolutionBounds, Double sampleSize, CalibrationStatus calibration)
      full parameter constructor.
      Parameters:
      bounds - spatial boundary that includes the data (CHANGED cardinality in CAOM-2.5).
      samples - detailed sub-samples of the bounds (CHANGED in CAOM-2.5).
      minBounds - minimum spatial boundary that includes the data; this value is smaller than the bounds (maximum) when the field-of-view varies because it is dependent on another axis (usually energy) (new in CAOM-2.5).
      dimension - number of separate measurements (pixels) along each axis.
      maxRecoverableScale - maximum size of spatial structure (signal) that can be recovered or seen in the data (new in CAOM-2.5).
      resolution - mean spatial resolution (full-width-half-max) per pixel.
      resolutionBounds - range of resolution within the bounds.
      sampleSize - median pixel size.
      calibration - term describing the calibration of the position axis values (NEW in CAOM-2.5).

    • Position

      public Position(Position 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(Position 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 Shape getBounds()
      Returns bounds Attribute.
      Returns:
      bounds Attribute

    • setBounds

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

    • withBounds

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

    • getSamples

      public MultiShape getSamples()
      Returns samples Attribute.
      Returns:
      samples Attribute

    • setSamples

      public void setSamples(MultiShape pSamples)
      Set samples Attribute.
      Parameters:
      pSamples - value to set

    • withSamples

      public Position withSamples(MultiShape pSamples)
      fluent setter for samples Attribute.
      Parameters:
      pSamples - value to set
      Returns:
      Position

    • getMinBounds

      public Shape getMinBounds()
      Returns minBounds Attribute.
      Returns:
      minBounds Attribute

    • setMinBounds

      public void setMinBounds(Shape pMinBounds)
      Set minBounds Attribute.
      Parameters:
      pMinBounds - value to set

    • withMinBounds

      public Position withMinBounds(Shape pMinBounds)
      fluent setter for minBounds Attribute.
      Parameters:
      pMinBounds - value to set
      Returns:
      Position

    • getDimension

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

    • setDimension

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

    • withDimension

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

    • getMaxRecoverableScale

      public Interval getMaxRecoverableScale()
      Returns maxRecoverableScale Attribute.
      Returns:
      maxRecoverableScale Attribute

    • setMaxRecoverableScale

      public void setMaxRecoverableScale(Interval pMaxRecoverableScale)
      Set maxRecoverableScale Attribute.
      Parameters:
      pMaxRecoverableScale - value to set

    • withMaxRecoverableScale

      public Position withMaxRecoverableScale(Interval pMaxRecoverableScale)
      fluent setter for maxRecoverableScale Attribute.
      Parameters:
      pMaxRecoverableScale - value to set
      Returns:
      Position

    • 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 Position withResolution(Double pResolution)
      fluent setter for resolution Attribute.
      Parameters:
      pResolution - value to set
      Returns:
      Position

    • 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 Position withResolutionBounds(Interval pResolutionBounds)
      fluent setter for resolutionBounds Attribute.
      Parameters:
      pResolutionBounds - value to set
      Returns:
      Position

    • 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 Position withSampleSize(Double pSampleSize)
      fluent setter for sampleSize Attribute.
      Parameters:
      pSampleSize - value to set
      Returns:
      Position

    • 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 Position withCalibration(CalibrationStatus pCalibration)
      fluent setter for calibration Attribute.
      Parameters:
      pCalibration - value to set
      Returns:
      Position

    • createPosition

      public static Position createPosition(Consumer<Position.PositionBuilder> f)
      create a Position 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>