com.tectonica.jonix.onix2.Website 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.OnixDataComposite;
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 com.tectonica.jonix.common.struct.JonixWebsite;
import java.io.Serializable;
import java.util.Collections;
import java.util.function.Consumer;
/*
* NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
*/
/**
* Website composite
*
* A repeatable group of data elements which together identify and provide pointers to a website which is related to the
* work identified in an occurrence of the <WorkIdentifier> composite.
*
*
*
* Reference name
* <Website>
*
*
* Short tag
* <website>
*
*
*
* This tag may be included in the following composites:
*
* - <{@link Product}>
* - <{@link Conference}>
* - <{@link SupplyDetail}>
* - <{@link MarketRepresentation}>
* - <{@link RelatedProduct}>
* - <{@link ContentItem}>
* - <{@link Contributor}>
* - <{@link Publisher}>
*
*
* Possible placements within ONIX message:
*
* - {@link Product} ⯈ {@link Website}
* - {@link Product} ⯈ {@link Conference} ⯈ {@link Website}
* - {@link Product} ⯈ {@link SupplyDetail} ⯈ {@link Website}
* - {@link Product} ⯈ {@link MarketRepresentation} ⯈ {@link Website}
* - {@link Product} ⯈ {@link RelatedProduct} ⯈ {@link Website}
* - {@link Product} ⯈ {@link ContentItem} ⯈ {@link Website}
* - {@link Product} ⯈ {@link Contributor} ⯈ {@link Website}
* - {@link Product} ⯈ {@link ContentItem} ⯈ {@link Contributor} ⯈ {@link Website}
* - {@link SubSeriesRecord} ⯈ {@link Contributor} ⯈ {@link Website}
* - {@link MainSeriesRecord} ⯈ {@link Contributor} ⯈ {@link Website}
* - {@link Product} ⯈ {@link Series} ⯈ {@link Contributor} ⯈ {@link Website}
* - {@link Product} ⯈ {@link Publisher} ⯈ {@link Website}
* - {@link Product} ⯈ {@link RelatedProduct} ⯈ {@link Publisher} ⯈ {@link Website}
* - {@link SubSeriesRecord} ⯈ {@link Publisher} ⯈ {@link Website}
* - {@link MainSeriesRecord} ⯈ {@link Publisher} ⯈ {@link Website}
*
*
* @since Onix-2.1
*/
public class Website implements OnixDataComposite, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "Website";
public static final String shortname = "website";
/////////////////////////////////////////////////////////////////////////////////
// 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 Website EMPTY = new Website();
public Website() {
exists = false;
element = null;
initialized = true; // so that no further processing will be done on this intentionally-empty object
}
public Website(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 WebsiteLink.refname:
case WebsiteLink.shortname:
websiteLink = new WebsiteLink(e);
break;
case WebsiteRole.refname:
case WebsiteRole.shortname:
websiteRole = new WebsiteRole(e);
break;
case WebsiteDescription.refname:
case WebsiteDescription.shortname:
websiteDescription = new WebsiteDescription(e);
break;
default:
break;
}
});
}
/**
* @return whether this tag (<Website> or <website>) 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 WebsiteLink websiteLink = WebsiteLink.EMPTY;
/**
*
* The URL for the website. Mandatory in each occurrence of the <Website> composite, and non-repeating.
*
* Jonix-Comment: this field is required
*/
public WebsiteLink websiteLink() {
_initialize();
return websiteLink;
}
private WebsiteRole websiteRole = WebsiteRole.EMPTY;
/**
*
* An ONIX code which identifies the role or purpose of the website which is linked through the <WebsiteLink>
* element. Optional and non-repeating.
*
* Jonix-Comment: this field is optional
*/
public WebsiteRole websiteRole() {
_initialize();
return websiteRole;
}
private WebsiteDescription websiteDescription = WebsiteDescription.EMPTY;
/**
*
* Free text describing the nature of the website which is linked through the <WebsiteLink> element. Optional
* and non-repeating.
*
* Jonix-Comment: this field is optional
*/
public WebsiteDescription websiteDescription() {
_initialize();
return websiteDescription;
}
@Override
public JonixWebsite asStruct() {
_initialize();
JonixWebsite struct = new JonixWebsite();
struct.websiteDescriptions =
websiteDescription.exists() ? Collections.singletonList(websiteDescription.value) : Collections.emptyList();
struct.websiteLinks =
websiteLink.exists() ? Collections.singletonList(websiteLink.value) : Collections.emptyList();
struct.websiteRole = websiteRole.value;
return struct;
}
}