- All Implemented Interfaces:
OnixComposite
,OnixComposite.OnixSuperComposite
,OnixTag
,Serializable
Title detail composite (collection)
A group of data elements which together give the text of a collection title and specify its type. Optional, but the composite is required unless the only collection title is carried in full, and word-for-word, as an integral part of the product title in P.6, in which case it should not be repeated in P.5. The composite is repeatable with different title types.
Reference name | <TitleDetail> |
Short tag | <titledetail> |
Cardinality | 0…n |
- 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
Modifier and TypeFieldDescription(type: dt.DateOrDateTime)static final TitleDetail
static final String
static final String
(type: dt.NonEmptyString) -
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
ifExists
(Consumer<TitleDetail> action) A group of data elements which together represent an element of a collection title.Free text showing how the collection title should be presented in any display, particularly when a standard concatenation of individual title elements from Group P.5 (in the order specified by the <SequenceNumber> data elements) would not give a satisfactory result.An ONIX code indicating the type of a title.
-
Field Details
-
refname
- See Also:
-
shortname
- See Also:
-
datestamp
(type: dt.DateOrDateTime) -
sourcename
(type: dt.NonEmptyString) -
sourcetype
-
EMPTY
-
-
Constructor Details
-
TitleDetail
public TitleDetail() -
TitleDetail
-
-
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
-
titleType
An ONIX code indicating the type of a title. Mandatory in each occurrence of the <TitleDetail> composite, and non-repeating.
Jonix-Comment: this field is required -
titleElements
A group of data elements which together represent an element of a collection title. At least one title element is mandatory in each occurrence of the <TitleDetail> composite. The composite is repeatable with different sequence numbers and/or title element levels. An instance of the <TitleElement> composite must include at least one of: <PartNumber>; <YearOfAnnual>; <TitleText>, <NoPrefix/> together with <TitleWithoutPrefix>, or <TitlePrefix> together with <TitleWithoutPrefix>. In other words, it must carry either the text of a title element or a part or year designation, and it may carry both.
A title element must be designated as belonging to product level, collection level, or subcollection level (the first of these may not occur in a title element representing a collective identity, and the last-named may only occur in the case of a multi-level collection).
In the simplest case, title detail sent in a <Collection> composite will consist of a single title element, at collection level. However, the composite structure in ONIX 3.0 and 3.1 allows more complex combinations of titles and part designations in multi-level collections to be correctly represented.
Jonix-Comment: this list is required to contain at least one item -
titleStatement
Free text showing how the collection title should be presented in any display, particularly when a standard concatenation of individual title elements from Group P.5 (in the order specified by the <SequenceNumber> data elements) would not give a satisfactory result. Optional and non-repeating. When this field is sent, the recipient should use it to replace all collection title detail sent in Group P.5 for display purposes only. The individual collection title element detail must also be sent, for indexing and retrieval purposes.
Jonix-Comment: this field is optional
-