- All Implemented Interfaces:
OnixComposite
,OnixComposite.OnixDataComposite<JonixEventIdentifier>
,OnixComposite.OnixDataCompositeWithKey<JonixEventIdentifier,
,EventIdentifierTypes> OnixTag
,Serializable
Event identifier composite
An optional group of data elements which together define an identifier for an event. The composite is repeatable in order to specify multiple identifiers for the same event.
Reference name | <EventIdentifier> |
Short tag | <eventidentifier> |
Cardinality | 0…n |
- Since:
- Onix-3.07
- 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 EventIdentifier
static final String
static final String
(type: dt.NonEmptyString) -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
This is an internal API.asStruct()
An ONIX code which identifies the scheme from which the value in the <IDValue> element is taken.boolean
exists()
indicates whether this tag exists in the ONIX recordFor advanced use-cases only.A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code).idValue()
A code value taken from the scheme specified in the <EventIDType> element.void
ifExists
(Consumer<EventIdentifier> action)
-
Field Details
-
refname
- See Also:
-
shortname
- See Also:
-
datestamp
(type: dt.DateOrDateTime) -
sourcename
(type: dt.NonEmptyString) -
sourcetype
-
EMPTY
-
-
Constructor Details
-
EventIdentifier
public EventIdentifier() -
EventIdentifier
-
-
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
-
eventIDType
An ONIX code which identifies the scheme from which the value in the <IDValue> element is taken. Since there is no suitable standard event identifier scheme, the only valid option is to use a proprietary identifier. Mandatory in each occurrence of the <EventIdentifier> composite.
Jonix-Comment: this field is required -
idValue
A code value taken from the scheme specified in the <EventIDType> element. Mandatory in each occurrence of the <EventIdentifier> composite, and non-repeating.
Jonix-Comment: this field is required -
idTypeName
A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <EventIDType> element indicates a proprietary scheme. Optional and non-repeating.
Jonix-Comment: this field is optional -
asStruct
- Specified by:
asStruct
in interfaceOnixComposite.OnixDataComposite<JonixEventIdentifier>
-
structKey
- Specified by:
structKey
in interfaceOnixComposite.OnixDataCompositeWithKey<JonixEventIdentifier,
EventIdentifierTypes>
-