Package org.ivoa.dm.registry.vodataservice

Class CatalogResource

java.lang.Object
org.ivoa.dm.registry.voresource.Resource
org.ivoa.dm.registry.voresource.Service
org.ivoa.dm.registry.vodataservice.DataResource
org.ivoa.dm.registry.vodataservice.CatalogResource
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
Direct Known Subclasses:
CatalogService
@Entity @VoDml(id="VODataService:CatalogResource", role=objectType) public class CatalogResource extends DataResource implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
A resource giving astronomical data in tabular form. While this includes classical astronomical catalogues, this resource is also appropriate for collections of observations or simulation results provided their metadata are available in a sufficiently structured form (e.g., Obscore, SSAP, etc). objectType: CatalogResource

  • Field Details

    • tableset

      @VoDml(id="VODataService:CatalogResource.tableset", role=composition, type="VODataService:TableSet", typeRole=objectType) protected TableSet tableset
      A description of the tables that are accessible through this service. Each schema name must be unique within a tableset. composition tableset : ( Multiplicity : 0..1 )

  • Constructor Details

    • CatalogResource

      public CatalogResource()
      Creates a new CatalogResource

    • CatalogResource

      public CatalogResource(TableSet tableset, List<ResourceName> facility, List<ResourceName> instrument, Coverage coverage, List<String> productTypeServed, List<Rights> rights, List<Capability> capability, List<Validation> validationLevel, String title, ShortName shortName, IdentifierURI identifier, List<String> altIdentifier, Curation curation, Content content, UTCTimestamp created, UTCTimestamp updated, Resource_status status, String version)
      full parameter constructor.
      Parameters:
      tableset - A description of the tables that are accessible through this service. Each schema name must be unique within a tableset.
      facility - The observatory or facility used to collect the data contained or managed by this resource.
      instrument - The instrument used to collect the data contain or managed by a resource.
      coverage - Extent of the content of the resource over space, time, and frequency.
      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 - 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 - 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 - 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 - the full name given to the resource .
      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 - Unambiguous reference to the resource conforming to the IVOA standard for identifiers .
      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 - Information regarding the general curation of the resource .
      content - Information regarding the general content of the resource .
      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 - 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 - a tag indicating whether this resource is believed to be still actively maintained.
      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.

    • CatalogResource

      public CatalogResource(CatalogResource other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • CatalogResource

      public CatalogResource(DataResource superinstance, TableSet tableset)
      Constructor from supertype instance.
      Parameters:
      superinstance - The supertype.
      tableset - A description of the tables that are accessible through this service. Each schema name must be unique within a tableset.

  • Method Details

    • copyMe

      public Resource copyMe()
      make a clone of the object taking into account current polymorhic type.
      Overrides:
      copyMe in class DataResource
      Returns:
      the cloned object.

    • updateUsing

      public void updateUsing(CatalogResource other)
      Update this object with the content of the given object. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • getTableset

      public TableSet getTableset()
      Returns tableset Attribute.
      Returns:
      tableset Attribute

    • setTableset

      public void setTableset(TableSet pTableset)
      Set tableset Attribute.
      Parameters:
      pTableset - value to set

    • withTableset

      public CatalogResource withTableset(TableSet pTableset)
      fluent setter for tableset Attribute.
      Parameters:
      pTableset - value to set
      Returns:
      CatalogResource

    • createCatalogResource

      public static CatalogResource createCatalogResource(Consumer<CatalogResource.CatalogResourceBuilder> f)
      create a CatalogResource in functional builder style.
      Parameters:
      f - the functional builder.
      Returns:
      an object initialized from the builder.

    • forceLoad

      public void forceLoad()
      Specified by:
      forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations
      Overrides:
      forceLoad in class DataResource

    • delete

      public void delete(jakarta.persistence.EntityManager em)
      Specified by:
      delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
      Overrides:
      delete in class DataResource