com.sun.tv.si

Class RatingDimensionImpl

java.lang.Object

com.sun.tv.si.RatingDimensionImpl

All Implemented Interfaces:

RatingDimension

public class RatingDimensionImpl
extends Object
implements RatingDimension

Each Rating Region may support multiple rating dimensions. One dimension in the U.S. rating region, for example, is used to describe the MPAA list. The dimension name for such a case may be defined as "MPAA". Another example of a rating dimension may be an age-based DVB rating.

Constructor Summary

Constructors

Constructor and Description
RatingDimensionImpl(String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRatingLevelDescription(String shortName, String fullName)
short	findRatingLevel(String longName)
String	getDimensionName() Returns a string which represents the dimension name being described by this object.
short	getNumberOfLevels() Returns the number of values defined for this particular dimension.
static RatingDimension	getRatingDimension(String name) Returns the Rating Dimension corresponding to the specified Dimension name.
String[]	getRatingLevelDescription(short ratingLevel) Returns a pair of Strings describing the specified Rating Level for this Dimension.
static String[]	getSupportedDimensions() Provides a list of names of available rating dimensions for the local rating region.

Methods inherited from class java.lang.Object

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

Constructor Detail

RatingDimensionImpl

public RatingDimensionImpl(String name)

Method Detail

addRatingLevelDescription

public void addRatingLevelDescription(String shortName,
                             String fullName)

getDimensionName

public String getDimensionName()

Returns a string which represents the dimension name being described by this object. One dimension in the U.S. rating region, for example, is used to describe the MPAA list. The dimension name for such a case may be defined as "MPAA".

Specified by:

getDimensionName in interface RatingDimension

Returns:

A string representing the name of this rating dimension.

getNumberOfLevels

public short getNumberOfLevels()

Returns the number of values defined for this particular dimension.

Specified by:

getNumberOfLevels in interface RatingDimension

Returns:

The number of values in this dimension.

getRatingLevelDescription

public String[] getRatingLevelDescription(short ratingLevel)
                                   throws SIException

Returns a pair of Strings describing the specified Rating Level for this Dimension.

Specified by:

getRatingLevelDescription in interface RatingDimension

Parameters:

ratingLevel - The rating level for which to retrieve the textual description.

Returns:

A pair of strings representing the rating level names for the specified rating level. The first string represents the abbreviated name for one particular rating value. The second string represents the full name for one particular rating value.

Throws:

SIException - If ratingLevel is not valid for this RatingDimensionImpl.

See Also:

ContentRatingAdvisory.getRatingLevel(java.lang.String)

getSupportedDimensions

public static String[] getSupportedDimensions()

Provides a list of names of available rating dimensions for the local rating region.

Returns:

An array of Strings representing names of available rating dimensions for this rating region.

See Also:

RatingDimension

findRatingLevel

public short findRatingLevel(String longName)

getRatingDimension

public static RatingDimension getRatingDimension(String name)

Returns the Rating Dimension corresponding to the specified Dimension name.

Parameters:

name - Name of the requested rating dimension

Returns:

The requested RatingDimension.