com.tectonica.jonix.onix2.MarketTerritory Maven / Gradle / Ivy
Show all versions of jonix-onix2 Show documentation
/*
* 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.OnixElement;
import com.tectonica.jonix.common.codelist.Languages;
import com.tectonica.jonix.common.codelist.RecordSourceTypes;
import com.tectonica.jonix.common.codelist.TextCaseFlags;
import com.tectonica.jonix.common.codelist.TextFormats;
import com.tectonica.jonix.common.codelist.TransliterationSchemes;
import java.io.Serializable;
import java.util.function.Consumer;
/*
* NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
*/
/**
* Market territory
*
* One or more ONIX codes identifying a territory which is not a country, but which is precisely defined in geographical
* terms, eg World, Northern Ireland, Australian Capital Territory. Successive codes are separated by spaces.
* Thus the element can carry an unlimited number of territory codes. Optional, but each occurrence of the
* <MarketRepresentation> composite must carry either an occurrence of <MarketCountry> or an occurrence of
* <MarketTerritory>, to specify the market concerned. Non-repeating.
*
*
*
* Format
* One or more variable-length codes, each consisting of upper case letters with or without a hyphen, successive
* codes being separated by spaces. Suggested maximum length 100 characters.
*
*
* Codelist
* List 49 Where possible and appropriate, country subdivision codes are derived from the UN LOCODE scheme based on
* ISO 3166.
*
*
* Reference name
* <MarketTerritory>
*
*
* Short tag
* <j404>
*
*
* Example
* <MarketTerritory>WORLD</MarketTerritory> Whole world
*
*
* <MarketTerritory>GB-EWS</MarketTerritory> UK excluding Northern Ireland
*
*
*
* This tag may be included in the following composites:
*
* - <{@link MarketRepresentation}>
*
*
* Possible placements within ONIX message:
*
* - {@link Product} ⯈ {@link MarketRepresentation} ⯈ {@link MarketTerritory}
*
*
* @since Onix-2.12
*/
public class MarketTerritory implements OnixElement>, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "MarketTerritory";
public static final String shortname = "j404";
/////////////////////////////////////////////////////////////////////////////////
// ATTRIBUTES
/////////////////////////////////////////////////////////////////////////////////
public TextFormats textformat;
public TextCaseFlags textcase;
public Languages language;
public TransliterationSchemes transliteration;
/**
* (type: DateOrDateTime)
*/
public String datestamp;
public RecordSourceTypes sourcetype;
public String sourcename;
/////////////////////////////////////////////////////////////////////////////////
// VALUE MEMBER
/////////////////////////////////////////////////////////////////////////////////
/**
* This is the raw content of MarketTerritory. Could be null if {@code exists() == false}. Use {@link #value()}
* instead if you want to get this as an {@link java.util.Optional}.
*
* Raw Format: One or more variable-length codes, each consisting of upper case letters with or without a hyphen,
* successive codes being separated by spaces. Suggested maximum length 100 characters.
*
* (type: NonEmptyString)
*/
public java.util.Set value;
/**
* Internal API, use the {@link #value()} method or the {@link #value} field instead
*/
@Override
public java.util.Set __v() {
return value;
}
/////////////////////////////////////////////////////////////////////////////////
// SERVICES
/////////////////////////////////////////////////////////////////////////////////
private final boolean exists;
public static final MarketTerritory EMPTY = new MarketTerritory();
public MarketTerritory() {
exists = false;
}
public MarketTerritory(org.w3c.dom.Element element) {
exists = true;
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");
value = new java.util.HashSet<>();
for (String split : JPU.getContentAsString(element).split(" +")) {
value.add(String.valueOf(split));
}
}
/**
* @return whether this tag (<MarketTerritory> or <j404>) is explicitly provided in the ONIX XML
*/
@Override
public boolean exists() {
return exists;
}
public void ifExists(Consumer action) {
if (exists) {
action.accept(this);
}
}
}