com.tectonica.jonix.onix3.InsertResource Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2012-2024 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.onix3;

import com.tectonica.jonix.common.JPU;
import com.tectonica.jonix.common.ListOfOnixCodelist;
import com.tectonica.jonix.common.ListOfOnixComposite;
import com.tectonica.jonix.common.ListOfOnixDataCompositeWithKey;
import com.tectonica.jonix.common.ListOfOnixElement;
import com.tectonica.jonix.common.OnixComposite.OnixSuperComposite;
import com.tectonica.jonix.common.codelist.RecordSourceTypes;
import com.tectonica.jonix.common.codelist.ResourceFileDateRoles;
import com.tectonica.jonix.common.codelist.ResourceFileDetails;
import com.tectonica.jonix.common.codelist.ResourceFileFeatureTypes;
import com.tectonica.jonix.common.codelist.ResourceIdentifierTypes;
import com.tectonica.jonix.common.struct.JonixResourceFileDate;
import com.tectonica.jonix.common.struct.JonixResourceFileFeature;
import com.tectonica.jonix.common.struct.JonixResourceIdentifier;

import java.io.Serializable;
import java.util.function.Consumer;

/*
 * NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
 */

/**
 * Insert resource composite
 * 
 * A group of data elements that together provide details of a single file or resource of which the insert is composed.
 * At least one <InsertResource> composite is required in each <InsertManifest>, and the
 * <InsertResource> composite is repeatable to describe multiple resources.
 * 
 * 
 * The composite must contain either a Resource file link or a No resource indicator.
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Reference name <InsertResource>
Short tag <insertresource>
Cardinality 1…n
 * 
 * This tag may be included in the following composites:
 * 

 * <{@link InsertManifest}>
 * 
 * 
 * Possible placements within ONIX message:
 * 

 * {@link Product} ⯈ {@link ProductionDetail} ⯈ {@link ProductionManifest} ⯈ {@link SupplementManifest} ⯈
 * {@link InsertManifest} ⯈ {@link InsertResource}
 * {@link Product} ⯈ {@link ProductionDetail} ⯈ {@link ProductionManifest} ⯈ {@link InsertManifest} ⯈
 * {@link InsertResource}
 * 
 *
 * @since Onix-3.08
 */
public class InsertResource implements OnixSuperComposite, Serializable {
    private static final long serialVersionUID = 1L;

    public static final String refname = "InsertResource";
    public static final String shortname = "insertresource";

    /////////////////////////////////////////////////////////////////////////////////
    // ATTRIBUTES
    /////////////////////////////////////////////////////////////////////////////////

    /**
     * (type: dt.DateOrDateTime)
     */
    public String datestamp;

    /**
     * (type: dt.NonEmptyString)
     */
    public String sourcename;

    public RecordSourceTypes sourcetype;

    /////////////////////////////////////////////////////////////////////////////////
    // CONSTRUCTION
    /////////////////////////////////////////////////////////////////////////////////

    private boolean initialized;
    private final boolean exists;
    private final org.w3c.dom.Element element;
    public static final InsertResource EMPTY = new InsertResource();

    public InsertResource() {
        exists = false;
        element = null;
        initialized = true; // so that no further processing will be done on this intentionally-empty object
    }

    public InsertResource(org.w3c.dom.Element element) {
        exists = true;
        initialized = false;
        this.element = element;
        datestamp = JPU.getAttribute(element, "datestamp");
        sourcename = JPU.getAttribute(element, "sourcename");
        sourcetype = RecordSourceTypes.byCode(JPU.getAttribute(element, "sourcetype"));
    }

    @Override
    public void _initialize() {
        if (initialized) {
            return;
        }
        initialized = true;

        JPU.forElementsOf(element, e -> {
            final String name = e.getNodeName();
            switch (name) {
                case ResourceFileLink.refname:
                case ResourceFileLink.shortname:
                    resourceFileLinks = JPU.addToList(resourceFileLinks, new ResourceFileLink(e));
                    break;
                case SequenceNumber.refname:
                case SequenceNumber.shortname:
                    sequenceNumber = new SequenceNumber(e);
                    break;
                case ResourceRole.refname:
                case ResourceRole.shortname:
                    resourceRole = new ResourceRole(e);
                    break;
                case NoResource.refname:
                case NoResource.shortname:
                    noResource = new NoResource(e);
                    break;
                case SalesOutlet.refname:
                case SalesOutlet.shortname:
                    salesOutlets = JPU.addToList(salesOutlets, new SalesOutlet(e));
                    break;
                case ResourceIdentifier.refname:
                case ResourceIdentifier.shortname:
                    resourceIdentifiers = JPU.addToList(resourceIdentifiers, new ResourceIdentifier(e));
                    break;
                case ResourceFileDetail.refname:
                case ResourceFileDetail.shortname:
                    resourceFileDetails = JPU.addToList(resourceFileDetails, new ResourceFileDetail(e));
                    break;
                case ResourceFileFeature.refname:
                case ResourceFileFeature.shortname:
                    resourceFileFeatures = JPU.addToList(resourceFileFeatures, new ResourceFileFeature(e));
                    break;
                case ResourceFileDescription.refname:
                case ResourceFileDescription.shortname:
                    resourceFileDescriptions = JPU.addToList(resourceFileDescriptions, new ResourceFileDescription(e));
                    break;
                case ResourceFileContentDescription.refname:
                case ResourceFileContentDescription.shortname:
                    resourceFileContentDescriptions =
                        JPU.addToList(resourceFileContentDescriptions, new ResourceFileContentDescription(e));
                    break;
                case ResourceFileDate.refname:
                case ResourceFileDate.shortname:
                    resourceFileDates = JPU.addToList(resourceFileDates, new ResourceFileDate(e));
                    break;
                default:
                    break;
            }
        });
    }

    /**
     * @return whether this tag (<InsertResource> or <insertresource>) 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 ListOfOnixElement resourceFileLinks = ListOfOnixElement.empty();

    /**
     * Jonix-Comment: this list is required to contain at least one item
     */
    public ListOfOnixElement resourceFileLinks() {
        _initialize();
        return resourceFileLinks;
    }

    private SequenceNumber sequenceNumber = SequenceNumber.EMPTY;

    /**
     * 
     * A number which (in combination with any <SalesOutlet> composite) specifies a single overall sequence of
     * insert resources. Optional and non-repeating. It is strongly recommended that each occurrence of the
     * <InsertResource> composite should carry a <SequenceNumber>, and that primary resources are numbered
     * in ‘spine order’ (within the insert). Ancillary resources (eg an image file referenced by a primary HTML
     * file) should be numbered after the primary resources.
     * 
     * Jonix-Comment: this field is optional
     */
    public SequenceNumber sequenceNumber() {
        _initialize();
        return sequenceNumber;
    }

    private ResourceRole resourceRole = ResourceRole.EMPTY;

    /**
     * Jonix-Comment: this field is optional
     */
    public ResourceRole resourceRole() {
        _initialize();
        return resourceRole;
    }

    private NoResource noResource = NoResource.EMPTY;

    /**
     * 
     * An empty element that provides a positive indication that there is no alternative ‘generic’ resource to be used
     * in cases where there is a vendor-specific resource (indicated using <SalesOutlet>) with the same
     * <SequenceNumber> specified within the manifest. The empty <NoResource/> must be used – and must only
     * be used – when no <ResourceFileLink> is present.
     * 
     * Jonix-Comment: this field is optional
     */
    public NoResource noResource() {
        _initialize();
        return noResource;
    }

    public boolean isNoResource() {
        return (noResource().exists());
    }

    private ListOfOnixComposite salesOutlets = JPU.emptyListOfOnixComposite(SalesOutlet.class);

    /**
     * Jonix-Comment: this list may be empty
     */
    public ListOfOnixComposite salesOutlets() {
        _initialize();
        return salesOutlets;
    }

    private ListOfOnixDataCompositeWithKey resourceIdentifiers =
            JPU.emptyListOfOnixDataCompositeWithKey(ResourceIdentifier.class);

    /**
     * Jonix-Comment: this list may be empty
     */
    public ListOfOnixDataCompositeWithKey
        resourceIdentifiers() {
        _initialize();
        return resourceIdentifiers;
    }

    private ListOfOnixCodelist resourceFileDetails =
        ListOfOnixCodelist.emptyList();

    /**
     * Jonix-Comment: this list may be empty
     */
    public ListOfOnixCodelist resourceFileDetails() {
        _initialize();
        return resourceFileDetails;
    }

    private ListOfOnixDataCompositeWithKey resourceFileFeatures =
            JPU.emptyListOfOnixDataCompositeWithKey(ResourceFileFeature.class);

    /**
     * Jonix-Comment: this list may be empty
     */
    public ListOfOnixDataCompositeWithKey
        resourceFileFeatures() {
        _initialize();
        return resourceFileFeatures;
    }

    private ListOfOnixElement resourceFileDescriptions = ListOfOnixElement.empty();

    /**
     * Jonix-Comment: this list may be empty
     */
    public ListOfOnixElement resourceFileDescriptions() {
        _initialize();
        return resourceFileDescriptions;
    }

    private ListOfOnixElement resourceFileContentDescriptions =
        ListOfOnixElement.empty();

    /**
     * Jonix-Comment: this list may be empty
     */
    public ListOfOnixElement resourceFileContentDescriptions() {
        _initialize();
        return resourceFileContentDescriptions;
    }

    private ListOfOnixDataCompositeWithKey resourceFileDates = JPU.emptyListOfOnixDataCompositeWithKey(ResourceFileDate.class);

    /**
     * Jonix-Comment: this list may be empty
     */
    public ListOfOnixDataCompositeWithKey
        resourceFileDates() {
        _initialize();
        return resourceFileDates;
    }
}
Reference name	`<InsertResource>`
Short tag	`<insertresource>`
Cardinality	1…n