com.google.gdata.data.extensions

Class Rating

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ExtensionPoint

com.google.gdata.data.extensions.Rating

All Implemented Interfaces:

Extension

public class Rating
extends ExtensionPoint

GData schema extension describing an object's rating.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Rating.Rel Rating type.

Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint

ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler

Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension

AbstractExtension.AttributesHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected Float	average Average ratings, output with a fixed a 2 digit precision.
protected Integer	max Maximum rating value on rating scale (optional).
protected Integer	min Minimum rating value on rating scale (optional).
protected Integer	numRaters Number of ratings that was taken into account (for average ratings).
protected Integer	rating Rating value (required).
protected String	rel Rating type.

Fields inherited from class com.google.gdata.data.ExtensionPoint

xmlBlob

Fields inherited from class com.google.gdata.data.AbstractExtension

localName, namespace

Constructor Summary

Constructors

Constructor and Description
Rating() Constructs an empty Rating.
Rating(Integer rating) Constructs a Rating class with a specified rating.

Method Summary

Methods

Modifier and Type	Method and Description
void	generate(XmlWriter w, ExtensionProfile extProfile) Generates an XML representation for the extension.
Float	getAverage()
static ExtensionDescription	getDefaultDescription() Returns the suggested extension description and is repeatable.
static ExtensionDescription	getDefaultDescription(boolean repeatable) Returns the suggested extension description with configurable repeatability.
XmlParser.ElementHandler	getHandler(ExtensionProfile extProfile, String namespace, String localName, Attributes attrs) The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension.
Integer	getMax()
Integer	getMin()
Integer	getNumRaters()
String	getRel()
Integer	getValue()
void	setAverage(Float r)
void	setMax(Integer r)
void	setMin(Integer r)
void	setNumRaters(Integer r)
void	setRel(String v)
void	setValue(Integer r)

Methods inherited from class com.google.gdata.data.ExtensionPoint

addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, declareExtensions, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, getExtensionDescription, getExtensionHandler, getExtensions, getManifest, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, initializeArbitraryXml, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit, visitChild, visitChildren

Methods inherited from class com.google.gdata.data.AbstractExtension

consumeAttributes, disableStrictValidation, enableStrictValidation, eq, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, putAttributes, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validate

Methods inherited from class java.lang.Object

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

Field Detail

rel

protected String rel

Rating type.

rating

protected Integer rating

Rating value (required).

min

protected Integer min

Minimum rating value on rating scale (optional).

max

protected Integer max

Maximum rating value on rating scale (optional).

numRaters

protected Integer numRaters

Number of ratings that was taken into account (for average ratings).

average

protected Float average

Average ratings, output with a fixed a 2 digit precision.

Constructor Detail

Rating

public Rating()

Constructs an empty Rating.

Rating

public Rating(Integer rating)

Constructs a Rating class with a specified rating.

Parameters:

rating - the value of the rating

Method Detail

getRel

public String getRel()

setRel

public void setRel(String v)

getValue

public Integer getValue()

setValue

public void setValue(Integer r)

getMin

public Integer getMin()

setMin

public void setMin(Integer r)

getMax

public Integer getMax()

setMax

public void setMax(Integer r)

getNumRaters

public Integer getNumRaters()

setNumRaters

public void setNumRaters(Integer r)

getAverage

public Float getAverage()

setAverage

public void setAverage(Float r)

getDefaultDescription

public static ExtensionDescription getDefaultDescription(boolean repeatable)

Returns the suggested extension description with configurable repeatability.

getDefaultDescription

public static ExtensionDescription getDefaultDescription()

Returns the suggested extension description and is repeatable.

generate

public void generate(XmlWriter w,
            ExtensionProfile extProfile)
              throws IOException

Description copied from interface: Extension

Generates an XML representation for the extension.

Specified by:

generate in interface Extension

Overrides:

generate in class AbstractExtension

Parameters:

w - XML writer

extProfile - extension profile

Throws:

IOException

getHandler

public XmlParser.ElementHandler getHandler(ExtensionProfile extProfile,
                                  String namespace,
                                  String localName,
                                  Attributes attrs)

Description copied from class: AbstractExtension

The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension.

Specified by:

getHandler in interface Extension

Overrides:

getHandler in class ExtensionPoint

Parameters:

extProfile - extension profile

namespace - extension namespace

localName - tag name, without the namespace prefix

attrs - tag attributes

Returns:

an element handler