Package org.ivoa.dm.registry.vodataservice

Class Coverage

java.lang.Object
org.ivoa.dm.registry.vodataservice.Coverage
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="VODataService:Coverage", role=objectType) public class Coverage extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
A description of how a resource's contents or behavior maps to the sky, to time, and to frequency space, including coverage and resolution. objectType: Coverage

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • spatial

      @VoDml(id="VODataService:Coverage.spatial", role=attribute, type="VODataService:SpatialCoverage", typeRole=dataType) protected SpatialCoverage spatial
      An ASCII-serialized MOC defining the spatial coverage of the resource. The MOC is to be understood in the ICRS reference frame unless a frame attribute is given. Resources should give the coverage at least to order 6 (a resolution of about one degree). The order should be chosen so as to keep the resulting MOC smaller than a few dozens of kB. If desired, a more precise MOC can be provided on a dedicated endpoint declared in the footprint element. : Attribute spatial : multiplicity 0..1

    • temporal

      @VoDml(id="VODataService:Coverage.temporal", role=attribute, type="VODataService:FloatInterval", typeRole=primitiveType) protected List<FloatInterval> temporal
      A pair of lower, upper limits of a time interval for which the resource offers data. This is written as for VOTable tabledata (i.e., whitespace-separated C-style floating point literals), as in “47847.2 51370.2”. The limits must be given as MJD. While they are not intended to be precise, they are to be understood in TDB for the solar system barycenter. The total coverage of the resource is the union of all such intervals. : Attribute temporal : multiplicity 0..*

    • spectral

      @VoDml(id="VODataService:Coverage.spectral", role=attribute, type="VODataService:FloatInterval", typeRole=primitiveType) protected List<FloatInterval> spectral
      A pair of lower, upper limits of a spectral interval for which the resource offers data. This is written as for VOTable tabledata (i.e., whitespace-separated C-style floating point literals). The limits must be given in Joules of particle energies. While the limits are not intended to be precise, they are to be understood for the solar system barycenter. For instance, the Johnson V waveband (480 .. 730 nm) would be specified as “2.72e-19 4.14e-19” . : Attribute spectral : multiplicity 0..*

    • footprint

      @VoDml(id="VODataService:Coverage.footprint", role=attribute, type="VODataService:ServiceReference", typeRole=dataType) protected ServiceReference footprint
      A reference to a footprint service for retrieving precise and up-to-date description of coverage. The ivoid attribute here refers to the standard in which the footprint is given. The only value defined by VODataService at this point is ivo://ivoa.net/std/moc, which indicates that retrieving the footprint URL will return a MOC (any IVOA-approved serialisation is legal). Note that the ivoid attribute was intended to have a different function in VODataService 1.1. The current meaning is what implementors actually adopted. : Attribute footprint : multiplicity 0..1

    • waveband

      @VoDml(id="VODataService:Coverage.waveband", role=attribute, type="ivoa:string", typeRole=primitiveType) protected List<String> waveband
      A name of a messenger that the resource is relevant for (e.g., was used in the measurements). Terms must be taken from the vocabulary at http://www.ivoa.net/rdf/messenger. It is a bit unfortunate that the element is still called waveband when it is now also covers non-electromagnetic messengers. It was deemed that this slight notional sloppiness is preferable to introducing new and deprecating old elements. : Attribute waveband : multiplicity 0..*

    • regionOfRegard

      @VoDml(id="VODataService:Coverage.regionOfRegard", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double regionOfRegard
      A single numeric value representing the angle, given in decimal degrees, by which a positional query against this resource should be “blurred” in order to get an appropriate match. In the case of image repositories, it might refer to a typical field-of-view size, or the primary beam size for radio aperture synthesis data. In the case of object catalogues RoR should normally be the largest of the typical size of the objects, the astrometric errors in the positions, or the resolution of the data. : Attribute regionOfRegard : multiplicity 0..1

  • Constructor Details

    • Coverage

      public Coverage()
      Creates a new Coverage

    • Coverage

      public Coverage(SpatialCoverage spatial, List<FloatInterval> temporal, List<FloatInterval> spectral, ServiceReference footprint, List<String> waveband, Double regionOfRegard)
      full parameter constructor.
      Parameters:
      spatial - An ASCII-serialized MOC defining the spatial coverage of the resource. The MOC is to be understood in the ICRS reference frame unless a frame attribute is given. Resources should give the coverage at least to order 6 (a resolution of about one degree). The order should be chosen so as to keep the resulting MOC smaller than a few dozens of kB. If desired, a more precise MOC can be provided on a dedicated endpoint declared in the footprint element.
      temporal - A pair of lower, upper limits of a time interval for which the resource offers data. This is written as for VOTable tabledata (i.e., whitespace-separated C-style floating point literals), as in “47847.2 51370.2”. The limits must be given as MJD. While they are not intended to be precise, they are to be understood in TDB for the solar system barycenter. The total coverage of the resource is the union of all such intervals.
      spectral - A pair of lower, upper limits of a spectral interval for which the resource offers data. This is written as for VOTable tabledata (i.e., whitespace-separated C-style floating point literals). The limits must be given in Joules of particle energies. While the limits are not intended to be precise, they are to be understood for the solar system barycenter. For instance, the Johnson V waveband (480 .. 730 nm) would be specified as “2.72e-19 4.14e-19” .
      footprint - A reference to a footprint service for retrieving precise and up-to-date description of coverage. The ivoid attribute here refers to the standard in which the footprint is given. The only value defined by VODataService at this point is ivo://ivoa.net/std/moc, which indicates that retrieving the footprint URL will return a MOC (any IVOA-approved serialisation is legal). Note that the ivoid attribute was intended to have a different function in VODataService 1.1. The current meaning is what implementors actually adopted.
      waveband - A name of a messenger that the resource is relevant for (e.g., was used in the measurements). Terms must be taken from the vocabulary at http://www.ivoa.net/rdf/messenger. It is a bit unfortunate that the element is still called waveband when it is now also covers non-electromagnetic messengers. It was deemed that this slight notional sloppiness is preferable to introducing new and deprecating old elements.
      regionOfRegard - A single numeric value representing the angle, given in decimal degrees, by which a positional query against this resource should be “blurred” in order to get an appropriate match. In the case of image repositories, it might refer to a typical field-of-view size, or the primary beam size for radio aperture synthesis data. In the case of object catalogues RoR should normally be the largest of the typical size of the objects, the astrometric errors in the positions, or the resolution of the data.

    • Coverage

      public Coverage(Coverage 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(Coverage 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.

    • getSpatial

      public SpatialCoverage getSpatial()
      Returns spatial Attribute.
      Returns:
      spatial Attribute

    • setSpatial

      public void setSpatial(SpatialCoverage pSpatial)
      Set spatial Attribute.
      Parameters:
      pSpatial - value to set

    • withSpatial

      public Coverage withSpatial(SpatialCoverage pSpatial)
      fluent setter for spatial Attribute.
      Parameters:
      pSpatial - value to set
      Returns:
      Coverage

    • getTemporal

      public List<FloatInterval> getTemporal()
      Returns temporal Attribute.
      Returns:
      temporal Attribute

    • setTemporal

      public void setTemporal(List<FloatInterval> pTemporal)
      Set temporal Attribute.
      Parameters:
      pTemporal - value to set

    • withTemporal

      public Coverage withTemporal(List<FloatInterval> pTemporal)
      fluent setter for temporal Attribute.
      Parameters:
      pTemporal - value to set
      Returns:
      Coverage

    • getSpectral

      public List<FloatInterval> getSpectral()
      Returns spectral Attribute.
      Returns:
      spectral Attribute

    • setSpectral

      public void setSpectral(List<FloatInterval> pSpectral)
      Set spectral Attribute.
      Parameters:
      pSpectral - value to set

    • withSpectral

      public Coverage withSpectral(List<FloatInterval> pSpectral)
      fluent setter for spectral Attribute.
      Parameters:
      pSpectral - value to set
      Returns:
      Coverage

    • getFootprint

      public ServiceReference getFootprint()
      Returns footprint Attribute.
      Returns:
      footprint Attribute

    • setFootprint

      public void setFootprint(ServiceReference pFootprint)
      Set footprint Attribute.
      Parameters:
      pFootprint - value to set

    • withFootprint

      public Coverage withFootprint(ServiceReference pFootprint)
      fluent setter for footprint Attribute.
      Parameters:
      pFootprint - value to set
      Returns:
      Coverage

    • getWaveband

      public List<String> getWaveband()
      Returns waveband Attribute.
      Returns:
      waveband Attribute

    • setWaveband

      public void setWaveband(List<String> pWaveband)
      Set waveband Attribute.
      Parameters:
      pWaveband - value to set

    • withWaveband

      public Coverage withWaveband(List<String> pWaveband)
      fluent setter for waveband Attribute.
      Parameters:
      pWaveband - value to set
      Returns:
      Coverage

    • getRegionOfRegard

      public Double getRegionOfRegard()
      Returns regionOfRegard Attribute.
      Returns:
      regionOfRegard Attribute

    • setRegionOfRegard

      public void setRegionOfRegard(Double pRegionOfRegard)
      Set regionOfRegard Attribute.
      Parameters:
      pRegionOfRegard - value to set

    • withRegionOfRegard

      public Coverage withRegionOfRegard(Double pRegionOfRegard)
      fluent setter for regionOfRegard Attribute.
      Parameters:
      pRegionOfRegard - value to set
      Returns:
      Coverage

    • createCoverage

      public static Coverage createCoverage(Consumer<Coverage.CoverageBuilder> f)
      create a Coverage 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>