com.tectonica.jonix.onix2.AudienceRange 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.ListOfOnixCodelist;
import com.tectonica.jonix.common.ListOfOnixElement;
import com.tectonica.jonix.common.OnixComposite.OnixDataComposite;
import com.tectonica.jonix.common.codelist.AudienceRangePrecisions;
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.JonixAudienceRange;
import java.io.Serializable;
import java.util.function.Consumer;
/*
* NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
*/
/**
* Audience range composite
*
* An optional and repeatable group of data elements which together describe an audience or readership range for which a
* product is intended. The composite can carry a single value from, to, or exact, or a pair of values with an explicit
* from and to. See examples below.
*
*
*
* Reference name
* <AudienceRange>
*
*
* Short tag
* <audiencerange>
*
*
*
* This tag may be included in the following composites:
*
* - <{@link Product}>
*
*
* Possible placements within ONIX message:
*
* - {@link Product} ⯈ {@link AudienceRange}
*
*/
public class AudienceRange implements OnixDataComposite, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "AudienceRange";
public static final String shortname = "audiencerange";
/////////////////////////////////////////////////////////////////////////////////
// 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 AudienceRange EMPTY = new AudienceRange();
public AudienceRange() {
exists = false;
element = null;
initialized = true; // so that no further processing will be done on this intentionally-empty object
}
public AudienceRange(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 AudienceRangeQualifier.refname:
case AudienceRangeQualifier.shortname:
audienceRangeQualifier = new AudienceRangeQualifier(e);
break;
case AudienceRangePrecision.refname:
case AudienceRangePrecision.shortname:
audienceRangePrecisions = JPU.addToList(audienceRangePrecisions, new AudienceRangePrecision(e));
break;
case AudienceRangeValue.refname:
case AudienceRangeValue.shortname:
audienceRangeValues = JPU.addToList(audienceRangeValues, new AudienceRangeValue(e));
break;
default:
break;
}
});
}
/**
* @return whether this tag (<AudienceRange> or <audiencerange>) 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 AudienceRangeQualifier audienceRangeQualifier = AudienceRangeQualifier.EMPTY;
/**
*
* An ONIX code specifying the attribute (age, school grade etc) which is measured by the value in the
* <AudienceRangeValue> element. Mandatory in each occurrence of the <AudienceRange> composite, and
* non-repeating.
*
* Jonix-Comment: this field is required
*/
public AudienceRangeQualifier audienceRangeQualifier() {
_initialize();
return audienceRangeQualifier;
}
private ListOfOnixCodelist audienceRangePrecisions =
ListOfOnixCodelist.emptyList();
/**
*
* An ONIX code specifying the “precision” of the value in the <AudienceRangeValue> element which follows
* (From, To, Exact). Mandatory in each occurrence of the <AudienceRange> composite, and non-repeating.
*
* Jonix-Comment: this list may be empty
*/
public ListOfOnixCodelist audienceRangePrecisions() {
_initialize();
return audienceRangePrecisions;
}
private ListOfOnixElement audienceRangeValues = ListOfOnixElement.empty();
/**
*
* A value indicating an exact position within a range, or the upper or lower end of a range.
*
* Jonix-Comment: this list may be empty
*/
public ListOfOnixElement audienceRangeValues() {
_initialize();
return audienceRangeValues;
}
@Override
public JonixAudienceRange asStruct() {
_initialize();
JonixAudienceRange struct = new JonixAudienceRange();
struct.audienceRangePrecisions = audienceRangePrecisions.values();
struct.audienceRangeQualifier = audienceRangeQualifier.value;
struct.audienceRangeValues = audienceRangeValues.values();
return struct;
}
}