Package org.ivoa.dm.registry.vodataservice

Class CatalogResource.CatalogResourceBuilder

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

  • Field Details

    • tableset

      public TableSet tableset
      A description of the tables that are accessible through this service. Each schema name must be unique within a tableset.

    • facility

      public List<ResourceName> facility
      The observatory or facility used to collect the data contained or managed by this resource.

    • instrument

      public List<ResourceName> instrument
      The instrument used to collect the data contain or managed by a resource.

    • coverage

      public Coverage coverage
      Extent of the content of the resource over space, time, and frequency.

    • productTypeServed

      public List<String> productTypeServed
      Collections of data products (e.g., images or spectra) or services serving them define the type of products they contain or serve here. This information is intended to enable global product discovery. Hence, services failing to define their product type(s) may be skipped by clients in global discovery. Product type names must be taken from the IVOA vocabulary http://www.ivoa.net/rdf/product-type.

    • rights

      public List<Rights> rights
      Information about rights held in and over the resource. Mainly for compatibility with DataCite, this element is repeatable. Resource record authors are advised that within the Virtual Observatory clients will typically only display and/or use the rights element occurring first and ignore later elements.

    • capability

      public List<Capability> capability
      a description of a general capability of the service and how to use it. This describes a general function of the service, usually in terms of a standard service protocol (e.g. SIA), but not necessarily so. A service can have many capabilities associated with it, each reflecting different aspects of the functionality it provides.

    • 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

    • CatalogResourceBuilder

      public CatalogResourceBuilder()

  • Method Details

    • create

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