com.google.gdata.data.analytics
Class AnalyticsLink

java.lang.Object
  com.google.gdata.data.AbstractExtension
      com.google.gdata.data.ExtensionPoint
          com.google.gdata.data.Link
              com.google.gdata.data.analytics.AnalyticsLink

All Implemented Interfaces:

Extension, ILink, Reference

public class AnalyticsLink
extends Link

Extends the base Link class with Analytics extensions.

Nested Class Summary

static class

AnalyticsLink.Rel Link relation type.

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

Link.AtomHandler

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

Nested classes/interfaces inherited from interface com.google.gdata.data.ILink

ILink.Type

Field Summary

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

content, etag, href, hrefLang, length, rel, title, titleLang, type

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

xmlBlob

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

localName, namespace

Constructor Summary

AnalyticsLink()
Default mutable constructor.

AnalyticsLink(java.lang.String targetKind)
Immutable constructor.

Method Summary

protected void	consumeAttributes(AttributeHelper helper) Consumes attributes from the attribute helper.
boolean	equals(java.lang.Object obj)
static ExtensionDescription	getDefaultDescription(boolean required, boolean repeatable) Returns the extension description, specifying whether it is required, and whether it is repeatable.
XmlParser.ElementHandler	getHandler(ExtensionProfile p, java.lang.String namespace, java.lang.String localName, org.xml.sax.Attributes attrs) The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension.
java.lang.String	getTargetKind() Returns the kind of feed/entry the href is pointing to.
int	hashCode()
boolean	hasTargetKind() Returns whether it has the kind of feed/entry the href is pointing to.
protected void	putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator.
void	setTargetKind(java.lang.String targetKind) Sets the kind of feed/entry the href is pointing to.
java.lang.String	toString()
protected void	validate() Checks the attributes to see if there are any problems.

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

generate, generateAtom, generateRss, getContent, getEtag, getHref, getHrefLang, getLength, getRel, getTitle, getTitleLang, getType, matches, setContent, setEtag, setHref, setHrefLang, setLength, setRel, setTitle, setTitleLang, setType

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

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AnalyticsLink

public AnalyticsLink()

Default mutable constructor.

AnalyticsLink

public AnalyticsLink(java.lang.String targetKind)

Immutable constructor.

Parameters:

targetKind - kind of feed/entry the href is pointing to.

Method Detail

getTargetKind

public java.lang.String getTargetKind()

Returns the kind of feed/entry the href is pointing to.

Returns:

kind of feed/entry the href is pointing to

setTargetKind

public void setTargetKind(java.lang.String targetKind)

Sets the kind of feed/entry the href is pointing to.

Parameters:

targetKind - kind of feed/entry the href is pointing to or null to reset

hasTargetKind

public boolean hasTargetKind()

Returns whether it has the kind of feed/entry the href is pointing to.

Returns:

whether it has the kind of feed/entry the href is pointing to

validate

protected void validate()

Description copied from class: AbstractExtension

Checks the attributes to see if there are any problems. Default implementation does nothing, though generally this is discouraged unless there really are no restrictions.

Overrides:

validate in class AbstractExtension

getDefaultDescription

public static ExtensionDescription getDefaultDescription(boolean required,
                                                         boolean repeatable)

Returns the extension description, specifying whether it is required, and whether it is repeatable.

Parameters:

required - whether it is required

repeatable - whether it is repeatable

Returns:

extension description

putAttributes

protected void putAttributes(AttributeGenerator generator)

Description copied from class: AbstractExtension

Puts attributes into the attribute generator. Called from AbstractExtension.generate(XmlWriter,ExtensionProfile). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Overrides:

putAttributes in class AbstractExtension

Parameters:

generator - attribute generator

consumeAttributes

protected void consumeAttributes(AttributeHelper helper)
                          throws ParseException

Description copied from class: AbstractExtension

Consumes attributes from the attribute helper. May also use AttributeHelper.consumeContent(boolean) to consume the element's text content. Called from AbstractExtension.getHandler(com.google.gdata.data.ExtensionProfile, java.lang.String, java.lang.String, org.xml.sax.Attributes). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Overrides:

consumeAttributes in class AbstractExtension

Parameters:

helper - attribute helper

Throws:

ParseException - any parsing exception

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getHandler

public XmlParser.ElementHandler getHandler(ExtensionProfile p,
                                           java.lang.String namespace,
                                           java.lang.String localName,
                                           org.xml.sax.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 Link

Parameters:

p - extension profile

namespace - extension namespace

localName - tag name, without the namespace prefix

attrs - tag attributes

Returns:

an element handler