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

Class ResourceFeature

java.lang.Object
com.tectonica.jonix.onix3.ResourceFeature
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixResourceFeature>, OnixComposite.OnixDataCompositeWithKey<JonixResourceFeature,ResourceFeatureTypes>, OnixTag, Serializable
public class ResourceFeature extends Object implements OnixComposite.OnixDataCompositeWithKey<JonixResourceFeature,ResourceFeatureTypes>, Serializable

Resource feature composite

A group of data elements which together describe a feature of a supporting resource which is common to all versions in which the resource is offered. Optional, and repeatable in order to describe multiple features of the resource.

Reference name <ResourceFeature>
Short tag <resourcefeature>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • ResourceFeature

      public ResourceFeature()

    • ResourceFeature

      public ResourceFeature(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 (<ResourceFeature> or <resourcefeature>) is explicitly provided in the ONIX XML

    • ifExists

      public void ifExists(Consumer<ResourceFeature> 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

    • resourceFeatureType

      public ResourceFeatureType resourceFeatureType()

      An ONIX code which specifies the feature described by an instance of the <ResourceFeature> composite. Mandatory in each occurrence of the composite, and non-repeating.

      Jonix-Comment: this field is required

    • featureValue

      public FeatureValue featureValue()

      A controlled value that describes a resource feature. Presence or absence of this element depends on the <ResourceFeatureType>, since some features may not require an accompanying value, while others may require free text in <FeatureNote>; and others may have both code and free text. Non-repeating.

      Jonix-Comment: this field is optional

    • featureNotes

      public ListOfOnixElement<FeatureNote,String> featureNotes()

      If the <ResourceFeatureType> requires free text rather than a code value, or if the code in <FeatureValue> does not adequately describe the feature, a short text note may be added. Optional, and repeatable when parallel notes are provided in multiple languages. The language attribute is optional for a single instance of <FeatureNote>, but must be included in each instance if <FeatureNote> is repeated.

      Jonix-Comment: this list may be empty

    • asStruct

      public JonixResourceFeature asStruct()
      Specified by:
      asStruct in interface OnixComposite.OnixDataComposite<JonixResourceFeature>

    • structKey

      public ResourceFeatureTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixResourceFeature,ResourceFeatureTypes>