com.tectonica.jonix.onix2.TextItem 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.ListOfOnixDataComposite;
import com.tectonica.jonix.common.ListOfOnixDataCompositeWithKey;
import com.tectonica.jonix.common.OnixComposite.OnixSuperComposite;
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.TextItemIdentifierTypes;
import com.tectonica.jonix.common.codelist.TransliterationSchemes;
import com.tectonica.jonix.common.struct.JonixPageRun;
import com.tectonica.jonix.common.struct.JonixTextItemIdentifier;
import java.io.Serializable;
import java.util.function.Consumer;
/*
* NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
*/
/**
* Text item composite
*
* A group of data elements which are specific to text content. The composite must occur once and only once in a
* <ContentItem> composite which describes a text content item. (Similar composites are being defined for other
* media, and the occurrence of one of them will be mandatory in any <ContentItem> composite.)
*
*
*
* Reference name
* <TextItem>
*
*
* Short tag
* <textitem>
*
*
*
* This tag may be included in the following composites:
*
* - <{@link ContentItem}>
*
*
* Possible placements within ONIX message:
*
* - {@link Product} ⯈ {@link ContentItem} ⯈ {@link TextItem}
*
*/
public class TextItem implements OnixSuperComposite, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "TextItem";
public static final String shortname = "textitem";
/////////////////////////////////////////////////////////////////////////////////
// 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 TextItem EMPTY = new TextItem();
public TextItem() {
exists = false;
element = null;
initialized = true; // so that no further processing will be done on this intentionally-empty object
}
public TextItem(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 TextItemType.refname:
case TextItemType.shortname:
textItemType = new TextItemType(e);
break;
case FirstPageNumber.refname:
case FirstPageNumber.shortname:
firstPageNumber = new FirstPageNumber(e);
break;
case LastPageNumber.refname:
case LastPageNumber.shortname:
lastPageNumber = new LastPageNumber(e);
break;
case NumberOfPages.refname:
case NumberOfPages.shortname:
numberOfPages = new NumberOfPages(e);
break;
case TextItemIdentifier.refname:
case TextItemIdentifier.shortname:
textItemIdentifiers = JPU.addToList(textItemIdentifiers, new TextItemIdentifier(e));
break;
case PageRun.refname:
case PageRun.shortname:
pageRuns = JPU.addToList(pageRuns, new PageRun(e));
break;
default:
break;
}
});
}
/**
* @return whether this tag (<TextItem> or <textitem>) 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 TextItemType textItemType = TextItemType.EMPTY;
/**
*
* An ONIX code which identifies the nature of a text item. Mandatory in each occurrence of the <TextItem>
* composite, and non-repeatable.
*
* Jonix-Comment: this field is required
*/
public TextItemType textItemType() {
_initialize();
return textItemType;
}
private FirstPageNumber firstPageNumber = FirstPageNumber.EMPTY;
/**
*
* The number of the page on which a text item begins in a paginated product. Optional and non-repeating; required
* when the text item is being referenced as part of a structured table of contents.
*
* Jonix-Comment: this field is required
*/
public FirstPageNumber firstPageNumber() {
_initialize();
return firstPageNumber;
}
private LastPageNumber lastPageNumber = LastPageNumber.EMPTY;
/**
*
* The number of the page on which a text item ends in a paginated product. Optional and non-repeating, and can
* occur only when <FirstPageNumber> is also present.
*
* Jonix-Comment: this field is optional
*/
public LastPageNumber lastPageNumber() {
_initialize();
return lastPageNumber;
}
private NumberOfPages numberOfPages = NumberOfPages.EMPTY;
/**
*
* The page extent of a text item within a paginated product. Optional and non-repeating, but normally expected when
* the text item is being referenced as part of a structured table of contents.
*
* Jonix-Comment: this field is optional
*/
public NumberOfPages numberOfPages() {
_initialize();
return numberOfPages;
}
private ListOfOnixDataCompositeWithKey textItemIdentifiers =
JPU.emptyListOfOnixDataCompositeWithKey(TextItemIdentifier.class);
/**
*
* A repeatable group of data elements which together define an identifier of a text item in accordance with a
* specified scheme. The composite is optional.
*
* Jonix-Comment: this list may be empty
*/
public ListOfOnixDataCompositeWithKey
textItemIdentifiers() {
_initialize();
return textItemIdentifiers;
}
private ListOfOnixDataComposite pageRuns = JPU.emptyListOfOnixDataComposite(PageRun.class);
/**
*
* A repeatable group of data elements which together define a run of contiguous pages on which a text item appears.
* The composite is optional, but may be repeated where the text item covers two or more separate page runs.
*
* Jonix-Comment: this list may be empty
*/
public ListOfOnixDataComposite pageRuns() {
_initialize();
return pageRuns;
}
}