All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.tectonica.jonix.onix2.IDValue Maven / Gradle / Ivy

Go to download

Collection of classes for processing Onix-2 sources

There is a newer version: 2024-10-onix308
Show newest version
/*
 * 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
 */

/**
 * 
Identifier value

 * 

 * An identifier of the type specified in the <ProductIDType> element. Mandatory in each occurrence of the
 * <ProductIdentifier> composite, and non-repeating.
 * 

 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
FormatAccording to the identifier type specified in <ProductIDType>
Reference name<IDValue>
Short tag<b244>
Example<IDValue>8474339790</IDValue>

 * 

 * This tag may be included in the following composites:
 * 
    
 * 
  • <{@link WorkIdentifier}>
    • 
 * 
  • <{@link AgentIdentifier}>
    • 
 * 
  • <{@link ConferenceSponsorIdentifier}>
    • 
 * 
  • <{@link SeriesIdentifier}>
    • 
 * 
  • <{@link ProductIdentifier}>
    • 
 * 
  • <{@link LocationIdentifier}>
    • 
 * 
  • <{@link SenderIdentifier}>
    • 
 * 
  • <{@link CopyrightOwnerIdentifier}>
    • 
 * 
  • <{@link TextItemIdentifier}>
    • 
 * 
  • <{@link PersonNameIdentifier}>
    • 
 * 
  • <{@link SupplierIdentifier}>
    • 
 * 
  • <{@link SalesOutletIdentifier}>
    • 
 * 
  • <{@link ParentIdentifier}>
    • 
 * 
  • <{@link AddresseeIdentifier}>
    • 
 * 

 * 

 * Possible placements within ONIX message:
 * 
    
 * 
  • {@link Product} ⯈ {@link WorkIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link ContentItem} ⯈ {@link WorkIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link MarketRepresentation} ⯈ {@link AgentIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link Conference} ⯈ {@link ConferenceSponsor} ⯈ {@link ConferenceSponsorIdentifier} ⯈
 * {@link IDValue}
    • 
 * 
  • {@link SubSeriesRecord} ⯈ {@link SeriesIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link MainSeriesRecord} ⯈ {@link SeriesIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link Series} ⯈ {@link SeriesIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link ProductIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link ContainedItem} ⯈ {@link ProductIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link NotForSale} ⯈ {@link ProductIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link RelatedProduct} ⯈ {@link ProductIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link Set} ⯈ {@link ProductIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link SupplyDetail} ⯈ {@link Stock} ⯈ {@link LocationIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Header} ⯈ {@link SenderIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link CopyrightStatement} ⯈ {@link CopyrightOwner} ⯈ {@link CopyrightOwnerIdentifier} ⯈
 * {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link ContentItem} ⯈ {@link TextItem} ⯈ {@link TextItemIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link Contributor} ⯈ {@link Name} ⯈ {@link PersonNameIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link ContentItem} ⯈ {@link Contributor} ⯈ {@link Name} ⯈ {@link PersonNameIdentifier} ⯈
 * {@link IDValue}
    • 
 * 
  • {@link SubSeriesRecord} ⯈ {@link Contributor} ⯈ {@link Name} ⯈ {@link PersonNameIdentifier} ⯈
 * {@link IDValue}
    • 
 * 
  • {@link MainSeriesRecord} ⯈ {@link Contributor} ⯈ {@link Name} ⯈ {@link PersonNameIdentifier} ⯈
 * {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link Series} ⯈ {@link Contributor} ⯈ {@link Name} ⯈ {@link PersonNameIdentifier} ⯈
 * {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link PersonAsSubject} ⯈ {@link Name} ⯈ {@link PersonNameIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link ContentItem} ⯈ {@link PersonAsSubject} ⯈ {@link Name} ⯈ {@link PersonNameIdentifier} ⯈
 * {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link Contributor} ⯈ {@link PersonNameIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link ContentItem} ⯈ {@link Contributor} ⯈ {@link PersonNameIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link SubSeriesRecord} ⯈ {@link Contributor} ⯈ {@link PersonNameIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link MainSeriesRecord} ⯈ {@link Contributor} ⯈ {@link PersonNameIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link Series} ⯈ {@link Contributor} ⯈ {@link PersonNameIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link PersonAsSubject} ⯈ {@link PersonNameIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link ContentItem} ⯈ {@link PersonAsSubject} ⯈ {@link PersonNameIdentifier} ⯈
 * {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link SupplyDetail} ⯈ {@link SupplierIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link SupplyDetail} ⯈ {@link NewSupplier} ⯈ {@link SupplierIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Product} ⯈ {@link SalesRestriction} ⯈ {@link SalesOutlet} ⯈ {@link SalesOutletIdentifier} ⯈
 * {@link IDValue}
    • 
 * 
  • {@link SubSeriesRecord} ⯈ {@link ParentIdentifier} ⯈ {@link IDValue}
    • 
 * 
  • {@link Header} ⯈ {@link AddresseeIdentifier} ⯈ {@link IDValue}
    • 
 * 

 */
public class IDValue implements OnixElement, Serializable {
    private static final long serialVersionUID = 1L;

    public static final String refname = "IDValue";
    public static final String shortname = "b244";

    /////////////////////////////////////////////////////////////////////////////////
    // 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 IDValue. 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: According to the identifier type specified in <ProductIDType>
     * 

     * (type: NonEmptyString)
     */
    public String value;

    /**
     * Internal API, use the {@link #value()} method or the {@link #value} field instead
     */
    @Override
    public String __v() {
        return value;
    }

    /////////////////////////////////////////////////////////////////////////////////
    // SERVICES
    /////////////////////////////////////////////////////////////////////////////////

    private final boolean exists;
    public static final IDValue EMPTY = new IDValue();

    public IDValue() {
        exists = false;
    }

    public IDValue(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 = JPU.getContentAsString(element);
    }

    /**
     * @return whether this tag (<IDValue> or <b244>) is explicitly provided in the ONIX XML
     */
    @Override
    public boolean exists() {
        return exists;
    }

    public void ifExists(Consumer action) {
        if (exists) {
            action.accept(this);
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy