Package org.ivoa.dm.registry.voresource

Class Capability.CapabilityBuilder

java.lang.Object
org.ivoa.dm.registry.voresource.Capability.CapabilityBuilder
Enclosing class:
Capability
public static class Capability.CapabilityBuilder extends Object
A builder class for Capability, mainly for use in the functional builder pattern.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    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.
    String
    standardID
    A URI identifier for a standard 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
    CapabilityBuilder()
     

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Field Details

    • 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

    • CapabilityBuilder

      public CapabilityBuilder()

  • Method Details

    • create

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