Module jonix.onix3
Package com.tectonica.jonix.onix3

Class ResourceVersion

java.lang.Object
com.tectonica.jonix.onix3.ResourceVersion
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable
public class ResourceVersion extends Object implements OnixComposite.OnixSuperComposite, Serializable

Resource version composite

A group of data elements which together describe a single version of a supporting resource, for example a particular format of a cover image. At least one instance is mandatory in each occurrence of the <SupportingResource> composite, and the composite should be repeated as necessary if the resource is offered in multiple versions.

Reference name <ResourceVersion>
Short tag <resourceversion>
Cardinality 1…n

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • ResourceVersion

      public ResourceVersion()

    • ResourceVersion

      public ResourceVersion(Element element)

  • Method Details

    • _initialize

      public void _initialize()
      Description copied from interface: OnixComposite
      This is an internal API. Since Jonix 8.0, composite objects are being populated lazily. This method initiates the population process, and is invoked internally by the accessor APIs of the composites
      Specified by:
      _initialize in interface OnixComposite

    • exists

      public boolean exists()
      Description copied from interface: OnixTag
      indicates whether this tag exists in the ONIX record
      Specified by:
      exists in interface OnixTag
      Returns:
      whether this tag (<ResourceVersion> or <resourceversion>) is explicitly provided in the ONIX XML

    • ifExists

      public void ifExists(Consumer<ResourceVersion> action)

    • getXmlElement

      public Element getXmlElement()
      Description copied from interface: OnixComposite
      For advanced use-cases only.
      Specified by:
      getXmlElement in interface OnixComposite
      Returns:
      native representation of the XML element underlying to this tag

    • resourceForm

      public ResourceForm resourceForm()

      An ONIX code indicating the form of a version of a supporting resource. Mandatory in each occurrence of the <ResourceVersion> composite, and non-repeating.

      Jonix-Comment: this field is required

    • resourceLinks

      public ListOfOnixElement<ResourceLink,String> resourceLinks()

      A URL which provides a link to a supporting resource. Mandatory in each occurrence of the <ResourceVersion> composite, and repeatable if the resource can be linked in more than one way, eg by URL or DOI, or where a supporting resource is available in multiple parallel languages. Where multiple languages are used, all repeats must carry the language attribute.

      Jonix-Comment: this list is required to contain at least one item

    • resourceVersionFeatures

      public ListOfOnixDataCompositeWithKey<ResourceVersionFeature,JonixResourceVersionFeature,ResourceVersionFeatureTypes> resourceVersionFeatures()

      A group of data elements which together describe a feature of a supporting resource which is specific to a particular version in which the resource is offered. Formally optional, but it is unlikely that a supporting resource version could be adequately described without specifying some of its features. Repeatable in order to specify multiple features of the version of the resource.

      Jonix-Comment: this list may be empty

    • epubUsageConstraints

      public ListOfOnixComposite<EpubUsageConstraint> epubUsageConstraints()

      An optional group of data elements which together describe a usage constraint specific to a particular version of the resource offered. Repeatable in order to describe multiple constraints on usage.

      Jonix-Comment: this list may be empty

    • epubLicenses

      public ListOfOnixComposite<EpubLicenseWithDateType> epubLicenses()
      Jonix-Comment: this list may be empty

    • contentDates

      public ListOfOnixDataCompositeWithKey<ContentDate,JonixContentDate,ContentDateRoles> contentDates()

      An optional group of data elements which together specify a date associated with a supporting resource version, eg the date until which the resource version will be available for download. Repeatable to specify different dates with their various roles.

      Jonix-Comment: this list may be empty