Package org.ivoa.dm.registry.sia

Class SimpleImageAccess.SimpleImageAccessBuilder

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    String
    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.
    ImageServiceType
    imageServiceType
    The class of image service: Cutout, Mosaic, Atlas, Pointed .
    List<Interface>
    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.
    Integer
    maxFileSize
    The maximum image file size in bytes.
    SkySize
    maxImageExtent
    An upper bound on a region of the sky that can be covered by returned images.
    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.
    SkySize
    maxQueryRegionSize
    The maximum image query region size, expressed in decimal degrees.
    Integer
    maxRecords
    The largest number of records that the Image Query web method will return.
    String
    standardID
    A URI identifier for a standard service.
    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.
    List<Validation>
    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.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SimpleImageAccessBuilder()
     

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Field Details

    • imageServiceType

      public ImageServiceType imageServiceType
      The class of image service: Cutout, Mosaic, Atlas, Pointed .

    • maxQueryRegionSize

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

    • maxImageExtent

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

    • maxImageSize

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

    • maxFileSize

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

    • maxRecords

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

    • testQuery

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

    • validationLevel

      public List<Validation> 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

      public String 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_

      public List<Interface> 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

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

  • Constructor Details

    • SimpleImageAccessBuilder

      public SimpleImageAccessBuilder()

  • Method Details

    • create

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