com.google.gdata.model.gd
Class Where

java.lang.Object
  extended by com.google.gdata.model.Element
      extended by com.google.gdata.model.gd.Where

public class Where
extends Element

Describes a place (not necessarily a specific geographical location).


Nested Class Summary
static class Where.Rel
          Meaning of this location.
 
Field Summary
static ElementKey<java.lang.Void,Where> KEY
          The key for this element.
static AttributeKey<java.lang.String> LABEL
          User-readable label that identifies this location in case multiple locations may be present.
static AttributeKey<java.lang.String> REL
          Meaning of this location.
static AttributeKey<java.lang.String> VALUE_STRING
          Text description of the place.
 
Constructor Summary
  Where()
          Constructs an instance using the default key.
protected Where(ElementKey<?,? extends Where> key)
          Subclass constructor, allows subclasses to supply their own element key.
protected Where(ElementKey<?,? extends Where> key, Element source)
          Constructs a new instance by doing a shallow copy of data from an existing Element instance.
 
Method Summary
 EntryLink getEntryLink()
          Returns the nested person or venue (Contact) entry.
 java.lang.String getLabel()
          Returns the user-readable label that identifies this location in case multiple locations may be present.
 java.lang.String getRel()
          Returns the meaning of this location.
 java.lang.String getValueString()
          Returns the text description of the place.
 boolean hasEntryLink()
          Returns whether it has the nested person or venue (Contact) entry.
 boolean hasLabel()
          Returns whether it has the user-readable label that identifies this location in case multiple locations may be present.
 boolean hasRel()
          Returns whether it has the meaning of this location.
 boolean hasValueString()
          Returns whether it has the text description of the place.
 Where lock()
          Locks this element.
static void registerMetadata(MetadataRegistry registry)
          Registers the metadata for this element.
 Where setEntryLink(EntryLink entryLink)
          Sets the nested person or venue (Contact) entry.
 Where setLabel(java.lang.String label)
          Sets the user-readable label that identifies this location in case multiple locations may be present.
 Where setRel(java.lang.String rel)
          Sets the meaning of this location.
 Where setValueString(java.lang.String valueString)
          Sets the text description of the place.
 
Methods inherited from class com.google.gdata.model.Element
adapt, adapt, addElement, addElement, addElement, clear, createElement, createElement, eq, equals, getAttributeCount, getAttributeIterator, getAttributeIterator, getAttributeValue, getAttributeValue, getDefaultKey, getElement, getElement, getElementCount, getElementId, getElementIterator, getElementIterator, getElementKey, getElements, getElements, getElementSet, getElementSet, getElementValue, getElementValue, getTextValue, getTextValue, hasAttribute, hasAttribute, hasElement, hasElement, hashCode, hasTextValue, isLocked, narrow, removeAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeElement, removeElement, removeElement, removeElement, replaceElement, resolve, resolve, sameClassAs, setAttributeValue, setAttributeValue, setElement, setElement, setElement, setTextValue, toString, validate, visit
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

KEY

public static final ElementKey<java.lang.Void,Where> KEY
The key for this element.


LABEL

public static final AttributeKey<java.lang.String> LABEL
User-readable label that identifies this location in case multiple locations may be present.


REL

public static final AttributeKey<java.lang.String> REL
Meaning of this location.


VALUE_STRING

public static final AttributeKey<java.lang.String> VALUE_STRING
Text description of the place.

Constructor Detail

Where

public Where()
Constructs an instance using the default key.


Where

protected Where(ElementKey<?,? extends Where> key)
Subclass constructor, allows subclasses to supply their own element key.


Where

protected Where(ElementKey<?,? extends Where> key,
                Element source)
Constructs a new instance by doing a shallow copy of data from an existing Element instance. Will use the given ElementKey as the key for the element. This constructor is used when adapting from one element key to another. You cannot call this constructor directly, instead use Element.createElement(ElementKey, Element).

Parameters:
key - The key to use for this element.
source - source element
Method Detail

registerMetadata

public static void registerMetadata(MetadataRegistry registry)
Registers the metadata for this element.


lock

public Where lock()
Description copied from class: Element
Locks this element. A locked element cannot have any changes made to its content or its attributes or child elements. This will also lock all attributes and child elements as well. Once this method has been called, this element can be safely published to other threads.

Overrides:
lock in class Element

getEntryLink

public EntryLink getEntryLink()
Returns the nested person or venue (Contact) entry.

Returns:
nested person or venue (Contact) entry

setEntryLink

public Where setEntryLink(EntryLink entryLink)
Sets the nested person or venue (Contact) entry.

Parameters:
entryLink - nested person or venue (Contact) entry or null to reset
Returns:
this to enable chaining setters

hasEntryLink

public boolean hasEntryLink()
Returns whether it has the nested person or venue (Contact) entry.

Returns:
whether it has the nested person or venue (Contact) entry

getLabel

public java.lang.String getLabel()
Returns the user-readable label that identifies this location in case multiple locations may be present.

Returns:
user-readable label that identifies this location in case multiple locations may be present

setLabel

public Where setLabel(java.lang.String label)
Sets the user-readable label that identifies this location in case multiple locations may be present.

Parameters:
label - user-readable label that identifies this location in case multiple locations may be present or null to reset
Returns:
this to enable chaining setters

hasLabel

public boolean hasLabel()
Returns whether it has the user-readable label that identifies this location in case multiple locations may be present.

Returns:
whether it has the user-readable label that identifies this location in case multiple locations may be present

getRel

public java.lang.String getRel()
Returns the meaning of this location.

Returns:
meaning of this location

setRel

public Where setRel(java.lang.String rel)
Sets the meaning of this location.

Parameters:
rel - meaning of this location or null to reset
Returns:
this to enable chaining setters

hasRel

public boolean hasRel()
Returns whether it has the meaning of this location.

Returns:
whether it has the meaning of this location

getValueString

public java.lang.String getValueString()
Returns the text description of the place.

Returns:
text description of the place

setValueString

public Where setValueString(java.lang.String valueString)
Sets the text description of the place.

Parameters:
valueString - text description of the place or null to reset
Returns:
this to enable chaining setters

hasValueString

public boolean hasValueString()
Returns whether it has the text description of the place.

Returns:
whether it has the text description of the place