Module jonix.onix3

Package com.tectonica.jonix.onix3

Class Rating

java.lang.Object

com.tectonica.jonix.onix3.Rating

All Implemented Interfaces:

OnixElement<Double>, OnixTag, Serializable

public class Rating
extends Object
implements OnixElement<Double>, Serializable

Review rating

The ‘star rating’ awarded as part of a review of the publication. Mandatory within an occurrence of the <ReviewRating> composite, and non-repeating.

Format	Positive real number, with explicit decimal point when required, or zero, as appropriate for the limit specified in <RatingLimit>. Suggested maximum length 7 characters
Reference name	<Rating>
Short tag	<x525>
Cardinality	1
Example	<Rating>4.5</Rating> (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 ⯈ Rating
• Product ⯈ CollateralDetail ⯈ TextContent ⯈ ReviewRating ⯈ Rating
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ CitedContent ⯈ ReviewRating ⯈ Rating
• Product ⯈ CollateralDetail ⯈ CitedContent ⯈ ReviewRating ⯈ Rating

Since:

Onix-3.03

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
Rating()
Rating(Element element)

Method Summary

Modifier and Type	Method	Description
Double	__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<Rating> 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

value

public Double value

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

Raw Format: Positive real number, with explicit decimal point when required, or zero, as appropriate for the limit specified in <RatingLimit>. Suggested maximum length 7 characters

(type: dt.PositiveDecimalOrZero)

EMPTY

public static final Rating EMPTY

Constructor Details

Rating

public Rating()

Rating

public Rating(Element element)

Method Details

__v

public Double __v()

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

Specified by:

__v in interface OnixElement<Double>

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 (<Rating> or <x525>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<Rating> action)