Package org.ivoa.dm.registry.ssa

Class SimpleSpectralAccess.SimpleSpectralAccessBuilder

java.lang.Object

org.ivoa.dm.registry.ssa.SimpleSpectralAccess.SimpleSpectralAccessBuilder

Enclosing class:

SimpleSpectralAccess

public static class SimpleSpectralAccess.SimpleSpectralAccessBuilder
extends Object

A builder class for SimpleSpectralAccess, mainly for use in the functional builder pattern.

Field Summary

Fields

Modifier and Type	Field	Description
ComplianceLevel	complianceLevel	The category indicating the level to which this instance complies with the SSA standard.
List<CreationType>	creationType	The category that describes the process used to produce the dataset.
List<DataSource>	dataSource	The category specifying where the data originally came from.
Integer	defaultMaxRecords	The largest number of records that the service will return when the MAXREC parameter not specified in the query input.
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.
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.
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.
Integer	maxFileSize	The maximum spectrum file size in bytes that will be returned.
Integer	maxRecords	The hard limit on the largest number of records that the query operation will return in a single response.
Double	maxSearchRadius	The largest search radius, in degrees, that will be accepted by the service without returning an error condition.
String	standardID	A URI identifier for a standard service.
List<String>	supportedFrame	Identifiers of spatial reference frames that can be used in the POS parameter.
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
SimpleSpectralAccessBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

complianceLevel

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

dataSource

public List<DataSource> dataSource

The category specifying where the data originally came from. Allowed values are 'survey', 'pointed', 'custom', 'theory', 'artificial'.

creationType

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

supportedFrame

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

maxSearchRadius

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

maxRecords

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

defaultMaxRecords

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

maxAperture

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

maxFileSize

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

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

SimpleSpectralAccessBuilder

public SimpleSpectralAccessBuilder()

Method Details

create

public SimpleSpectralAccess create()

create a SimpleSpectralAccess from this builder.

Returns:

an object initialized from the builder.