Package org.ivoa.dm.registry.slap

Class SimpleLineAccess.SimpleLineAccessBuilder

java.lang.Object
org.ivoa.dm.registry.slap.SimpleLineAccess.SimpleLineAccessBuilder
Enclosing class:
SimpleLineAccess
public static class SimpleLineAccess.SimpleLineAccessBuilder extends Object
A builder class for SimpleLineAccess, 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 service instance complies with the SLAP standard.
    DataSource
    dataSource
    The category specifying where the data accessed by the service originally came from.
    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.
    Integer
    maxRecords
    The hard limit on the largest number of records that the query operation will return in a single response.
    String
    standardID
    A URI identifier for a standard service.
    Query
    testQuery
    A set of queryData 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
    SimpleLineAccessBuilder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    SimpleLineAccess
    create()
    create a SimpleLineAccess 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 service instance complies with the SLAP standard. Allowed values are 'minimal' and 'full'. See definitions of allowed values for details.

    • dataSource

      public DataSource dataSource
      The category specifying where the data accessed by the service originally came from. Allowed values are 'observational/astrophysical', 'observational/laboratory', 'theoretical'.

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

    • testQuery

      public Query testQuery
      A set of queryData parameters that is expected to produce at least one matched record which can be used to test the service. The value should include all parameters required for the test query but should exclude the baseURL and the REQUEST parameter.

    • 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

    • SimpleLineAccessBuilder

      public SimpleLineAccessBuilder()

  • Method Details

    • create

      public SimpleLineAccess create()
      create a SimpleLineAccess from this builder.
      Returns:
      an object initialized from the builder.