com.google.gdata.data.extensions

Class Where

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ExtensionPoint

com.google.gdata.data.extensions.Where

All Implemented Interfaces:

Extension

public class Where
extends ExtensionPoint
implements Extension

GData schema extension describing a place (not necessarily a specific geographical location).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Where.Rel Relation 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 EntryLink<?>	entryLink Nested person or venue (Contact) entry.
protected String	label User-readable label that identifies this location in case multiple locations may be present.
protected String	rel Describes the meaning of this location.
protected String	valueString Text description of the place.

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
Where() Constructs an empty Where instance.
Where(String rel, String label, String valueString) Constructs a new Where instance using the specified parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	generate(XmlWriter w, ExtensionProfile extProfile) Generates an XML representation for the extension.
static ExtensionDescription	getDefaultDescription() Returns the suggested extension description.
EntryLink<?>	getEntryLink()
XmlParser.ElementHandler	getHandler(ExtensionProfile extProfile, String namespace, String localName, Attributes attrs) The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension.
String	getLabel()
String	getRel()
String	getValueString()
void	setEntryLink(EntryLink<?> v)
void	setLabel(String v)
void	setRel(String v)
void	setValueString(String v)
protected void	visitChildren(ExtensionVisitor ev) Called to visit all children of this extension point.

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

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

Describes the meaning of this location.

label

protected String label

User-readable label that identifies this location in case multiple locations may be present.

valueString

protected String valueString

Text description of the place.

entryLink

protected EntryLink<?> entryLink

Nested person or venue (Contact) entry.

Constructor Detail

Where

public Where()

Constructs an empty Where instance.

Where

public Where(String rel,
     String label,
     String valueString)

Constructs a new Where instance using the specified parameters.

Method Detail

getRel

public String getRel()

setRel

public void setRel(String v)

getLabel

public String getLabel()

setLabel

public void setLabel(String v)

getValueString

public String getValueString()

setValueString

public void setValueString(String v)

getEntryLink

public EntryLink<?> getEntryLink()

setEntryLink

public void setEntryLink(EntryLink<?> v)

getDefaultDescription

public static ExtensionDescription getDefaultDescription()

Returns the suggested extension description.

visitChildren

protected void visitChildren(ExtensionVisitor ev)
                      throws ExtensionVisitor.StoppedException

Description copied from class: ExtensionPoint

Called to visit all children of this extension point.

Overrides:

visitChildren in class ExtensionPoint

Parameters:

ev - the extension visitor.

Throws:

ExtensionVisitor.StoppedException

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