Package org.ivoa.dm.registry.vodataservice

Class SpatialCoverage

java.lang.Object
org.ivoa.dm.registry.vodataservice.SpatialCoverage
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations
@Embeddable @VoDml(id="VODataService:SpatialCoverage", role=dataType) public class SpatialCoverage extends Object implements org.ivoa.vodml.jpa.JPAManipulations
A coverage on a sphere. By default, this refers to the celestial sphere in the ICRS frame. Non-celestial frames are indicated by non-NULL values of the frame attribute. dataType: SpatialCoverage

  • Field Details

    • value

      @VoDml(id="VODataService:SpatialCoverage.value", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String value
      . : Attribute value : multiplicity 1

    • frame

      @VoDml(id="VODataService:SpatialCoverage.frame", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String frame
      When present, the MOC is written in a non-celestial (e.g., planetary) frame. Note that for celestial coverages, ICRS must be used. VODataService 1.2 does not prescribe a vocabulary for what values are allowed here. As long as no such vocabulary is agreed upon, the frame attribute should not be set. : Attribute frame : multiplicity 1

  • Constructor Details

    • SpatialCoverage

      public SpatialCoverage()
      Creates a new SpatialCoverage

    • SpatialCoverage

      public SpatialCoverage(String value, String frame)
      full parameter constructor.
      Parameters:
      value - .
      frame - When present, the MOC is written in a non-celestial (e.g., planetary) frame. Note that for celestial coverages, ICRS must be used. VODataService 1.2 does not prescribe a vocabulary for what values are allowed here. As long as no such vocabulary is agreed upon, the frame attribute should not be set.

    • SpatialCoverage

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

  • Method Details

    • updateUsing

      public void updateUsing(SpatialCoverage 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.

    • getValue

      public String getValue()
      Returns value Attribute.
      Returns:
      value Attribute

    • setValue

      public void setValue(String pValue)
      Set value Attribute.
      Parameters:
      pValue - value to set

    • withValue

      public SpatialCoverage withValue(String pValue)
      fluent setter for value Attribute.
      Parameters:
      pValue - value to set
      Returns:
      SpatialCoverage

    • getFrame

      public String getFrame()
      Returns frame Attribute.
      Returns:
      frame Attribute

    • setFrame

      public void setFrame(String pFrame)
      Set frame Attribute.
      Parameters:
      pFrame - value to set

    • withFrame

      public SpatialCoverage withFrame(String pFrame)
      fluent setter for frame Attribute.
      Parameters:
      pFrame - value to set
      Returns:
      SpatialCoverage

    • createSpatialCoverage

      public static SpatialCoverage createSpatialCoverage(Consumer<SpatialCoverage.SpatialCoverageBuilder> f)
      create a SpatialCoverage 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