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

Class ResourceFileFeature

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

Resource file feature composite

An optional group of data elements which together describe an aspect of a resource file specified in <ResourceFileLink> that is too specific to be covered in the <ResourceFileDetail> element. It may only be used when <ResourceFileLink> is present, and is repeatable in order to describe different aspects of the resource file.

Reference name <ResourceFileFeature>
Short tag <resourcefilefeature>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.08
See Also:

  • Field Details

  • Constructor Details

    • ResourceFileFeature

      public ResourceFileFeature()

    • ResourceFileFeature

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

    • ifExists

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

    • resourceFileFeatureType

      public ResourceFileFeatureType resourceFileFeatureType()

      An ONIX code which specifies the feature of the resource file described by an instance of the <ResourceFileFeature> composite, eg a checksum or hash for the resource file. Mandatory in each occurrence of the composite, and non-repeating.

      Jonix-Comment: this field is required

    • resourceFileFeatureValue

      public ResourceFileFeatureValue resourceFileFeatureValue()

      A controlled value that specifies a feature of the resource file. Presence or absence of this element depends on the <ResourceFileFeatureType>, since some feature types may not require an accompanying value, while others may require free text in <ResourceFileFeatureDescription> and some may have both code and free text. Non-repeating.

      Jonix-Comment: this field is optional

    • resourceFileFeatureDescriptions

      public ListOfOnixElement<ResourceFileFeatureDescription,String> resourceFileFeatureDescriptions()

      If the <ResourceFileFeatureType> requires free text rather than a code value, or if the code in <ResourceFileFeatureValue> does not adequately specify the feature of the insert, a short text description may be added. Optional, and repeatable to provide parallel descriptive text in multiple languages. The language attribute is optional for a single instance of <ResourceFileFeatureDescription>, but must be included in each instance if <ResourceFileFeatureDescription> is repeated.

      Jonix-Comment: this list may be empty

    • asStruct

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

    • structKey

      public ResourceFileFeatureTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixResourceFileFeature,ResourceFileFeatureTypes>