com.tectonica.jonix.onix2.AgentIdentifier Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jonix-onix2 Show documentation
Show all versions of jonix-onix2 Show documentation
Collection of classes for processing Onix-2 sources
/*
* Copyright (C) 2012-2023 Zach Melamed
*
* Latest version available online at https://github.com/zach-m/jonix
* Contact me at [email protected]
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tectonica.jonix.onix2;
import com.tectonica.jonix.common.JPU;
import com.tectonica.jonix.common.OnixComposite.OnixDataCompositeWithKey;
import com.tectonica.jonix.common.codelist.Languages;
import com.tectonica.jonix.common.codelist.RecordSourceTypes;
import com.tectonica.jonix.common.codelist.SupplierIdentifierTypes;
import com.tectonica.jonix.common.codelist.TextCaseFlags;
import com.tectonica.jonix.common.codelist.TextFormats;
import com.tectonica.jonix.common.codelist.TransliterationSchemes;
import com.tectonica.jonix.common.struct.JonixAgentIdentifier;
import java.io.Serializable;
import java.util.function.Consumer;
/*
* NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
*/
/**
* Agent identifier composite
*
* A group of data elements together defining the identifier of an agent or local publisher in accordance with a
* specified scheme. Optional, but each occurrence of the <MarketRepresentation> composite must carry either at
* least one agent identifier, or an <AgentName>. Repeatable only if two or more identifiers are sent using
* different schemes.
*
*
*
* Reference name
* <AgentIdentifier>
*
*
* Short tag
* <agentidentifier>
*
*
*
* This tag may be included in the following composites:
*
* - <{@link MarketRepresentation}>
*
*
* Possible placements within ONIX message:
*
* - {@link Product} ⯈ {@link MarketRepresentation} ⯈ {@link AgentIdentifier}
*
*
* @since Onix-2.12
*/
public class AgentIdentifier
implements OnixDataCompositeWithKey, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "AgentIdentifier";
public static final String shortname = "agentidentifier";
/////////////////////////////////////////////////////////////////////////////////
// ATTRIBUTES
/////////////////////////////////////////////////////////////////////////////////
public TextFormats textformat;
public TextCaseFlags textcase;
public Languages language;
public TransliterationSchemes transliteration;
/**
* (type: DateOrDateTime)
*/
public String datestamp;
public RecordSourceTypes sourcetype;
public String sourcename;
/////////////////////////////////////////////////////////////////////////////////
// CONSTRUCTION
/////////////////////////////////////////////////////////////////////////////////
private boolean initialized;
private final boolean exists;
private final org.w3c.dom.Element element;
public static final AgentIdentifier EMPTY = new AgentIdentifier();
public AgentIdentifier() {
exists = false;
element = null;
initialized = true; // so that no further processing will be done on this intentionally-empty object
}
public AgentIdentifier(org.w3c.dom.Element element) {
exists = true;
initialized = false;
this.element = element;
textformat = TextFormats.byCode(JPU.getAttribute(element, "textformat"));
textcase = TextCaseFlags.byCode(JPU.getAttribute(element, "textcase"));
language = Languages.byCode(JPU.getAttribute(element, "language"));
transliteration = TransliterationSchemes.byCode(JPU.getAttribute(element, "transliteration"));
datestamp = JPU.getAttribute(element, "datestamp");
sourcetype = RecordSourceTypes.byCode(JPU.getAttribute(element, "sourcetype"));
sourcename = JPU.getAttribute(element, "sourcename");
}
@Override
public void _initialize() {
if (initialized) {
return;
}
initialized = true;
JPU.forElementsOf(element, e -> {
final String name = e.getNodeName();
switch (name) {
case AgentIDType.refname:
case AgentIDType.shortname:
agentIDType = new AgentIDType(e);
break;
case IDValue.refname:
case IDValue.shortname:
idValue = new IDValue(e);
break;
case IDTypeName.refname:
case IDTypeName.shortname:
idTypeName = new IDTypeName(e);
break;
default:
break;
}
});
}
/**
* @return whether this tag (<AgentIdentifier> or <agentidentifier>) is explicitly provided in the ONIX
* XML
*/
@Override
public boolean exists() {
return exists;
}
public void ifExists(Consumer action) {
if (exists) {
action.accept(this);
}
}
@Override
public org.w3c.dom.Element getXmlElement() {
return element;
}
/////////////////////////////////////////////////////////////////////////////////
// MEMBERS
/////////////////////////////////////////////////////////////////////////////////
private AgentIDType agentIDType = AgentIDType.EMPTY;
/**
*
* An ONIX code identifying the scheme from which the identifier in the <IDValue> element is taken. Mandatory
* in each occurrence of the <AgentIdentifier> composite, and non-repeating.
*
* Jonix-Comment: this field is required
*/
public AgentIDType agentIDType() {
_initialize();
return agentIDType;
}
private IDValue idValue = IDValue.EMPTY;
/**
*
* An identifier of the type specified in the <AgentIDType> element. Mandatory in each occurrence of the
* <AgentIdentifier> composite, and non-repeating.
*
* Jonix-Comment: this field is required
*/
public IDValue idValue() {
_initialize();
return idValue;
}
private IDTypeName idTypeName = IDTypeName.EMPTY;
/**
*
* A name which identifies a proprietary identifier scheme when, and only when, the code in the <AgentIDType>
* element indicates a proprietary scheme. Optional and non-repeating.
*
* Jonix-Comment: this field is optional
*/
public IDTypeName idTypeName() {
_initialize();
return idTypeName;
}
@Override
public JonixAgentIdentifier asStruct() {
_initialize();
JonixAgentIdentifier struct = new JonixAgentIdentifier();
struct.agentIDType = agentIDType.value;
struct.idTypeName = idTypeName.value;
struct.idValue = idValue.value;
return struct;
}
@Override
public SupplierIdentifierTypes structKey() {
return agentIDType().value;
}
}