- All Implemented Interfaces:
OnixComposite
,OnixComposite.OnixSuperComposite
,OnixTag
,Serializable
Set composite
A repeatable group of data elements which together describe a set of which the product is part.
Reference name | <Set> |
Short tag | <set> |
- <
Product
>
- 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.EAN.UCC-13 article number identifying a set of which the product forms part.boolean
exists()
indicates whether this tag exists in the ONIX recordFor advanced use-cases only.void
A 10-character ISBN identifying a set of which the product forms part.The distinctive enumeration of the product as an item within a set (or within a part of a set).A number which specifies the position of an item in a set within a multi-level hierarchy of such items.A repeatable group of data elements which together define the identifier of a product in accordance with a specified scheme, used here to carry the product identifier for a set.The title which the product carries as an item within a set, eg After Rome in A History of Western Europe, Part II: The Dark Ages, Volume I: After Rome.The distinctive enumeration of a “subset” of which the product is a member, used only when a set is itself divided into two levels, eg A History of Western Europe, Part II: The Dark Ages, Volume I: After Rome.The title of a “subset” of which the product is a member, used only when a set is itself divided into two levels, eg A History of Western Europe, Part II: The Dark Ages, Volume I: After Rome.The full title of the set, without abbreviation or abridgement.titles()
A repeatable group of data elements which together give the text of a title, including a subtitle where applicable, and specify its type.
-
Field Details
-
refname
- See Also:
-
shortname
- See Also:
-
textformat
-
textcase
-
language
-
transliteration
-
datestamp
(type: DateOrDateTime) -
sourcetype
-
sourcename
-
EMPTY
-
-
Constructor Details
-
Set
public Set() -
Set
-
-
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
-
titleOfSet
The full title of the set, without abbreviation or abridgement. Non-repeating. Either the <TitleOfSet> element or at least one occurrence of the <Title> composite must occur in each occurrence of the <Set> composite. The <Title> composite provides a more comprehensive representation of a set title, and allows alternative forms to be sent.
Jonix-Comment: this field is required -
isbnOfSet
A 10-character ISBN identifying a set of which the product forms part. Optional and non-repeating. The <ProductIdentifier> composite on the next page provides a more general method of handling this and other product codes, and is to be preferred.
Jonix-Comment: this field is optional -
ean13OfSet
EAN.UCC-13 article number identifying a set of which the product forms part. Optional and non-repeating. The <ProductIdentifier> composite on the next page provides a more general method of handling this and other product codes, and is to be preferred.
Jonix-Comment: this field is optional -
setPartNumber
The distinctive enumeration of a “subset” of which the product is a member, used only when a set is itself divided into two levels, eg A History of Western Europe, Part II: The Dark Ages, Volume I: After Rome. Optional and non-repeating. Note that this element is used for the first subdivision of a set which has two levels, regardless of the nomenclature (part, volume, etc) which the publisher uses at each level.
Jonix-Comment: this field is optional -
setPartTitle
The title of a “subset” of which the product is a member, used only when a set is itself divided into two levels, eg A History of Western Europe, Part II: The Dark Ages, Volume I: After Rome. Use this field only for the section of the whole title which is shared by, and only by, the members of the subset. Optional and non-repeating. Note that this element is used for the first subdivision of a set which has two levels, regardless of the nomenclature (part, volume, etc) which the publisher uses at each level.
Jonix-Comment: this field is optional -
itemNumberWithinSet
The distinctive enumeration of the product as an item within a set (or within a part of a set). Optional and non-repeating.
Jonix-Comment: this field is optional -
levelSequenceNumber
A number which specifies the position of an item in a set within a multi-level hierarchy of such items. Numbering starts at the top level in the hierarchy, and the first item at the top level is numbered 1. Optional and non-repeating. The purpose of this element is to make it possible to describe structured sets in a normalized way, since enumeration carried as <ItemNumberWithinSet> may take a wide variety of forms.
Jonix-Comment: this field is optional -
setItemTitle
The title which the product carries as an item within a set, eg After Rome in A History of Western Europe, Part II: The Dark Ages, Volume I: After Rome. This will invariably duplicate at least part of the product title in Group PR.7, but by entering it in this group it is possible to assure a correctly structured entry for the set. Optional and non-repeating.
Jonix-Comment: this field is optional -
productIdentifiers
public ListOfOnixDataCompositeWithKey<ProductIdentifier,JonixProductIdentifier, productIdentifiers()ProductIdentifierTypes> A repeatable group of data elements which together define the identifier of a product in accordance with a specified scheme, used here to carry the product identifier for a set. See notes on the <ProductIdentifier> composite in section PR.2 for details of the handling of ISBN-13.
Jonix-Comment: this list may be empty -
titles
A repeatable group of data elements which together give the text of a title, including a subtitle where applicable, and specify its type. Please see Group PR.7 for details.
Jonix-Comment: this list may be empty
-