com.tectonica.jonix.onix2.StockQuantityCoded 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.StockQuantityCodeTypes;
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.JonixStockQuantityCoded;
import java.io.Serializable;
import java.util.function.Consumer;
/*
* NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
*/
/**
* Stock quantity coded composite
*
* A group of data elements which together specify coded stock level without stating the exact quantity of stock. Either
* <StockQuantityCoded> or <OnHand> is mandatory in each occurrence of the <Stock> composite, even if
* the onhand quantity is zero. Non-repeating.
*
*
*
* Reference name
* <StockQuantityCoded>
*
*
* Short tag
* <stockquantitycoded>
*
*
*
* This tag may be included in the following composites:
*
* - <{@link Stock}>
*
*
* Possible placements within ONIX message:
*
* - {@link Product} ⯈ {@link SupplyDetail} ⯈ {@link Stock} ⯈ {@link StockQuantityCoded}
*
*
* @since Onix-2.13
*/
public class StockQuantityCoded
implements OnixDataCompositeWithKey, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "StockQuantityCoded";
public static final String shortname = "stockquantitycoded";
/////////////////////////////////////////////////////////////////////////////////
// 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 StockQuantityCoded EMPTY = new StockQuantityCoded();
public StockQuantityCoded() {
exists = false;
element = null;
initialized = true; // so that no further processing will be done on this intentionally-empty object
}
public StockQuantityCoded(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 StockQuantityCodeType.refname:
case StockQuantityCodeType.shortname:
stockQuantityCodeType = new StockQuantityCodeType(e);
break;
case StockQuantityCode.refname:
case StockQuantityCode.shortname:
stockQuantityCode = new StockQuantityCode(e);
break;
case StockQuantityCodeTypeName.refname:
case StockQuantityCodeTypeName.shortname:
stockQuantityCodeTypeName = new StockQuantityCodeTypeName(e);
break;
default:
break;
}
});
}
/**
* @return whether this tag (<StockQuantityCoded> or <stockquantitycoded>) 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 StockQuantityCodeType stockQuantityCodeType = StockQuantityCodeType.EMPTY;
/**
*
* An ONIX code identifying the scheme from which the value in the <StockQuantityCode> element is taken.
* Mandatory in each occurrence of the <StockQuantityCoded> composite, and non-repeating.
*
* Jonix-Comment: this field is required
*/
public StockQuantityCodeType stockQuantityCodeType() {
_initialize();
return stockQuantityCodeType;
}
private StockQuantityCode stockQuantityCode = StockQuantityCode.EMPTY;
/**
*
* A code value taken from the scheme specified in the <StockQuantityCodeType> element. Mandatory in each
* occurrence of the <StockQuantityCoded> composite, and non-repeating.
*
* Jonix-Comment: this field is required
*/
public StockQuantityCode stockQuantityCode() {
_initialize();
return stockQuantityCode;
}
private StockQuantityCodeTypeName stockQuantityCodeTypeName = StockQuantityCodeTypeName.EMPTY;
/**
*
* A name that identifies a proprietary stock quantity coding scheme when the code in the
* <StockQuantityCodeType> element indicates a proprietary scheme, eg a wholesaler’s own code.
* Optional, and non-repeating.
*
* Jonix-Comment: this field is optional
*/
public StockQuantityCodeTypeName stockQuantityCodeTypeName() {
_initialize();
return stockQuantityCodeTypeName;
}
@Override
public JonixStockQuantityCoded asStruct() {
_initialize();
JonixStockQuantityCoded struct = new JonixStockQuantityCoded();
struct.stockQuantityCodeType = stockQuantityCodeType.value;
struct.stockQuantityCode = stockQuantityCode.value;
struct.stockQuantityCodeTypeName = stockQuantityCodeTypeName.value;
return struct;
}
@Override
public StockQuantityCodeTypes structKey() {
return stockQuantityCodeType().value;
}
}