Class SimpleImageAccess

All Implemented Interfaces:
com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, Cloneable, 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-10-20T18:15:02+01:00") public class SimpleImageAccess extends SIACapRestriction implements Cloneable, com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString
Editor's Notes: * This is a prototype definition to illustrate how to extend the schema to a specific standard interface. * Staging information is not included yet.

Java class for SimpleImageAccess complex type

.

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


 <complexType name="SimpleImageAccess">
   <complexContent>
     <extension base="{http://www.ivoa.net/xml/SIA/v1.1}SIACapRestriction">
       <sequence>
         <element name="imageServiceType" type="{http://www.ivoa.net/xml/SIA/v1.1}ImageServiceType"/>
         <element name="maxQueryRegionSize" type="{http://www.ivoa.net/xml/SIA/v1.1}SkySize" minOccurs="0"/>
         <element name="maxImageExtent" type="{http://www.ivoa.net/xml/SIA/v1.1}SkySize" minOccurs="0"/>
         <element name="maxImageSize" type="{http://www.w3.org/2001/XMLSchema}positiveInteger" minOccurs="0"/>
         <element name="maxFileSize" type="{http://www.w3.org/2001/XMLSchema}positiveInteger" minOccurs="0"/>
         <element name="maxRecords" type="{http://www.w3.org/2001/XMLSchema}positiveInteger" minOccurs="0"/>
         <element name="testQuery" type="{http://www.ivoa.net/xml/SIA/v1.1}Query" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 
  • Field Details

    • imageServiceType

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") protected ImageServiceType imageServiceType
      The class of image service: Cutout, Mosaic, Atlas, Pointed
    • maxQueryRegionSize

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") protected SkySize maxQueryRegionSize
      Not providing a value is the prefered way to indicate that there is no limit.
    • maxImageExtent

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") protected SkySize maxImageExtent
      Not providing a value is the prefered way to indicate that there is no limit.
    • maxImageSize

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") protected BigInteger maxImageSize
      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

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") protected BigInteger maxFileSize
      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

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") protected BigInteger maxRecords
      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

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") 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.
  • Constructor Details

  • Method Details

    • getImageServiceType

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public ImageServiceType getImageServiceType()
      The class of image service: Cutout, Mosaic, Atlas, Pointed
      Returns:
      possible object is ImageServiceType
    • setImageServiceType

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public void setImageServiceType(ImageServiceType value)
      Sets the value of the imageServiceType property.
      Parameters:
      value - allowed object is ImageServiceType
      See Also:
    • getMaxQueryRegionSize

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public SkySize getMaxQueryRegionSize()
      Not providing a value is the prefered way to indicate that there is no limit.
      Returns:
      possible object is SkySize
    • setMaxQueryRegionSize

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public void setMaxQueryRegionSize(SkySize value)
      Sets the value of the maxQueryRegionSize property.
      Parameters:
      value - allowed object is SkySize
      See Also:
    • getMaxImageExtent

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public SkySize getMaxImageExtent()
      Not providing a value is the prefered way to indicate that there is no limit.
      Returns:
      possible object is SkySize
    • setMaxImageExtent

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public void setMaxImageExtent(SkySize value)
      Sets the value of the maxImageExtent property.
      Parameters:
      value - allowed object is SkySize
      See Also:
    • getMaxImageSize

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public BigInteger getMaxImageSize()
      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.
      Returns:
      possible object is BigInteger
    • setMaxImageSize

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public void setMaxImageSize(BigInteger value)
      Sets the value of the maxImageSize property.
      Parameters:
      value - allowed object is BigInteger
      See Also:
    • getMaxFileSize

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public BigInteger getMaxFileSize()
      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.
      Returns:
      possible object is BigInteger
    • setMaxFileSize

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public void setMaxFileSize(BigInteger value)
      Sets the value of the maxFileSize property.
      Parameters:
      value - allowed object is BigInteger
      See Also:
    • getMaxRecords

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public BigInteger getMaxRecords()
      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.)
      Returns:
      possible object is BigInteger
    • setMaxRecords

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public void setMaxRecords(BigInteger value)
      Sets the value of the maxRecords property.
      Parameters:
      value - allowed object is BigInteger
      See Also:
    • getTestQuery

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public Query getTestQuery()
      a set of query parameters that is expected to produce at least one matched record which can be used to test the service.
      Returns:
      possible object is Query
    • setTestQuery

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public void setTestQuery(Query value)
      Sets the value of the testQuery property.
      Parameters:
      value - allowed object is Query
      See Also:
    • equals

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public boolean equals(Object object)
      Overrides:
      equals in class SIACapRestriction
    • hashCode

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public int hashCode()
      Overrides:
      hashCode in class SIACapRestriction
    • toString

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public String toString()
      Overrides:
      toString in class SIACapRestriction
    • append

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+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
      Overrides:
      append in class SIACapRestriction
    • appendFields

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+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
      Overrides:
      appendFields in class SIACapRestriction
    • mergeFrom

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public void mergeFrom(Object left, Object right)
      Specified by:
      mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom
      Overrides:
      mergeFrom in class SIACapRestriction
    • mergeFrom

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+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
      Overrides:
      mergeFrom in class SIACapRestriction
    • createNewInstance

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public Object createNewInstance()
      Specified by:
      createNewInstance in interface org.jvnet.jaxb.lang.MergeFrom
      Overrides:
      createNewInstance in class Capability
    • clone

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public SimpleImageAccess clone()
      Overrides:
      clone in class SIACapRestriction
    • createCopy

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public SimpleImageAccess createCopy()
      Specified by:
      createCopy in interface com.kscs.util.jaxb.Copyable
      Overrides:
      createCopy in class SIACapRestriction
    • createCopy

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public SimpleImageAccess createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
      Specified by:
      createCopy in interface com.kscs.util.jaxb.PartialCopyable
      Overrides:
      createCopy in class SIACapRestriction
    • copyExcept

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public SimpleImageAccess copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)
      Specified by:
      copyExcept in interface com.kscs.util.jaxb.PartialCopyable
      Overrides:
      copyExcept in class SIACapRestriction
    • copyOnly

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public SimpleImageAccess copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)
      Specified by:
      copyOnly in interface com.kscs.util.jaxb.PartialCopyable
      Overrides:
      copyOnly in class SIACapRestriction
    • modifier

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public SimpleImageAccess.Modifier modifier()
      Overrides:
      modifier in class SIACapRestriction
    • copyTo

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public <_B> void copyTo(SimpleImageAccess.Builder<_B> _other)
      Copies all state of this object to a builder. This method is used by the copyOf method and should not be called directly by client code.
      Parameters:
      _other - A builder instance to which the state of this object will be copied.
    • newCopyBuilder

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public <_B> SimpleImageAccess.Builder<_B> newCopyBuilder(_B _parentBuilder)
      Specified by:
      newCopyBuilder in class SIACapRestriction
    • newCopyBuilder

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public SimpleImageAccess.Builder<Void> newCopyBuilder()
      Specified by:
      newCopyBuilder in class SIACapRestriction
    • builder

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static SimpleImageAccess.Builder<Void> builder()
    • copyOf

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static <_B> SimpleImageAccess.Builder<_B> copyOf(Capability _other)
    • copyOf

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static <_B> SimpleImageAccess.Builder<_B> copyOf(SIACapRestriction _other)
    • copyOf

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static <_B> SimpleImageAccess.Builder<_B> copyOf(SimpleImageAccess _other)
    • copyTo

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public <_B> void copyTo(SimpleImageAccess.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
      Copies all state of this object to a builder. This method is used by the copyOf method and should not be called directly by client code.
      Parameters:
      _other - A builder instance to which the state of this object will be copied.
    • newCopyBuilder

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public <_B> SimpleImageAccess.Builder<_B> newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
      Specified by:
      newCopyBuilder in class SIACapRestriction
    • newCopyBuilder

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public SimpleImageAccess.Builder<Void> newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
      Specified by:
      newCopyBuilder in class SIACapRestriction
    • copyOf

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static <_B> SimpleImageAccess.Builder<_B> copyOf(Capability _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
    • copyOf

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static <_B> SimpleImageAccess.Builder<_B> copyOf(SIACapRestriction _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
    • copyOf

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static <_B> SimpleImageAccess.Builder<_B> copyOf(SimpleImageAccess _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
    • copyExcept

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static SimpleImageAccess.Builder<Void> copyExcept(Capability _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
    • copyExcept

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static SimpleImageAccess.Builder<Void> copyExcept(SIACapRestriction _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
    • copyExcept

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static SimpleImageAccess.Builder<Void> copyExcept(SimpleImageAccess _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
    • copyOnly

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static SimpleImageAccess.Builder<Void> copyOnly(Capability _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
    • copyOnly

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static SimpleImageAccess.Builder<Void> copyOnly(SIACapRestriction _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
    • copyOnly

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static SimpleImageAccess.Builder<Void> copyOnly(SimpleImageAccess _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
    • visit

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public SimpleImageAccess visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)
      Overrides:
      visit in class SIACapRestriction