Package org.ivoa.dm.registry.vodataservice

Class Coverage.CoverageBuilder

java.lang.Object
org.ivoa.dm.registry.vodataservice.Coverage.CoverageBuilder
Enclosing class:
Coverage
public static class Coverage.CoverageBuilder extends Object
A builder class for Coverage, mainly for use in the functional builder pattern.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    ServiceReference
    footprint
    A reference to a footprint service for retrieving precise and up-to-date description of coverage.
    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.
    SpatialCoverage
    spatial
    An ASCII-serialized MOC defining the spatial coverage of the resource.
    List<FloatInterval>
    spectral
    A pair of lower, upper limits of a spectral interval for which the resource offers data.
    List<FloatInterval>
    temporal
    A pair of lower, upper limits of a time interval for which the resource offers data.
    List<String>
    waveband
    A name of a messenger that the resource is relevant for (e.g., was used in the measurements).

  • Constructor Summary

    Constructors
    Constructor
    Description
    CoverageBuilder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Coverage
    create()
    create a Coverage from this builder.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • spatial

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

    • temporal

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

    • spectral

      public 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” .

    • footprint

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

    • waveband

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

    • regionOfRegard

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

  • Constructor Details

    • CoverageBuilder

      public CoverageBuilder()

  • Method Details

    • create

      public Coverage create()
      create a Coverage from this builder.
      Returns:
      an object initialized from the builder.