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

Class InsertPoint

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

Insertion point composite

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.

Reference name <InsertPoint>
Short tag <insertpoint>
Cardinality 1

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.08
See Also:

  • Field Details

  • Constructor Details

    • InsertPoint

      public InsertPoint()

    • InsertPoint

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

    • ifExists

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

    • insertPointType

      public InsertPointType insertPointType()

      An ONIX code specifying the format in which the insertion point is included in <InsertPointValue>.

      Jonix-Comment: this field is required

    • insertPointValue

      public InsertPointValue insertPointValue()

      The point at which the insert must be positioned, in the format specified in <InsertPointType>.

      Jonix-Comment: this field is required

    • asStruct

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

    • structKey

      public InsertPointTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixInsertPoint,InsertPointTypes>