- All Implemented Interfaces:
OnixComposite
,OnixComposite.OnixDataComposite<JonixTitle>
,OnixComposite.OnixDataCompositeWithKey<JonixTitle,
,TitleTypes> OnixTag
,Serializable
Title composite
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.
Reference name | <Title> |
Short tag | <title> |
- <
Product
> - <
ContentItem
> - <
Set
> - <
SubSeriesRecord
> - <
MainSeriesRecord
> - <
Series
>
Product
⯈Title
Product
⯈ContentItem
⯈Title
Product
⯈Set
⯈Title
SubSeriesRecord
⯈Title
MainSeriesRecord
⯈Title
Product
⯈Series
⯈Title
- Since:
- Onix-2.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.If the <Title> composite is used to carry an abbreviated title, the length to which the title is abbreviated may be indicated by giving the maximum number of characters (regardless of whether in each specific instance abbreviation has been required in order to meet this limit).asStruct()
boolean
exists()
indicates whether this tag exists in the ONIX recordFor advanced use-cases only.void
subtitle()
The full text of a subtitle, if any.An ONIX code indicating the case in which the text elements in an occurrence of the <Title> composite are sent.Text at the beginning of a title which is to be ignored for alphabetical sorting.The text of the title specified by the <TitleType> code; and excluding the subtitle, if any.An ONIX code indicating the type of a title.Full text of a title, without abbreviation or abridgement, and without the title prefix; and excluding the subtitle, if any.
-
Field Details
-
refname
- See Also:
-
shortname
- See Also:
-
textformat
-
textcase
-
language
-
transliteration
-
datestamp
(type: DateOrDateTime) -
sourcetype
-
sourcename
-
EMPTY
-
-
Constructor Details
-
Title
public Title() -
Title
-
-
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 <Title> composite, and non-repeating. Additional types of title can now be defined by adding code values without requiring a new ONIX release.
Jonix-Comment: this field is required -
titleText
The text of the title specified by the <TitleType> code; and excluding the subtitle, if any. Optional and non-repeating: see text at the head of the <Title> composite for details of valid title text options. The <TitleText> element may carry any of the following ONIX attributes: textformat, language, transliteration, textcase.
Jonix-Comment: this field is required -
abbreviatedLength
If the <Title> composite is used to carry an abbreviated title, the length to which the title is abbreviated may be indicated by giving the maximum number of characters (regardless of whether in each specific instance abbreviation has been required in order to meet this limit). The <TitleType> code should indicate the form of the title that has been abbreviated. Optional and non-repeating. If this element is present, the <TitleText> element must be used to carry the abbreviated form. [The option also exists to send an abbreviated title as a separate <TitleType> without using <AbbreviatedLength>, which is simpler, but less informative.]
Jonix-Comment: this field is optional -
textCaseFlag
An ONIX code indicating the case in which the text elements in an occurrence of the <Title> composite are sent. The default is “unspecified”. Optional and non-repeating. Text case can now be indicated by an XML attribute on any text element, and this method is preferred. See ONIX for Books – Product Information Message – XML Message Specification, Section 4.
Jonix-Comment: this field is optional -
titlePrefix
Text at the beginning of a title which is to be ignored for alphabetical sorting. Optional and non-repeating; can only be used if the <TitleWithoutPrefix> element is also present. These two elements may be used in combination in applications where it is necessary to distinguish an initial word or character string which is to be ignored for filing purposes, eg in library systems and in some bookshop databases. The <TitlePrefix> element may carry any of the following ONIX attributes: textformat, language, transliteration, textcase.
Jonix-Comment: this field is optional -
titleWithoutPrefix
Full text of a title, without abbreviation or abridgement, and without the title prefix; and excluding the subtitle, if any. Optional and non-repeating; can only be used if the <TitlePrefix> element is also present. The <TitleWithoutPrefix> element may carry any of the following ONIX attributes: textformat, language, transliteration, textcase.
Jonix-Comment: this field is optional -
subtitle
The full text of a subtitle, if any. “Subtitle” means any added words which appear with the title given in an occurrence of the <Title> composite, and which amplify and explain the title, but which are not considered to be part of the title itself. Optional and non-repeating. The <Subtitle> element may carry any of the following ONIX attributes: textformat, language, transliteration, textcase.
Jonix-Comment: this field is optional -
asStruct
- Specified by:
asStruct
in interfaceOnixComposite.OnixDataComposite<JonixTitle>
-
structKey
- Specified by:
structKey
in interfaceOnixComposite.OnixDataCompositeWithKey<JonixTitle,
TitleTypes>
-