Package org.ivoa.dm.registry.vodataservice

Class DataCollection

java.lang.Object
org.ivoa.dm.registry.voresource.Resource
org.ivoa.dm.registry.vodataservice.DataCollection
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="VODataService:DataCollection", role=objectType) public class DataCollection extends Resource implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
A logical grouping of data which, in general, is composed of one or more accessible datasets. A collection can contain any combination of images, spectra, catalogues, or other data. (A dataset is a collection of digitally-encoded data that is normally accessible as a single unit, e.g., a file.) This type is deprecated. Resource record authors should use vs:CatalogResource instead. This type will be removed from the schema when no resource record using it remains in the registry. objectType: DataCollection

  • Field Details

    • facility

      @VoDml(id="VODataService:DataCollection.facility", role=attribute, type="VOResource:ResourceName", typeRole=dataType) protected List<ResourceName> facility
      the observatory or facility used to collect the data contained or managed by this resource. : Attribute facility : multiplicity 0..*

    • instrument

      @VoDml(id="VODataService:DataCollection.instrument", role=attribute, type="VOResource:ResourceName", typeRole=dataType) protected List<ResourceName> instrument
      the Instrument used to collect the data contain or managed by a resource. : Attribute instrument : multiplicity 0..*

    • rights

      @VoDml(id="VODataService:DataCollection.rights", role=attribute, type="VOResource:Rights", typeRole=dataType) protected List<Rights> rights
      Information about rights held in and over the resource. This should be repeated for all Rights values that apply. : Attribute rights : multiplicity 0..*

    • format

      @VoDml(id="VODataService:DataCollection.format", role=attribute, type="VODataService:Format", typeRole=dataType) protected List<Format> format
      The physical or digital manifestation of the information supported by a resource. This should use RFC 2046 media (“MIME”) types for network-retrievable, digital data. Non-RFC 2046 values could be used for media that cannot be retrieved over the network. : Attribute format : multiplicity 0..*

    • coverage

      @VoDml(id="VODataService:DataCollection.coverage", role=composition, type="VODataService:Coverage", typeRole=objectType) protected Coverage coverage
      Extent of the content of the resource over space, time, and frequency. composition coverage : ( Multiplicity : 0..1 )

    • tableset

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

    • accessURL

      @VoDml(id="VODataService:DataCollection.accessURL", role=composition, type="VOResource:AccessURL", typeRole=objectType) protected AccessURL accessURL
      The URL that can be used to download the data contained in this data collection. composition accessURL : ( Multiplicity : 0..1 )

  • Constructor Details

    • DataCollection

      public DataCollection()
      Creates a new DataCollection

    • DataCollection

      public DataCollection(List<ResourceName> facility, List<ResourceName> instrument, List<Rights> rights, List<Format> format, Coverage coverage, TableSet tableset, AccessURL accessURL, 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:
      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.
      rights - Information about rights held in and over the resource. This should be repeated for all Rights values that apply.
      format - The physical or digital manifestation of the information supported by a resource. This should use RFC 2046 media (“MIME”) types for network-retrievable, digital data. Non-RFC 2046 values could be used for media that cannot be retrieved over the network.
      coverage - Extent of the content of the resource over space, time, and frequency.
      tableset - A description of the tables that are part of this collection. Each schema name must be unique within a tableset.
      accessURL - The URL that can be used to download the data contained in this data collection.
      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.

    • DataCollection

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

    • DataCollection

      public DataCollection(Resource superinstance, List<ResourceName> facility, List<ResourceName> instrument, List<Rights> rights, List<Format> format, Coverage coverage, TableSet tableset, AccessURL accessURL)
      Constructor from supertype instance.
      Parameters:
      superinstance - The supertype.
      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.
      rights - Information about rights held in and over the resource. This should be repeated for all Rights values that apply.
      format - The physical or digital manifestation of the information supported by a resource. This should use RFC 2046 media (“MIME”) types for network-retrievable, digital data. Non-RFC 2046 values could be used for media that cannot be retrieved over the network.
      coverage - Extent of the content of the resource over space, time, and frequency.
      tableset - A description of the tables that are part of this collection. Each schema name must be unique within a tableset.
      accessURL - The URL that can be used to download the data contained in this data collection.

  • Method Details

    • copyMe

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

    • updateUsing

      public void updateUsing(DataCollection 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.

    • getFacility

      public List<ResourceName> getFacility()
      Returns facility Attribute.
      Returns:
      facility Attribute

    • setFacility

      public void setFacility(List<ResourceName> pFacility)
      Set facility Attribute.
      Parameters:
      pFacility - value to set

    • withFacility

      public DataCollection withFacility(List<ResourceName> pFacility)
      fluent setter for facility Attribute.
      Parameters:
      pFacility - value to set
      Returns:
      DataCollection

    • getInstrument

      public List<ResourceName> getInstrument()
      Returns instrument Attribute.
      Returns:
      instrument Attribute

    • setInstrument

      public void setInstrument(List<ResourceName> pInstrument)
      Set instrument Attribute.
      Parameters:
      pInstrument - value to set

    • withInstrument

      public DataCollection withInstrument(List<ResourceName> pInstrument)
      fluent setter for instrument Attribute.
      Parameters:
      pInstrument - value to set
      Returns:
      DataCollection

    • getRights

      public List<Rights> getRights()
      Returns rights Attribute.
      Returns:
      rights Attribute

    • setRights

      public void setRights(List<Rights> pRights)
      Set rights Attribute.
      Parameters:
      pRights - value to set

    • withRights

      public DataCollection withRights(List<Rights> pRights)
      fluent setter for rights Attribute.
      Parameters:
      pRights - value to set
      Returns:
      DataCollection

    • getFormat

      public List<Format> getFormat()
      Returns format Attribute.
      Returns:
      format Attribute

    • setFormat

      public void setFormat(List<Format> pFormat)
      Set format Attribute.
      Parameters:
      pFormat - value to set

    • withFormat

      public DataCollection withFormat(List<Format> pFormat)
      fluent setter for format Attribute.
      Parameters:
      pFormat - value to set
      Returns:
      DataCollection

    • getCoverage

      public Coverage getCoverage()
      Returns coverage Attribute.
      Returns:
      coverage Attribute

    • setCoverage

      public void setCoverage(Coverage pCoverage)
      Set coverage Attribute.
      Parameters:
      pCoverage - value to set

    • withCoverage

      public DataCollection withCoverage(Coverage pCoverage)
      fluent setter for coverage Attribute.
      Parameters:
      pCoverage - value to set
      Returns:
      DataCollection

    • 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 DataCollection withTableset(TableSet pTableset)
      fluent setter for tableset Attribute.
      Parameters:
      pTableset - value to set
      Returns:
      DataCollection

    • getAccessURL

      public AccessURL getAccessURL()
      Returns accessURL Attribute.
      Returns:
      accessURL Attribute

    • setAccessURL

      public void setAccessURL(AccessURL pAccessURL)
      Set accessURL Attribute.
      Parameters:
      pAccessURL - value to set

    • withAccessURL

      public DataCollection withAccessURL(AccessURL pAccessURL)
      fluent setter for accessURL Attribute.
      Parameters:
      pAccessURL - value to set
      Returns:
      DataCollection

    • createDataCollection

      public static DataCollection createDataCollection(Consumer<DataCollection.DataCollectionBuilder> f)
      create a DataCollection 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 Resource

    • delete

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