Package org.ivoa.dm.registry.sia

Class SimpleImageAccess

java.lang.Object
org.ivoa.dm.registry.voresource.Capability
org.ivoa.dm.registry.sia.SimpleImageAccess
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="SIA:SimpleImageAccess", role=objectType) public class SimpleImageAccess extends Capability implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
The capabilities of an SIA implementation. objectType: SimpleImageAccess

  • Field Details

    • imageServiceType

      @VoDml(id="SIA:SimpleImageAccess.imageServiceType", role=attribute, type="SIA:ImageServiceType", typeRole=enumeration) protected ImageServiceType imageServiceType
      The class of image service: Cutout, Mosaic, Atlas, Pointed . : Attribute imageServiceType : multiplicity 1

    • maxQueryRegionSize

      @VoDml(id="SIA:SimpleImageAccess.maxQueryRegionSize", role=composition, type="SIA:SkySize", typeRole=objectType) protected SkySize maxQueryRegionSize
      The maximum image query region size, expressed in decimal degrees. Not providing this element or specifying a value of 360 degrees indicates that there is no limit and the entire data collection (entire sky) can be queried. Not providing a value is the prefered way to indicate that there is no limit. composition maxQueryRegionSize : ( Multiplicity : 0..1 )

    • maxImageExtent

      @VoDml(id="SIA:SimpleImageAccess.maxImageExtent", role=composition, type="SIA:SkySize", typeRole=objectType) protected SkySize maxImageExtent
      An upper bound on a region of the sky that can be covered by returned images. That is, no image returned by this service will cover more than this limit. Not providing this element or specifying a value of 360 degrees indicates that there is no fundamental limit to the region covered by a returned image. When the imageServiceType is “Cutout” or “Mosaic”, this represents the largest area that can be requested. In this case, the “no limit” value means that all-sky images can be requested. When the type is “Atlas” or “Pointed”, it should be a region that most closely encloses largest images in the archive, and the ”no limit” value means that the archive contains all-sky (or nearly so) images. Not providing a value is the prefered way to indicate that there is no limit. composition maxImageExtent : ( Multiplicity : 0..1 )

    • maxImageSize

      @VoDml(id="SIA:SimpleImageAccess.maxImageSize", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer maxImageSize
      A measure of the largest image the service can produce given as the maximum number of pixels along the first or second axes. Not providing a value indicates that there is no effective limit to the size of the images that can be returned. This is primarily relevant when the imageServiceType is “Cutout” or “Mosaic”, indicating the largest image that can be created. When the imageServiceType is “Atlas” or “Pointed”, this should be specified only when there are static images in the archive that can be searched for but not returned because they are too big. When a service is more fundementally limited by the total number of pixels in the image, this value should be set to the square-root of that number. This number will then represent a lower limit on the maximum length of a side. : Attribute maxImageSize : multiplicity 0..1

    • maxFileSize

      @VoDml(id="SIA:SimpleImageAccess.maxFileSize", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer maxFileSize
      The maximum image file size in bytes. Not providing a value indicates that there is no effective limit the size of files that can be returned. This is primarily relevant when the imageServiceType is “Cutout” or “Mosaic”, indicating the largest files that can be created. When the imageServiceType is “Atlas” or “Pointed”, this should be specified only when there are static images in the archive that can be searched for but not returned because they are too big. : Attribute maxFileSize : multiplicity 0..1

    • maxRecords

      @VoDml(id="SIA:SimpleImageAccess.maxRecords", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer maxRecords
      The largest number of records that the Image Query web method will return. Not providing this value means that there is no effective limit. This does not refer to the total number of images in the archive but rather maximum number of records the service is capable of returning. A limit that is greater than the number of images available in the archive is equivalent to their being no effective limit. (See RM, Hanisch 2007.) . : Attribute maxRecords : multiplicity 0..1

    • testQuery

      @VoDml(id="SIA:SimpleImageAccess.testQuery", role=composition, type="SIA:Query", typeRole=objectType) protected Query testQuery
      a set of query parameters that is expected to produce at least one matched record which can be used to test the service. composition testQuery : ( Multiplicity : 0..1 )

  • Constructor Details

    • SimpleImageAccess

      public SimpleImageAccess()
      Creates a new SimpleImageAccess

    • SimpleImageAccess

      public SimpleImageAccess(ImageServiceType imageServiceType, SkySize maxQueryRegionSize, SkySize maxImageExtent, Integer maxImageSize, Integer maxFileSize, Integer maxRecords, Query testQuery, List<Validation> validationLevel, String description, List<Interface> interface_, String standardID)
      full parameter constructor.
      Parameters:
      imageServiceType - The class of image service: Cutout, Mosaic, Atlas, Pointed .
      maxQueryRegionSize - The maximum image query region size, expressed in decimal degrees. Not providing this element or specifying a value of 360 degrees indicates that there is no limit and the entire data collection (entire sky) can be queried. Not providing a value is the prefered way to indicate that there is no limit.
      maxImageExtent - An upper bound on a region of the sky that can be covered by returned images. That is, no image returned by this service will cover more than this limit. Not providing this element or specifying a value of 360 degrees indicates that there is no fundamental limit to the region covered by a returned image. When the imageServiceType is “Cutout” or “Mosaic”, this represents the largest area that can be requested. In this case, the “no limit” value means that all-sky images can be requested. When the type is “Atlas” or “Pointed”, it should be a region that most closely encloses largest images in the archive, and the ”no limit” value means that the archive contains all-sky (or nearly so) images. Not providing a value is the prefered way to indicate that there is no limit.
      maxImageSize - A measure of the largest image the service can produce given as the maximum number of pixels along the first or second axes. Not providing a value indicates that there is no effective limit to the size of the images that can be returned. This is primarily relevant when the imageServiceType is “Cutout” or “Mosaic”, indicating the largest image that can be created. When the imageServiceType is “Atlas” or “Pointed”, this should be specified only when there are static images in the archive that can be searched for but not returned because they are too big. When a service is more fundementally limited by the total number of pixels in the image, this value should be set to the square-root of that number. This number will then represent a lower limit on the maximum length of a side.
      maxFileSize - The maximum image file size in bytes. Not providing a value indicates that there is no effective limit the size of files that can be returned. This is primarily relevant when the imageServiceType is “Cutout” or “Mosaic”, indicating the largest files that can be created. When the imageServiceType is “Atlas” or “Pointed”, this should be specified only when there are static images in the archive that can be searched for but not returned because they are too big.
      maxRecords - The largest number of records that the Image Query web method will return. Not providing this value means that there is no effective limit. This does not refer to the total number of images in the archive but rather maximum number of records the service is capable of returning. A limit that is greater than the number of images available in the archive is equivalent to their being no effective limit. (See RM, Hanisch 2007.) .
      testQuery - a set of query parameters that is expected to produce at least one matched record which can be used to test the service.
      validationLevel - A numeric grade describing the quality of the capability description and interface, when applicable, to be used to indicate the confidence an end-user can put in the resource as part of a VO application or research study. See VOResource:ValidationLevel for an explanation of the allowed levels.
      description - A human-readable description of what this capability provides as part of the over-all service Use of this optional element is especially encouraged when this capability is non-standard and is one of several capabilities listed.
      interface_ - a description of how to call the service to access this capability Since the Interface type is abstract, one must describe the interface using a subclass of Interface, denoting it via xsi:type. Multiple occurences can describe different interfaces to the logically same capability, i.e. data or functionality. That is, the inputs accepted and the output provides should be logically the same. For example, a WebBrowser interface given in addition to a WebService interface would simply provide an interactive, human-targeted interface to the underlying WebService interface.
      standardID - A URI identifier for a standard service. This provides a unique way to refer to a service specification standard, such as a Simple Image Access service. The use of an IVOA identifier here implies that a VOResource description of the standard is registered and accessible.

    • SimpleImageAccess

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

    • SimpleImageAccess

      public SimpleImageAccess(Capability superinstance, ImageServiceType imageServiceType, SkySize maxQueryRegionSize, SkySize maxImageExtent, Integer maxImageSize, Integer maxFileSize, Integer maxRecords, Query testQuery)
      Constructor from supertype instance.
      Parameters:
      superinstance - The supertype.
      imageServiceType - The class of image service: Cutout, Mosaic, Atlas, Pointed .
      maxQueryRegionSize - The maximum image query region size, expressed in decimal degrees. Not providing this element or specifying a value of 360 degrees indicates that there is no limit and the entire data collection (entire sky) can be queried. Not providing a value is the prefered way to indicate that there is no limit.
      maxImageExtent - An upper bound on a region of the sky that can be covered by returned images. That is, no image returned by this service will cover more than this limit. Not providing this element or specifying a value of 360 degrees indicates that there is no fundamental limit to the region covered by a returned image. When the imageServiceType is “Cutout” or “Mosaic”, this represents the largest area that can be requested. In this case, the “no limit” value means that all-sky images can be requested. When the type is “Atlas” or “Pointed”, it should be a region that most closely encloses largest images in the archive, and the ”no limit” value means that the archive contains all-sky (or nearly so) images. Not providing a value is the prefered way to indicate that there is no limit.
      maxImageSize - A measure of the largest image the service can produce given as the maximum number of pixels along the first or second axes. Not providing a value indicates that there is no effective limit to the size of the images that can be returned. This is primarily relevant when the imageServiceType is “Cutout” or “Mosaic”, indicating the largest image that can be created. When the imageServiceType is “Atlas” or “Pointed”, this should be specified only when there are static images in the archive that can be searched for but not returned because they are too big. When a service is more fundementally limited by the total number of pixels in the image, this value should be set to the square-root of that number. This number will then represent a lower limit on the maximum length of a side.
      maxFileSize - The maximum image file size in bytes. Not providing a value indicates that there is no effective limit the size of files that can be returned. This is primarily relevant when the imageServiceType is “Cutout” or “Mosaic”, indicating the largest files that can be created. When the imageServiceType is “Atlas” or “Pointed”, this should be specified only when there are static images in the archive that can be searched for but not returned because they are too big.
      maxRecords - The largest number of records that the Image Query web method will return. Not providing this value means that there is no effective limit. This does not refer to the total number of images in the archive but rather maximum number of records the service is capable of returning. A limit that is greater than the number of images available in the archive is equivalent to their being no effective limit. (See RM, Hanisch 2007.) .
      testQuery - a set of query parameters that is expected to produce at least one matched record which can be used to test the service.

  • Method Details

    • copyMe

      public Capability copyMe()
      make a clone of the object taking into account current polymorhic type.
      Overrides:
      copyMe in class Capability
      Returns:
      the cloned object.

    • updateUsing

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

    • getImageServiceType

      public ImageServiceType getImageServiceType()
      Returns imageServiceType Attribute.
      Returns:
      imageServiceType Attribute

    • setImageServiceType

      public void setImageServiceType(ImageServiceType pImageServiceType)
      Set imageServiceType Attribute.
      Parameters:
      pImageServiceType - value to set

    • withImageServiceType

      public SimpleImageAccess withImageServiceType(ImageServiceType pImageServiceType)
      fluent setter for imageServiceType Attribute.
      Parameters:
      pImageServiceType - value to set
      Returns:
      SimpleImageAccess

    • getMaxQueryRegionSize

      public SkySize getMaxQueryRegionSize()
      Returns maxQueryRegionSize Attribute.
      Returns:
      maxQueryRegionSize Attribute

    • setMaxQueryRegionSize

      public void setMaxQueryRegionSize(SkySize pMaxQueryRegionSize)
      Set maxQueryRegionSize Attribute.
      Parameters:
      pMaxQueryRegionSize - value to set

    • withMaxQueryRegionSize

      public SimpleImageAccess withMaxQueryRegionSize(SkySize pMaxQueryRegionSize)
      fluent setter for maxQueryRegionSize Attribute.
      Parameters:
      pMaxQueryRegionSize - value to set
      Returns:
      SimpleImageAccess

    • getMaxImageExtent

      public SkySize getMaxImageExtent()
      Returns maxImageExtent Attribute.
      Returns:
      maxImageExtent Attribute

    • setMaxImageExtent

      public void setMaxImageExtent(SkySize pMaxImageExtent)
      Set maxImageExtent Attribute.
      Parameters:
      pMaxImageExtent - value to set

    • withMaxImageExtent

      public SimpleImageAccess withMaxImageExtent(SkySize pMaxImageExtent)
      fluent setter for maxImageExtent Attribute.
      Parameters:
      pMaxImageExtent - value to set
      Returns:
      SimpleImageAccess

    • getMaxImageSize

      public Integer getMaxImageSize()
      Returns maxImageSize Attribute.
      Returns:
      maxImageSize Attribute

    • setMaxImageSize

      public void setMaxImageSize(Integer pMaxImageSize)
      Set maxImageSize Attribute.
      Parameters:
      pMaxImageSize - value to set

    • withMaxImageSize

      public SimpleImageAccess withMaxImageSize(Integer pMaxImageSize)
      fluent setter for maxImageSize Attribute.
      Parameters:
      pMaxImageSize - value to set
      Returns:
      SimpleImageAccess

    • getMaxFileSize

      public Integer getMaxFileSize()
      Returns maxFileSize Attribute.
      Returns:
      maxFileSize Attribute

    • setMaxFileSize

      public void setMaxFileSize(Integer pMaxFileSize)
      Set maxFileSize Attribute.
      Parameters:
      pMaxFileSize - value to set

    • withMaxFileSize

      public SimpleImageAccess withMaxFileSize(Integer pMaxFileSize)
      fluent setter for maxFileSize Attribute.
      Parameters:
      pMaxFileSize - value to set
      Returns:
      SimpleImageAccess

    • getMaxRecords

      public Integer getMaxRecords()
      Returns maxRecords Attribute.
      Returns:
      maxRecords Attribute

    • setMaxRecords

      public void setMaxRecords(Integer pMaxRecords)
      Set maxRecords Attribute.
      Parameters:
      pMaxRecords - value to set

    • withMaxRecords

      public SimpleImageAccess withMaxRecords(Integer pMaxRecords)
      fluent setter for maxRecords Attribute.
      Parameters:
      pMaxRecords - value to set
      Returns:
      SimpleImageAccess

    • getTestQuery

      public Query getTestQuery()
      Returns testQuery Attribute.
      Returns:
      testQuery Attribute

    • setTestQuery

      public void setTestQuery(Query pTestQuery)
      Set testQuery Attribute.
      Parameters:
      pTestQuery - value to set

    • withTestQuery

      public SimpleImageAccess withTestQuery(Query pTestQuery)
      fluent setter for testQuery Attribute.
      Parameters:
      pTestQuery - value to set
      Returns:
      SimpleImageAccess

    • createSimpleImageAccess

      public static SimpleImageAccess createSimpleImageAccess(Consumer<SimpleImageAccess.SimpleImageAccessBuilder> f)
      create a SimpleImageAccess 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
      Overrides:
      forceLoad in class Capability

    • delete

      public void delete(jakarta.persistence.EntityManager em)
      Specified by:
      delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
      Overrides:
      delete in class Capability