- All Implemented Interfaces:
OnixComposite
,OnixComposite.OnixSuperComposite
,OnixTag
,Serializable
Text item composite
A group of data elements which are specific to text content. Optional, but exactly one of either the <TextItem> composite or the similar <AVItem> composite must occur in a <ContentItem> composite which describes a particular content item. (Similar composites may be defined for other media, and the occurrence of one of them will be mandatory in any <ContentItem> composite.)
Reference name | <TextItem> |
Short tag | <textitem> |
Cardinality | 0…1 |
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.tectonica.jonix.common.OnixComposite
OnixComposite.OnixDataComposite<V extends JonixStruct>, OnixComposite.OnixDataCompositeUncommon, OnixComposite.OnixDataCompositeWithKey<V extends JonixKeyedStruct<K>,
K extends Enum<K> & OnixCodelist>, OnixComposite.OnixSuperComposite -
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
This is an internal API.boolean
exists()
indicates whether this tag exists in the ONIX recordFor advanced use-cases only.void
The page extent of a text item within a paginated product.pageRuns()
A repeatable group of data elements which together define a run of contiguous pages on which a text item appears.A repeatable group of data elements which together define an identifier of a text item in accordance with a specified scheme.An ONIX code which identifies the nature of a text item.
-
Field Details
-
refname
- See Also:
-
shortname
- See Also:
-
datestamp
(type: dt.DateOrDateTime) -
sourcename
(type: dt.NonEmptyString) -
sourcetype
-
EMPTY
-
-
Constructor Details
-
TextItem
public TextItem() -
TextItem
-
-
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 interfaceOnixComposite
-
exists
public boolean exists()Description copied from interface:OnixTag
indicates whether this tag exists in the ONIX record -
ifExists
-
getXmlElement
Description copied from interface:OnixComposite
For advanced use-cases only.- Specified by:
getXmlElement
in interfaceOnixComposite
- Returns:
- native representation of the XML element underlying to this tag
-
textItemType
An ONIX code which identifies the nature of a text item. Mandatory in each occurrence of the <TextItem> composite, and non-repeatable.
Jonix-Comment: this field is required -
numberOfPages
The page extent of a text item within a paginated product. Optional and non-repeating, but normally expected when the text item is being referenced as part of a structured table of contents.
Jonix-Comment: this field is optional -
textItemIdentifiers
public ListOfOnixDataCompositeWithKey<TextItemIdentifier,JonixTextItemIdentifier, textItemIdentifiers()TextItemIdentifierTypes> A repeatable group of data elements which together define an identifier of a text item in accordance with a specified scheme. The composite is optional.
Jonix-Comment: this list may be empty -
pageRuns
A repeatable group of data elements which together define a run of contiguous pages on which a text item appears. The composite is optional, but may be repeated where the text item covers two or more separate page runs.
Jonix-Comment: this list may be empty
-