Class SimpleSpectralAccess

java.lang.Object
org.javastro.ivoa.entities.resource.Capability
org.javastro.ivoa.entities.resource.ssap.SimpleSpectralAccess
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 SimpleSpectralAccess extends Capability implements Cloneable, com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString
The capabilities of an SSA service implementation.

Java class for SimpleSpectralAccess complex type

.

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


 <complexType name="SimpleSpectralAccess">
   <complexContent>
     <extension base="{http://www.ivoa.net/xml/VOResource/v1.0}Capability">
       <sequence>
         <element name="complianceLevel" type="{http://www.ivoa.net/xml/SSA/v1.1}ComplianceLevel"/>
         <element name="dataSource" type="{http://www.ivoa.net/xml/SSA/v1.1}DataSource" maxOccurs="unbounded"/>
         <element name="creationType" type="{http://www.ivoa.net/xml/SSA/v1.1}CreationType" maxOccurs="unbounded"/>
         <element name="supportedFrame" type="{http://www.ivoa.net/xml/SSA/v1.1}SupportedFrame" maxOccurs="unbounded"/>
         <element name="maxSearchRadius" type="{http://www.w3.org/2001/XMLSchema}double" minOccurs="0"/>
         <element name="maxRecords" type="{http://www.w3.org/2001/XMLSchema}positiveInteger" minOccurs="0"/>
         <element name="defaultMaxRecords" type="{http://www.w3.org/2001/XMLSchema}positiveInteger" minOccurs="0"/>
         <element name="maxAperture" type="{http://www.w3.org/2001/XMLSchema}double" minOccurs="0"/>
         <element name="maxFileSize" type="{http://www.w3.org/2001/XMLSchema}positiveInteger" minOccurs="0"/>
         <element name="testQuery" type="{http://www.ivoa.net/xml/SSA/v1.1}Query" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 
  • Field Details

    • complianceLevel

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") protected ComplianceLevel complianceLevel
      Allowed values are "query", "minimal", and "full". See definitions of allowed values for details.
    • dataSources

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") protected List<DataSource> dataSources
      Allowed values are "survey", "pointed", "custom", "theory", "artificial"
    • creationTypes

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") protected List<CreationType> creationTypes
      Allowed values are "archival", "cutout", "filtered", "mosaic", "projection", "spectralExtraction", "catalogExtraction"
    • supportedFrames

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") protected List<SupportedFrame> supportedFrames
      At least one recognized value must be listed. With SSA v1.1, ICRS must be supported; thus, this list must include at least this value.
    • maxSearchRadius

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") protected Double maxSearchRadius
      Not providing a value is the prefered way to indicate that there is no restriction.
    • 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 spectra in the archive but rather maximum number of records the service is capable of returning. A limit that is greater than the number of spectra available in the archive is equivalent to their being no effective limit. (See RM, Hanisch 2007.)
    • defaultMaxRecords

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") protected BigInteger defaultMaxRecords
      The largest number of records that the service will return when the MAXREC parameter not specified in the query input. Not providing a value means that the hard limit implied by maxRecords will be the default limit.
    • maxAperture

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") protected Double maxAperture
      Not providing a value is the preferred way to indicate that there is no limit.
    • 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 spectra are created on the fly (see creationType). If the service provides access to static spectra, this should only be specified if there are spectra in the archive that can be searched for but not returned because they are too big.
    • 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

    • getComplianceLevel

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public ComplianceLevel getComplianceLevel()
      Allowed values are "query", "minimal", and "full". See definitions of allowed values for details.
      Returns:
      possible object is ComplianceLevel
    • setComplianceLevel

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

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public List<DataSource> getDataSources()
      Allowed values are "survey", "pointed", "custom", "theory", "artificial" Gets the value of the dataSources property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the dataSources property.

      For example, to add a new item, do as follows:

       getDataSources().add(newItem);
       

      Objects of the following type(s) are allowed in the list DataSource

      Returns:
      The value of the dataSources property.
    • getCreationTypes

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public List<CreationType> getCreationTypes()
      Allowed values are "archival", "cutout", "filtered", "mosaic", "projection", "spectralExtraction", "catalogExtraction" Gets the value of the creationTypes property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the creationTypes property.

      For example, to add a new item, do as follows:

       getCreationTypes().add(newItem);
       

      Objects of the following type(s) are allowed in the list CreationType

      Returns:
      The value of the creationTypes property.
    • getSupportedFrames

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public List<SupportedFrame> getSupportedFrames()
      At least one recognized value must be listed. With SSA v1.1, ICRS must be supported; thus, this list must include at least this value. Gets the value of the supportedFrames property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the supportedFrames property.

      For example, to add a new item, do as follows:

       getSupportedFrames().add(newItem);
       

      Objects of the following type(s) are allowed in the list SupportedFrame

      Returns:
      The value of the supportedFrames property.
    • getMaxSearchRadius

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

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public void setMaxSearchRadius(Double value)
      Sets the value of the maxSearchRadius property.
      Parameters:
      value - allowed object is Double
      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 spectra in the archive but rather maximum number of records the service is capable of returning. A limit that is greater than the number of spectra 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:
    • getDefaultMaxRecords

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public BigInteger getDefaultMaxRecords()
      The largest number of records that the service will return when the MAXREC parameter not specified in the query input. Not providing a value means that the hard limit implied by maxRecords will be the default limit.
      Returns:
      possible object is BigInteger
    • setDefaultMaxRecords

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

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

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public void setMaxAperture(Double value)
      Sets the value of the maxAperture property.
      Parameters:
      value - allowed object is Double
      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 spectra are created on the fly (see creationType). If the service provides access to static spectra, this should only be specified if there are spectra 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:
    • 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 Capability
    • 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 Capability
    • 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 Capability
    • 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 Capability
    • 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 Capability
    • 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 Capability
    • 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 Capability
    • 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 SimpleSpectralAccess clone()
      Overrides:
      clone in class Capability
    • createCopy

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

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

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

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

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public SimpleSpectralAccess.Modifier modifier()
      Overrides:
      modifier in class Capability
    • 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(SimpleSpectralAccess.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> SimpleSpectralAccess.Builder<_B> newCopyBuilder(_B _parentBuilder)
      Overrides:
      newCopyBuilder in class Capability
    • newCopyBuilder

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

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public static SimpleSpectralAccess.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> SimpleSpectralAccess.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> SimpleSpectralAccess.Builder<_B> copyOf(SimpleSpectralAccess _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(SimpleSpectralAccess.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> SimpleSpectralAccess.Builder<_B> newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
      Overrides:
      newCopyBuilder in class Capability
    • newCopyBuilder

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-10-20T18:15:02+01:00") public SimpleSpectralAccess.Builder<Void> newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
      Overrides:
      newCopyBuilder in class Capability
    • 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> SimpleSpectralAccess.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> SimpleSpectralAccess.Builder<_B> copyOf(SimpleSpectralAccess _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 SimpleSpectralAccess.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 SimpleSpectralAccess.Builder<Void> copyExcept(SimpleSpectralAccess _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 SimpleSpectralAccess.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 SimpleSpectralAccess.Builder<Void> copyOnly(SimpleSpectralAccess _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 SimpleSpectralAccess visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)
      Overrides:
      visit in class Capability