Package org.javastro.ivoa.entities.resource.dataservice

Class Coverage

java.lang.Object
org.javastro.ivoa.entities.resource.dataservice.Coverage
All Implemented Interfaces:
org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString
@Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public class Coverage extends Object implements org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString
A description of how a resource's contents or behavior maps to the sky, to time, and to frequency space, including coverage and resolution.

Java class for Coverage complex type

.

The following schema fragment specifies the expected content contained within this class.


 <complexType name="Coverage">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://www.ivoa.net/xml/STC/stc-v1.30.xsd}STCResourceProfile" minOccurs="0"/>
         <element name="spatial" type="{http://www.ivoa.net/xml/VODataService/v1.1}SpatialCoverage" minOccurs="0"/>
         <element name="temporal" type="{http://www.ivoa.net/xml/VODataService/v1.1}FloatInterval" maxOccurs="unbounded" minOccurs="0"/>
         <element name="spectral" type="{http://www.ivoa.net/xml/VODataService/v1.1}FloatInterval" maxOccurs="unbounded" minOccurs="0"/>
         <element name="footprint" type="{http://www.ivoa.net/xml/VODataService/v1.1}ServiceReference" minOccurs="0"/>
         <element name="waveband" type="{http://www.ivoa.net/xml/VODataService/v1.1}Waveband" maxOccurs="unbounded" minOccurs="0"/>
         <element name="regionOfRegard" type="{http://www.w3.org/2001/XMLSchema}float" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

    • stcResourceProfile

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected AstroSTCDescriptionType stcResourceProfile
      An STC 1.0 description of the location of the resource's data on the sky, in time, and in frequency space, including resolution. This is deprecated in favour of the separate spatial, temporal, and spectral elements.

    • spatial

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected SpatialCoverage spatial
      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.

    • temporals

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected List<String> temporals
      This is written as for VOTable tabledata (i.e., whitespace-separated C-style floating point literals). 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.

    • spectrals

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected List<String> spectrals
      For instance, the Johnson V waveband (480 .. 730 nm) would be specified as “2.72e-19 4.14e-19”

    • footprint

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected ServiceReference footprint
      The ivo-id 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 ivo-id attribute was intended to have a different function in VODataService 1.1. The current meaning is what implementors actually adopted.

    • wavebands

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected List<Waveband> wavebands
      Observations using non-electromagnetic messengers should not give a waveband in version 1.2 of VODataService. It is expected that additional terms for these will be provided in a future version.

    • regionOfRegard

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected Float regionOfRegard
      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

  • Method Details

    • getSTCResourceProfile

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public AstroSTCDescriptionType getSTCResourceProfile()
      An STC 1.0 description of the location of the resource's data on the sky, in time, and in frequency space, including resolution. This is deprecated in favour of the separate spatial, temporal, and spectral elements.
      Returns:
      possible object is AstroSTCDescriptionType

    • setSTCResourceProfile

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setSTCResourceProfile(AstroSTCDescriptionType value)
      Sets the value of the stcResourceProfile property.
      Parameters:
      value - allowed object is AstroSTCDescriptionType
      See Also:

    • getSpatial

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public SpatialCoverage getSpatial()
      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.
      Returns:
      possible object is SpatialCoverage

    • setSpatial

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setSpatial(SpatialCoverage value)
      Sets the value of the spatial property.
      Parameters:
      value - allowed object is SpatialCoverage
      See Also:

    • getTemporals

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public List<String> getTemporals()
      This is written as for VOTable tabledata (i.e., whitespace-separated C-style floating point literals). 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. Gets the value of the temporals property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the temporals property.

      For example, to add a new item, do as follows: 

       getTemporals().add(newItem);

      Objects of the following type(s) are allowed in the list String

      Returns:
      The value of the temporals property.

    • getSpectrals

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public List<String> getSpectrals()
      For instance, the Johnson V waveband (480 .. 730 nm) would be specified as “2.72e-19 4.14e-19” Gets the value of the spectrals property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the spectrals property.

      For example, to add a new item, do as follows: 

       getSpectrals().add(newItem);

      Objects of the following type(s) are allowed in the list String

      Returns:
      The value of the spectrals property.

    • getFootprint

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public ServiceReference getFootprint()
      The ivo-id 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 ivo-id attribute was intended to have a different function in VODataService 1.1. The current meaning is what implementors actually adopted.
      Returns:
      possible object is ServiceReference

    • setFootprint

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setFootprint(ServiceReference value)
      Sets the value of the footprint property.
      Parameters:
      value - allowed object is ServiceReference
      See Also:

    • getWavebands

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public List<Waveband> getWavebands()
      Observations using non-electromagnetic messengers should not give a waveband in version 1.2 of VODataService. It is expected that additional terms for these will be provided in a future version. Gets the value of the wavebands property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the wavebands property.

      For example, to add a new item, do as follows: 

       getWavebands().add(newItem);

      Objects of the following type(s) are allowed in the list Waveband

      Returns:
      The value of the wavebands property.

    • getRegionOfRegard

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Float getRegionOfRegard()
      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.
      Returns:
      possible object is Float

    • setRegionOfRegard

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setRegionOfRegard(Float value)
      Sets the value of the regionOfRegard property.
      Parameters:
      value - allowed object is Float
      See Also:

    • equals

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public boolean equals(Object object)
      Overrides:
      equals in class Object

    • hashCode

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public String toString()
      Overrides:
      toString in class Object

    • append

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public StringBuilder append(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
      Specified by:
      append in interface org.jvnet.jaxb.lang.ToString

    • appendFields

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public StringBuilder appendFields(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
      Specified by:
      appendFields in interface org.jvnet.jaxb.lang.ToString

    • withSTCResourceProfile

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Coverage withSTCResourceProfile(AstroSTCDescriptionType value)

    • withSpatial

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Coverage withSpatial(SpatialCoverage value)

    • withTemporals

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Coverage withTemporals(String... values)

    • withTemporals

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Coverage withTemporals(Collection<String> values)

    • withSpectrals

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Coverage withSpectrals(String... values)

    • withSpectrals

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Coverage withSpectrals(Collection<String> values)

    • withFootprint

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Coverage withFootprint(ServiceReference value)

    • withWavebands

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Coverage withWavebands(Waveband... values)

    • withWavebands

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Coverage withWavebands(Collection<Waveband> values)

    • withRegionOfRegard

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Coverage withRegionOfRegard(Float value)

    • mergeFrom

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void mergeFrom(Object left, Object right)
      Specified by:
      mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

    • mergeFrom

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator, org.jvnet.jaxb.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb.lang.MergeStrategy strategy)
      Specified by:
      mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

    • createNewInstance

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Object createNewInstance()
      Specified by:
      createNewInstance in interface org.jvnet.jaxb.lang.MergeFrom