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

Class InsertManifest

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

Insert manifest composite

A group of data elements which together provide manifest details for a single insert within the Product or Product part. These details include:

  • technical specifications for the insert within the final product;
  • details of the file resources required to create the insert;

Note that the high-level specifications such as the Product form, trimmed page size or file type for final delivery are carried in Block 1 – the manifest specifications are more detailed in nature, and must be consistent with the high-level specifications.

Technical specifications in the manifest can be provided either as a pre-defined and named ‘bundle’ encompassing all the required technical details, and/or as a set of individually-specified details. Bundle names are inevitably proprietary. It is possible to provide two or more bundle names if, for example, a physical book is set up for on-demand manufacturing by multiple POD suppliers, and a supplier who does not pre-define bundles can use the individually-specified details.

The composite is optional – it may be omitted where the Product or Product part has no inserts – and is repeatable to provide manifest details for multiple inserts.

Reference name <InsertManifest>
Short tag <insertmanifest>
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

    • InsertManifest

      public InsertManifest()

    • InsertManifest

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

    • ifExists

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

    • insertPoint

      public InsertPoint insertPoint()

      A group of data elements which together specify where within the body of the product the insert must be positioned. For a physical product, this is normally specified as a page number – either a physical printed page number or a ‘logical’ page number which counts all pages in the book block irrespective of any printed page numbers. For physical numbers, an insert may be placed immediately following an even numbered page or preceding an odd numbered page.

      Jonix-Comment: this field is required

    • insertResources

      public ListOfOnixComposite<InsertResource> insertResources()

      A group of data elements that together provide details of a single file or resource of which the insert is composed. At least one <InsertResource> composite is required in each <InsertManifest>, and the <InsertResource> composite is repeatable to describe multiple resources.

      The composite must contain either a Resource file link or a No resource indicator.

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

    • specificationBundleNames

      public ListOfOnixDataComposite<SpecificationBundleName,JonixSpecificationBundleName> specificationBundleNames()

      A group of data elements that together identify a named ‘bundle’ of detailed technical specifications necessary for creation of the body of the final Product or Product part. Bundle names are inevitably proprietary, so both a Name type name and the Name value must be included.

      Jonix-Comment: this list may be empty

    • specificationDetails

      public ListOfOnixCodelist<SpecificationDetail,SpecificationDetails> specificationDetails()

      An ONIX code which specifies added detail of the medium and/or format of the body of the Product or Product part. Optional, and repeatable in order to provide multiple additional details.

      Jonix-Comment: this list may be empty

    • specificationFeatures

      public ListOfOnixDataCompositeWithKey<SpecificationFeature,JonixSpecificationFeature,SpecificationFeatureTypes> specificationFeatures()

      An optional group of data elements which together specify an aspect of the body of the Product or Product part that is too specific to be covered in the <SpecificationDetail> element. Repeatable in order to describe different aspects of the product form.

      Jonix-Comment: this list may be empty

    • specificationDescriptions

      public ListOfOnixElement<SpecificationDescription,String> specificationDescriptions()

      If Specification details and features do not adequately specify the body of the product, a short text description may be added to give a more detailed specification. The field is optional, and repeatable to provide parallel specifications in multiple languages. The language attribute is optional for a single instance of <SpecificationDescription>, but must be included in each instance if <SpecificationDescription> is repeated to provide parallel descriptions in multiple languages.

      Jonix-Comment: this list may be empty