Package org.ivoa.dm.registry.ssa

Class SimpleSpectralAccess

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

  • Field Details

    • complianceLevel

      @VoDml(id="SSA:SimpleSpectralAccess.complianceLevel", role=attribute, type="SSA:ComplianceLevel", typeRole=enumeration) protected ComplianceLevel complianceLevel
      The category indicating the level to which this instance complies with the SSA standard. Allowed values are 'query', 'minimal', and 'full'. See definitions of allowed values for details. : Attribute complianceLevel : multiplicity 1

    • dataSource

      @VoDml(id="SSA:SimpleSpectralAccess.dataSource", role=attribute, type="SSA:DataSource", typeRole=enumeration) protected List<DataSource> dataSource
      The category specifying where the data originally came from. Allowed values are 'survey', 'pointed', 'custom', 'theory', 'artificial'. : Attribute dataSource : multiplicity 1..*

    • creationType

      @VoDml(id="SSA:SimpleSpectralAccess.creationType", role=attribute, type="SSA:CreationType", typeRole=enumeration) protected List<CreationType> creationType
      The category that describes the process used to produce the dataset. Typically this describes only the processing performed by the data service, but it could describe some additional earlier processing as well, e.g., if data is partially precomputed. Allowed values are 'archival', 'cutout', 'filtered', 'mosaic', 'projection', 'spectralExtraction', 'catalogExtraction'. : Attribute creationType : multiplicity 1..*

    • supportedFrame

      @VoDml(id="SSA:SimpleSpectralAccess.supportedFrame", role=attribute, type="ivoa:string", typeRole=primitiveType) protected List<String> supportedFrame
      Identifiers of spatial reference frames that can be used in the POS parameter. The identifiers must be taken from the vocabulary http://www.ivoa.net/rdf/refframe. At least one recognized value must be listed when the service supports POS. With SSA v1.1, ICRS must be supported in that case; thus, this list must include at least this value. : Attribute supportedFrame : multiplicity 1..*

    • maxSearchRadius

      @VoDml(id="SSA:SimpleSpectralAccess.maxSearchRadius", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double maxSearchRadius
      The largest search radius, in degrees, that will be accepted by the service without returning an error condition. Not providing this element or specifying a value of 180 indicates that there is no restriction. Not providing a value is the prefered way to indicate that there is no restriction. : Attribute maxSearchRadius : multiplicity 0..1

    • maxRecords

      @VoDml(id="SSA:SimpleSpectralAccess.maxRecords", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer maxRecords
      The hard limit on the largest number of records that the query operation will return in a single response. Not providing this value means that there is no effective limit. 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.). : Attribute maxRecords : multiplicity 0..1

    • defaultMaxRecords

      @VoDml(id="SSA:SimpleSpectralAccess.defaultMaxRecords", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer 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. : Attribute defaultMaxRecords : multiplicity 0..1

    • maxAperture

      @VoDml(id="SSA:SimpleSpectralAccess.maxAperture", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double maxAperture
      The largest aperture that can be supported upon request via the APERTURE input parameter by a service that supports the spectral extraction creation method. A value of 180 or not providing a value means there is no theoretical limit. Not providing a value is the preferred way to indicate that there is no limit. : Attribute maxAperture : multiplicity 0..1

    • maxFileSize

      @VoDml(id="SSA:SimpleSpectralAccess.maxFileSize", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer maxFileSize
      The maximum spectrum file size in bytes that will be returned. Not providing a value indicates that there is no effective limit the size of files that can be returned. 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. : Attribute maxFileSize : multiplicity 0..1

    • testQuery

      @VoDml(id="SSA:SimpleSpectralAccess.testQuery", role=composition, type="SSA: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

    • SimpleSpectralAccess

      public SimpleSpectralAccess()
      Creates a new SimpleSpectralAccess

    • SimpleSpectralAccess

      public SimpleSpectralAccess(ComplianceLevel complianceLevel, List<DataSource> dataSource, List<CreationType> creationType, List<String> supportedFrame, Double maxSearchRadius, Integer maxRecords, Integer defaultMaxRecords, Double maxAperture, Integer maxFileSize, Query testQuery, List<Validation> validationLevel, String description, List<Interface> interface_, String standardID)
      full parameter constructor.
      Parameters:
      complianceLevel - The category indicating the level to which this instance complies with the SSA standard. Allowed values are 'query', 'minimal', and 'full'. See definitions of allowed values for details.
      dataSource - The category specifying where the data originally came from. Allowed values are 'survey', 'pointed', 'custom', 'theory', 'artificial'.
      creationType - The category that describes the process used to produce the dataset. Typically this describes only the processing performed by the data service, but it could describe some additional earlier processing as well, e.g., if data is partially precomputed. Allowed values are 'archival', 'cutout', 'filtered', 'mosaic', 'projection', 'spectralExtraction', 'catalogExtraction'.
      supportedFrame - Identifiers of spatial reference frames that can be used in the POS parameter. The identifiers must be taken from the vocabulary http://www.ivoa.net/rdf/refframe. At least one recognized value must be listed when the service supports POS. With SSA v1.1, ICRS must be supported in that case; thus, this list must include at least this value.
      maxSearchRadius - The largest search radius, in degrees, that will be accepted by the service without returning an error condition. Not providing this element or specifying a value of 180 indicates that there is no restriction. Not providing a value is the prefered way to indicate that there is no restriction.
      maxRecords - The hard limit on the largest number of records that the query operation will return in a single response. Not providing this value means that there is no effective limit. 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 - 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 - The largest aperture that can be supported upon request via the APERTURE input parameter by a service that supports the spectral extraction creation method. A value of 180 or not providing a value means there is no theoretical limit. Not providing a value is the preferred way to indicate that there is no limit.
      maxFileSize - The maximum spectrum file size in bytes that will be returned. Not providing a value indicates that there is no effective limit the size of files that can be returned. 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 - 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.

    • SimpleSpectralAccess

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

    • SimpleSpectralAccess

      public SimpleSpectralAccess(Capability superinstance, ComplianceLevel complianceLevel, List<DataSource> dataSource, List<CreationType> creationType, List<String> supportedFrame, Double maxSearchRadius, Integer maxRecords, Integer defaultMaxRecords, Double maxAperture, Integer maxFileSize, Query testQuery)
      Constructor from supertype instance.
      Parameters:
      superinstance - The supertype.
      complianceLevel - The category indicating the level to which this instance complies with the SSA standard. Allowed values are 'query', 'minimal', and 'full'. See definitions of allowed values for details.
      dataSource - The category specifying where the data originally came from. Allowed values are 'survey', 'pointed', 'custom', 'theory', 'artificial'.
      creationType - The category that describes the process used to produce the dataset. Typically this describes only the processing performed by the data service, but it could describe some additional earlier processing as well, e.g., if data is partially precomputed. Allowed values are 'archival', 'cutout', 'filtered', 'mosaic', 'projection', 'spectralExtraction', 'catalogExtraction'.
      supportedFrame - Identifiers of spatial reference frames that can be used in the POS parameter. The identifiers must be taken from the vocabulary http://www.ivoa.net/rdf/refframe. At least one recognized value must be listed when the service supports POS. With SSA v1.1, ICRS must be supported in that case; thus, this list must include at least this value.
      maxSearchRadius - The largest search radius, in degrees, that will be accepted by the service without returning an error condition. Not providing this element or specifying a value of 180 indicates that there is no restriction. Not providing a value is the prefered way to indicate that there is no restriction.
      maxRecords - The hard limit on the largest number of records that the query operation will return in a single response. Not providing this value means that there is no effective limit. 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 - 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 - The largest aperture that can be supported upon request via the APERTURE input parameter by a service that supports the spectral extraction creation method. A value of 180 or not providing a value means there is no theoretical limit. Not providing a value is the preferred way to indicate that there is no limit.
      maxFileSize - The maximum spectrum file size in bytes that will be returned. Not providing a value indicates that there is no effective limit the size of files that can be returned. 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 - 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(SimpleSpectralAccess 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.

    • getComplianceLevel

      public ComplianceLevel getComplianceLevel()
      Returns complianceLevel Attribute.
      Returns:
      complianceLevel Attribute

    • setComplianceLevel

      public void setComplianceLevel(ComplianceLevel pComplianceLevel)
      Set complianceLevel Attribute.
      Parameters:
      pComplianceLevel - value to set

    • withComplianceLevel

      public SimpleSpectralAccess withComplianceLevel(ComplianceLevel pComplianceLevel)
      fluent setter for complianceLevel Attribute.
      Parameters:
      pComplianceLevel - value to set
      Returns:
      SimpleSpectralAccess

    • getDataSource

      public List<DataSource> getDataSource()
      Returns dataSource Attribute.
      Returns:
      dataSource Attribute

    • setDataSource

      public void setDataSource(List<DataSource> pDataSource)
      Set dataSource Attribute.
      Parameters:
      pDataSource - value to set

    • withDataSource

      public SimpleSpectralAccess withDataSource(List<DataSource> pDataSource)
      fluent setter for dataSource Attribute.
      Parameters:
      pDataSource - value to set
      Returns:
      SimpleSpectralAccess

    • getCreationType

      public List<CreationType> getCreationType()
      Returns creationType Attribute.
      Returns:
      creationType Attribute

    • setCreationType

      public void setCreationType(List<CreationType> pCreationType)
      Set creationType Attribute.
      Parameters:
      pCreationType - value to set

    • withCreationType

      public SimpleSpectralAccess withCreationType(List<CreationType> pCreationType)
      fluent setter for creationType Attribute.
      Parameters:
      pCreationType - value to set
      Returns:
      SimpleSpectralAccess

    • getSupportedFrame

      public List<String> getSupportedFrame()
      Returns supportedFrame Attribute.
      Returns:
      supportedFrame Attribute

    • setSupportedFrame

      public void setSupportedFrame(List<String> pSupportedFrame)
      Set supportedFrame Attribute.
      Parameters:
      pSupportedFrame - value to set

    • withSupportedFrame

      public SimpleSpectralAccess withSupportedFrame(List<String> pSupportedFrame)
      fluent setter for supportedFrame Attribute.
      Parameters:
      pSupportedFrame - value to set
      Returns:
      SimpleSpectralAccess

    • getMaxSearchRadius

      public Double getMaxSearchRadius()
      Returns maxSearchRadius Attribute.
      Returns:
      maxSearchRadius Attribute

    • setMaxSearchRadius

      public void setMaxSearchRadius(Double pMaxSearchRadius)
      Set maxSearchRadius Attribute.
      Parameters:
      pMaxSearchRadius - value to set

    • withMaxSearchRadius

      public SimpleSpectralAccess withMaxSearchRadius(Double pMaxSearchRadius)
      fluent setter for maxSearchRadius Attribute.
      Parameters:
      pMaxSearchRadius - value to set
      Returns:
      SimpleSpectralAccess

    • 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 SimpleSpectralAccess withMaxRecords(Integer pMaxRecords)
      fluent setter for maxRecords Attribute.
      Parameters:
      pMaxRecords - value to set
      Returns:
      SimpleSpectralAccess

    • getDefaultMaxRecords

      public Integer getDefaultMaxRecords()
      Returns defaultMaxRecords Attribute.
      Returns:
      defaultMaxRecords Attribute

    • setDefaultMaxRecords

      public void setDefaultMaxRecords(Integer pDefaultMaxRecords)
      Set defaultMaxRecords Attribute.
      Parameters:
      pDefaultMaxRecords - value to set

    • withDefaultMaxRecords

      public SimpleSpectralAccess withDefaultMaxRecords(Integer pDefaultMaxRecords)
      fluent setter for defaultMaxRecords Attribute.
      Parameters:
      pDefaultMaxRecords - value to set
      Returns:
      SimpleSpectralAccess

    • getMaxAperture

      public Double getMaxAperture()
      Returns maxAperture Attribute.
      Returns:
      maxAperture Attribute

    • setMaxAperture

      public void setMaxAperture(Double pMaxAperture)
      Set maxAperture Attribute.
      Parameters:
      pMaxAperture - value to set

    • withMaxAperture

      public SimpleSpectralAccess withMaxAperture(Double pMaxAperture)
      fluent setter for maxAperture Attribute.
      Parameters:
      pMaxAperture - value to set
      Returns:
      SimpleSpectralAccess

    • 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 SimpleSpectralAccess withMaxFileSize(Integer pMaxFileSize)
      fluent setter for maxFileSize Attribute.
      Parameters:
      pMaxFileSize - value to set
      Returns:
      SimpleSpectralAccess

    • 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 SimpleSpectralAccess withTestQuery(Query pTestQuery)
      fluent setter for testQuery Attribute.
      Parameters:
      pTestQuery - value to set
      Returns:
      SimpleSpectralAccess

    • createSimpleSpectralAccess

      public static SimpleSpectralAccess createSimpleSpectralAccess(Consumer<SimpleSpectralAccess.SimpleSpectralAccessBuilder> f)
      create a SimpleSpectralAccess 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