com.sun.tv.si

Class ContentRatingAdvisoryImpl

java.lang.Object

com.sun.tv.si.ContentRatingAdvisoryImpl

All Implemented Interfaces:

ContentRatingAdvisory

public class ContentRatingAdvisoryImpl
extends Object
implements ContentRatingAdvisory

The Content Advisory is used to indicate, for a given program event, ratings for any or all of the rating dimensions defined in the Content Rating System for the local rating region. An Event without content advisory indicates that the rating value for any rating dimension is zero. The absence of ratings for a specific dimension is completely equivalent to having a zero-valued rating for such a dimension. The absence of ratings for a specific region implies the absence of ratings for all the dimensions in the region.

This information may be obtained in the ATSC Content Advisory Descriptor or the DVB Parental Rating Descriptor. Note that the DVB rating system is based on age only. It can be easily mapped to this rating system as one of the dimensions.

Constructor Summary

Constructors

Constructor and Description
ContentRatingAdvisoryImpl(Vector dimensionNames, Vector longNames)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	exceeds() Compares the current rating value with the user specified rating ceiling.
String[]	getDimensionNames() Returns a list of names of all dimensions rated for this Rating Region.
String	getDisplayText() Provides a single string representing textual rating values for all dimensions.
short	getRatingLevel(String ratedDimension) Returns a number representing the rating level in the specified RatingDimension associated with this rating region for the related Service or Program Event.
String	getRatingLevelText(String dimensionName) Returns the rating description display string for the specified dimension.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentRatingAdvisoryImpl

public ContentRatingAdvisoryImpl(Vector dimensionNames,
                         Vector longNames)

Method Detail

getDimensionNames

public String[] getDimensionNames()

Returns a list of names of all dimensions rated for this Rating Region.

Specified by:

getDimensionNames in interface ContentRatingAdvisory

Returns:

An array of strings representing all rated dimensions in this rating region for this Service or Program Event.

See Also:

javax.tv.service.navigation.RatingDimension

getRatingLevel

public short getRatingLevel(String ratedDimension)
                     throws SIException

Returns a number representing the rating level in the specified RatingDimension associated with this rating region for the related Service or Program Event.

Specified by:

getRatingLevel in interface ContentRatingAdvisory

Parameters:

dimensionName - The name of the RatingDimension for which to obtain the rating level.

Returns:

A number representing the rating level. The meaning is dependent on the associated rating dimension.

Throws:

SIException - If dimensionName is not a valid RatingDimension name.

See Also:

javax.tv.service.navigation.RatingDimension#getDimensionName

getRatingLevelText

public String getRatingLevelText(String dimensionName)
                          throws SIException

Returns the rating description display string for the specified dimension.

Specified by:

getRatingLevelText in interface ContentRatingAdvisory

Parameters:

dimensionName - The name of the RatingDimension for which to obtain the description.

Returns:

A string representing the textual value of this rating.

Throws:

SIException - If dimensionName is not a valid RatingDimension name.

See Also:

javax.tv.service.navigation.RatingDimension#getDimensionName

getDisplayText

public String getDisplayText()

Provides a single string representing textual rating values for all dimensions.

Specified by:

getDisplayText in interface ContentRatingAdvisory

Returns:

String concatenating the text labels for all dimensions into a single label.

See Also:

ContentRatingAdvisory.getDimensionNames(), RatingDimension.getRatingLevelDescription(short)

exceeds

public boolean exceeds()

Compares the current rating value with the user specified rating ceiling.

Specified by:

exceeds in interface ContentRatingAdvisory

Returns:

True if the rating exceeds the current receiver setting; False if the rating does not exceed the current receiver setting (and the content can thus be displayed).