Module jonix.common

Package com.tectonica.jonix.common.struct

Class JonixTitleElement

java.lang.Object

com.tectonica.jonix.common.struct.JonixTitleElement

All Implemented Interfaces:

JonixStruct, Serializable

public class JonixTitleElement
extends Object
implements JonixStruct, Serializable

This class is a JonixStruct that represents Onix3 <TitleElement>.

It can be retrieved from the composite by invoking its asStruct() method.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final JonixTitleElement	EMPTY
boolean	isNoPrefix	(optional flag)
String	partNumber	Raw Format: Variable length text, suggested maximum 20 characters
Integer	sequenceNumber	Raw Format: Positive integer, 1, 2, 3 etc, suggested maximum length 3 digits
String	subtitle	Raw Format: Variable length text, suggested maximum 300 characters
TitleElementLevels	titleElementLevel
String	titlePrefix	Raw Format: Variable length text, suggested maximum 20 characters
String	titleText	Raw Format: Variable length text, suggested maximum 300 characters
String	titleWithoutPrefix	Raw Format: Variable length text, suggested maximum 300 characters
String	yearOfAnnual	Raw Format: Year or range of years, in the format YYYY or YYYY-YYYY

Constructor Summary

Constructors

Constructor	Description
JonixTitleElement()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EMPTY

public static final JonixTitleElement EMPTY

sequenceNumber

public Integer sequenceNumber

Raw Format: Positive integer, 1, 2, 3 etc, suggested maximum length 3 digits

(type: dt.PositiveInteger)

titleElementLevel

public TitleElementLevels titleElementLevel

partNumber

public String partNumber

Raw Format: Variable length text, suggested maximum 20 characters

(type: dt.NonEmptyString)

yearOfAnnual

public String yearOfAnnual

Raw Format: Year or range of years, in the format YYYY or YYYY-YYYY

(type: dt.YearOrYearRange)

titlePrefix

public String titlePrefix

Raw Format: Variable length text, suggested maximum 20 characters

(type: dt.NonEmptyString)

isNoPrefix

public boolean isNoPrefix

(optional flag)

titleWithoutPrefix

public String titleWithoutPrefix

Raw Format: Variable length text, suggested maximum 300 characters

(type: dt.NonEmptyString)

titleText

public String titleText

Raw Format: Variable length text, suggested maximum 300 characters

(type: dt.NonEmptyString)

subtitle

public String subtitle

Raw Format: Variable length text, suggested maximum 300 characters

(type: dt.NonEmptyString)

Constructor Details

JonixTitleElement

public JonixTitleElement()