Package org.javastro.ivoa.entities.resource.sia

Class SimpleImageAccess

java.lang.Object

org.javastro.ivoa.entities.resource.Capability

org.javastro.ivoa.entities.resource.sia.SIACapRestriction

org.javastro.ivoa.entities.resource.sia.SimpleImageAccess

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 SimpleImageAccess
extends SIACapRestriction
implements 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 Summary

Fields

Modifier and Type	Field	Description
protected ImageServiceType	imageServiceType	The class of image service: Cutout, Mosaic, Atlas, Pointed
protected BigInteger	maxFileSize	This is primarily relevant when the imageServiceType is "Cutout" or "Mosaic", indicating the largest files that can be created.
protected SkySize	maxImageExtent	Not providing a value is the prefered way to indicate that there is no limit.
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.
protected SkySize	maxQueryRegionSize	Not providing a value is the prefered way to indicate that there is no limit.
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.
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.

Fields inherited from class org.javastro.ivoa.entities.resource.Capability

description, interfaces, standardID, validationLevels

Constructor Summary

Constructors

Constructor	Description
SimpleImageAccess()	Default no-arg constructor
SimpleImageAccess(List<Validation> validationLevels, String description, List<ServiceInterface> interfaces, String standardID, ImageServiceType imageServiceType, SkySize maxQueryRegionSize, SkySize maxImageExtent, BigInteger maxImageSize, BigInteger maxFileSize, BigInteger maxRecords, Query testQuery)	Fully-initialising value constructor

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
StringBuilder	appendFields(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
Object	createNewInstance()
boolean	equals(Object object)
ImageServiceType	getImageServiceType()	The class of image service: Cutout, Mosaic, Atlas, Pointed
BigInteger	getMaxFileSize()	This is primarily relevant when the imageServiceType is "Cutout" or "Mosaic", indicating the largest files that can be created.
SkySize	getMaxImageExtent()	Not providing a value is the prefered way to indicate that there is no limit.
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.
SkySize	getMaxQueryRegionSize()	Not providing a value is the prefered way to indicate that there is no limit.
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.
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.
int	hashCode()
void	mergeFrom(Object left, Object right)
void	mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator, org.jvnet.jaxb.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb.lang.MergeStrategy strategy)
void	setImageServiceType(ImageServiceType value)	Sets the value of the imageServiceType property.
void	setMaxFileSize(BigInteger value)	Sets the value of the maxFileSize property.
void	setMaxImageExtent(SkySize value)	Sets the value of the maxImageExtent property.
void	setMaxImageSize(BigInteger value)	Sets the value of the maxImageSize property.
void	setMaxQueryRegionSize(SkySize value)	Sets the value of the maxQueryRegionSize property.
void	setMaxRecords(BigInteger value)	Sets the value of the maxRecords property.
void	setTestQuery(Query value)	Sets the value of the testQuery property.
String	toString()
SimpleImageAccess	withDescription(String value)
SimpleImageAccess	withImageServiceType(ImageServiceType value)
SimpleImageAccess	withInterfaces(Collection<ServiceInterface> values)
SimpleImageAccess	withInterfaces(ServiceInterface... values)
SimpleImageAccess	withMaxFileSize(BigInteger value)
SimpleImageAccess	withMaxImageExtent(SkySize value)
SimpleImageAccess	withMaxImageSize(BigInteger value)
SimpleImageAccess	withMaxQueryRegionSize(SkySize value)
SimpleImageAccess	withMaxRecords(BigInteger value)
SimpleImageAccess	withStandardID(String value)
SimpleImageAccess	withTestQuery(Query value)
SimpleImageAccess	withValidationLevels(Collection<Validation> values)
SimpleImageAccess	withValidationLevels(Validation... values)

Methods inherited from class org.javastro.ivoa.entities.resource.Capability

getDescription, getInterfaces, getStandardID, getValidationLevels, setDescription, setStandardID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

imageServiceType

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

SimpleImageAccess

public SimpleImageAccess()

Default no-arg constructor

SimpleImageAccess

public SimpleImageAccess(List<Validation> validationLevels,
 String description,
 List<ServiceInterface> interfaces,
 String standardID,
 ImageServiceType imageServiceType,
 SkySize maxQueryRegionSize,
 SkySize maxImageExtent,
 BigInteger maxImageSize,
 BigInteger maxFileSize,
 BigInteger maxRecords,
 Query testQuery)

Fully-initialising value constructor

Method Details

getImageServiceType

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

Sets the value of the imageServiceType property.

Parameters:

value - allowed object is ImageServiceType

See Also:

• getImageServiceType()

getMaxQueryRegionSize

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

Sets the value of the maxQueryRegionSize property.

Parameters:

value - allowed object is SkySize

See Also:

• getMaxQueryRegionSize()

getMaxImageExtent

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

Sets the value of the maxImageExtent property.

Parameters:

value - allowed object is SkySize

See Also:

• getMaxImageExtent()

getMaxImageSize

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

Sets the value of the maxImageSize property.

Parameters:

value - allowed object is BigInteger

See Also:

• getMaxImageSize()

getMaxFileSize

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

Sets the value of the maxFileSize property.

Parameters:

value - allowed object is BigInteger

See Also:

• getMaxFileSize()

getMaxRecords

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

Sets the value of the maxRecords property.

Parameters:

value - allowed object is BigInteger

See Also:

• getMaxRecords()

getTestQuery

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

Sets the value of the testQuery property.

Parameters:

value - allowed object is Query

See Also:

• getTestQuery()

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 SIACapRestriction

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 SIACapRestriction

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 SIACapRestriction

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

Overrides:

append in class SIACapRestriction

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

Overrides:

appendFields in class SIACapRestriction

withImageServiceType

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

withMaxQueryRegionSize

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

withMaxImageExtent

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

withMaxImageSize

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

withMaxFileSize

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

withMaxRecords

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

withTestQuery

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

withValidationLevels

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

Overrides:

withValidationLevels in class SIACapRestriction

withValidationLevels

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

Overrides:

withValidationLevels in class SIACapRestriction

withDescription

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

Overrides:

withDescription in class SIACapRestriction

withInterfaces

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

Overrides:

withInterfaces in class SIACapRestriction

withInterfaces

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

Overrides:

withInterfaces in class SIACapRestriction

withStandardID

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

Overrides:

withStandardID in class SIACapRestriction

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

Overrides:

mergeFrom in class SIACapRestriction

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

Overrides:

mergeFrom in class SIACapRestriction

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

Overrides:

createNewInstance in class Capability