Module jonix.onix3

Package com.tectonica.jonix.onix3

Class RatingUnits

java.lang.Object

com.tectonica.jonix.onix3.RatingUnits

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

public class RatingUnits
extends Object
implements OnixElement<String>, Serializable

Review rating units

The ‘units’ used by a rating, eg stars, tomatoes etc. Optional, and repeatable to provide the units in multiple languages. The language attribute is optional for a single instance of <RatingUnits>, but must be included in each instance if <RatingUnits> is repeated.

Format	Variable length text, suggested maximum length 50 characters
Reference name	<RatingUnits>
Short tag	<x527>
Cardinality	0…n
Attributes	language
Example	<RatingUnits>stars</RatingUnits> (4.5 out of 5 stars)

This tag may be included in the following composites:

• <ReviewRating>

Possible placements within ONIX message:

• Product ⯈ ContentDetail ⯈ ContentItem ⯈ TextContent ⯈ ReviewRating ⯈ RatingUnits
• Product ⯈ CollateralDetail ⯈ TextContent ⯈ ReviewRating ⯈ RatingUnits
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ CitedContent ⯈ ReviewRating ⯈ RatingUnits
• Product ⯈ CollateralDetail ⯈ CitedContent ⯈ ReviewRating ⯈ RatingUnits

Since:

Onix-3.03

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: dt.DateOrDateTime)
static final RatingUnits	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype
String	value	This is the raw content of RatingUnits.

Constructor Summary

Constructors

Constructor	Description
RatingUnits()
RatingUnits(Element element)

Method Summary

Modifier and Type	Method	Description
String	__v()	Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
boolean	exists()	indicates whether this tag exists in the ONIX record
void	ifExists(Consumer<RatingUnits> action)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tectonica.jonix.common.OnixElement

equal, is, isNull, value

Field Details

refname

public static final String refname

See Also:

• Constant Field Values

shortname

public static final String shortname

See Also:

• Constant Field Values

datestamp

public String datestamp

(type: dt.DateOrDateTime)

sourcename

public String sourcename

(type: dt.NonEmptyString)

sourcetype

public RecordSourceTypes sourcetype

language

public Languages language

value

public String value

This is the raw content of RatingUnits. Could be null if exists() == false. Use OnixElement.value() instead if you want to get this as an Optional.

Raw Format: Variable length text, suggested maximum length 50 characters

(type: dt.NonEmptyString)

EMPTY

public static final RatingUnits EMPTY

Constructor Details

RatingUnits

public RatingUnits()

RatingUnits

public RatingUnits(Element element)

Method Details

__v

public String __v()

Internal API, use the OnixElement.value() method or the OnixElement.value() field instead

Specified by:

__v in interface OnixElement<String>

exists

public boolean exists()

Description copied from interface: OnixTag

indicates whether this tag exists in the ONIX record

Specified by:

exists in interface OnixTag

Returns:

whether this tag (<RatingUnits> or <x527>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<RatingUnits> action)