Package org.ivoa.dm.registry.standard

Class ServiceStandard.ServiceStandardBuilder

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

  • Field Details

    • interface_

      public List<Interface> interface_
      an abstract description of one of the interfaces defined by this service standard. This element can provide details about the interface that apply to all implementations. Each interface element should specify a role with a value starting with 'std:' or, if there is only one standard interface, is equal to 'std'. Applications that, for example, wish to build a GUI to the service on-the-fly would first access this generic description. Site-specific variations, such as supported optional arguments or site specific arguments, would be given in the actual implemented service description and overrides any common information found in this generic description. This generic interface description can be matched with the site-specific one using the role attribute. Even though the Interface type requires an accessURL child element, this element is intended to describe a service in the abstract--i.e. without reference to a particular installation of the service. Consequently, the accessURL may contain a bogus URL; applications should not expect it to be resolvable.

    • endorsedVersion

      public List<EndorsedVersion> endorsedVersion
      the version of the standard that is recommended for use. More than one version can be listed, indicating that any of these versions are recognized as acceptable for use.

    • schema

      public List<Schema> schema
      a description and pointer to a schema document defined by this standard. This is most typically an XML Schema, but it need not be strictly.

    • deprecated

      public String deprecated
      when present, this element indicates that all versions of the standard are considered deprecated by the publisher. The value is a human-readable explanation for the designation. The explanation should indicate if another standard should be preferred.

    • key

      public List<StandardKey> key
      a defined key associated with this standard.

    • validationLevel

      public List<Validation> validationLevel
      A numeric grade describing the quality of the resource description, 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:Validation for an explanation of the allowed levels. Note that when this resource is a Service, this grade applies to the core set of metadata. Capability and interface metadata, as well as the compliance of the service with the interface standard, is rated by validationLevel tag in the capability element (see the VOResource:Service complex type).

    • title

      public String title
      the full name given to the resource .

    • shortName

      public ShortName shortName
      A short name or abbreviation given to the resource. This name will be used where brief annotations for the resource name are required. Applications may use to refer to this resource in a compact display. One word or a few letters is recommended. No more than sixteen characters are allowed.

    • identifier

      public IdentifierURI identifier
      Unambiguous reference to the resource conforming to the IVOA standard for identifiers .

    • altIdentifier

      public List<String> altIdentifier
      A reference to this resource in a non-IVOA identifier scheme, e.g., DOI or bibcode. Always use the an URI scheme here, e.g., doi:10.1016/j.epsl.2011.11.037. For bibcodes, use a form like bibcode:2008ivoa.spec.0222P.

    • curation

      public Curation curation
      Information regarding the general curation of the resource .

    • content

      public Content content
      Information regarding the general content of the resource .

    • created

      public UTCTimestamp created
      The UTC date and time this resource metadata description was created. This timestamp must not be in the future. This time is not required to be accurate; it should be at least accurate to the day. Any non-significant time fields should be set to zero.

    • updated

      public UTCTimestamp updated
      The UTC date this resource metadata description was last updated. This timestamp must not be in the future. This time is not required to be accurate; it should be at least accurate to the day. Any non-significant time fields should be set to zero.

    • status

      public Resource_status status
      a tag indicating whether this resource is believed to be still actively maintained.

    • version

      public String version
      The VOResource XML schema version against which this instance was written. Implementors should set this to the value of the version attribute of their schema's root (xs:schema) element. Clients may assume version 1.0 if this attribute is missing.

  • Constructor Details

    • ServiceStandardBuilder

      public ServiceStandardBuilder()

  • Method Details

    • create

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