Google Data APIs Client Library (1.41.1)



com.google.gdata.data.photos
Class TagEntry

java.lang.Object
  extended by com.google.gdata.data.AbstractExtension
      extended by com.google.gdata.data.ExtensionPoint
          extended by com.google.gdata.data.BaseEntry<E>
              extended by com.google.gdata.data.media.MediaEntry<E>
                  extended by com.google.gdata.data.photos.GphotoEntry<TagEntry>
                      extended by com.google.gdata.data.photos.TagEntry
All Implemented Interfaces:
Extension, IAtom, IEntry, Kind.Adaptable, Kind.Adaptor, IMediaEntry, AtomData, Extensible, GphotoData, TagData

public class TagEntry
extends GphotoEntry<TagEntry>
implements AtomData, TagData

Entry for tag kinds, contains tag metadata.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gdata.data.BaseEntry
BaseEntry.AtomHandler, BaseEntry.EntryState
 
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
static Category CATEGORY
          Tag kind category.
static java.lang.String KIND
          Tag kind term value.
 
Fields inherited from class com.google.gdata.data.BaseEntry
state
 
Fields inherited from class com.google.gdata.data.ExtensionPoint
xmlBlob
 
Fields inherited from class com.google.gdata.data.AbstractExtension
localName, namespace
 
Fields inherited from interface com.google.gdata.data.photos.TagData
TAG_CATEGORY, TAG_KIND
 
Constructor Summary
TagEntry()
          Default mutable constructor.
TagEntry(BaseEntry<?> sourceEntry)
          Constructs a new instance by doing a shallow copy of data from an existing BaseEntry instance.
 
Method Summary
 void declareExtensions(ExtensionProfile extProfile)
          Declares the set of expected Extension types for an ExtensionPoint within the target extension profile.
 java.lang.Integer getWeight()
          The weight of the tag is the number of times the tag appears in the collection of tags currently being viewed.
 GphotoWeight getWeightExt()
          Returns the weight of the tag.
 boolean hasWeightExt()
          Returns whether it has the weight of the tag.
 void setWeight(java.lang.Integer weight)
          Set the weight of the tag.
 void setWeightExt(GphotoWeight weightExt)
          Sets the weight of the tag.
 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.photos.GphotoEntry
generateRss, getAdaptedEntry, getDescription, getFeed, getFeedLink, getGphotoId, setDescription, setGphotoId, setGphotoId
 
Methods inherited from class com.google.gdata.data.media.MediaEntry
getContentHandlerInfo, getMediaEditLink, getMediaSource, setMediaSource, setService, updateMedia
 
Methods inherited from class com.google.gdata.data.BaseEntry
addAdaptor, addHtmlLink, addLink, addLink, delete, generate, generateAtom, getAdaptor, getAdaptors, getAuthors, getCanEdit, getCategories, getContent, getContributors, getEdited, getEditLink, getEtag, getHandler, getHtmlLink, getId, getKind, getLink, getLinks, getLinks, getPlainTextContent, getPubControl, getPublished, getResumableEditMediaLink, getRights, getSelectedFields, getSelf, getSelfLink, getService, getSource, getSummary, getTextContent, getTitle, getUpdated, getVersionId, isDraft, parseAtom, parseAtom, parseAtom, readEntry, readEntry, removeLinks, removeLinks, setCanEdit, setContent, setContent, setDraft, setEdited, setEtag, setId, setKind, setPubControl, setPublished, setRights, setSelectedFields, setSource, setSummary, setTitle, setUpdated, setVersionId, update, visitChildren
 
Methods inherited from class com.google.gdata.data.ExtensionPoint
addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gdata.data.photos.AtomData
getAuthors, getCategories, getContributors, getDescription, getId, getLinks, getRights, getTitle, getUpdated, setDescription, setId, setRights, setTitle, setUpdated
 
Methods inherited from interface com.google.gdata.data.photos.GphotoData
getGphotoId, setGphotoId, setGphotoId
 
Methods inherited from interface com.google.gdata.data.photos.Extensible
addExtension, addRepeatingExtension, removeExtension, removeExtension, removeRepeatingExtension, setExtension
 
Methods inherited from interface com.google.gdata.data.IEntry
getCanEdit, getContent, getEdited, getEditLink, getPublished, getResumableEditMediaLink, getSelectedFields, getSummary, setCanEdit, setEdited, setPublished, setSelectedFields
 
Methods inherited from interface com.google.gdata.data.IAtom
addLink, getAuthors, getCategories, getEtag, getId, getKind, getLink, getLinks, getSelfLink, getTitle, getUpdated, getVersionId, removeLinks, removeLinks, setEtag, setId, setKind, setUpdated, setVersionId
 

Field Detail

KIND

public static final java.lang.String KIND
Tag kind term value.

See Also:
Constant Field Values

CATEGORY

public static final Category CATEGORY
Tag kind category.

Constructor Detail

TagEntry

public TagEntry()
Default mutable constructor.


TagEntry

public TagEntry(BaseEntry<?> sourceEntry)
Constructs a new instance by doing a shallow copy of data from an existing BaseEntry instance.

Parameters:
sourceEntry - source entry
Method Detail

declareExtensions

public void declareExtensions(ExtensionProfile extProfile)
Description copied from class: ExtensionPoint
Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. The base implementation does not declare any extensions, but can be overridden by specific types of ExtensionPoints that always contain a well-defined set of extensions.

Specified by:
declareExtensions in interface Kind.Adaptor
Specified by:
declareExtensions in interface Extensible
Overrides:
declareExtensions in class GphotoEntry<TagEntry>
Parameters:
extProfile - the ExtensionProfile to initialize.
See Also:
ExtensionProfile.addDeclarations(Kind.Adaptor)

getWeightExt

public GphotoWeight getWeightExt()
Returns the weight of the tag.

Returns:
weight of the tag

setWeightExt

public void setWeightExt(GphotoWeight weightExt)
Sets the weight of the tag.

Parameters:
weightExt - weight of the tag or null to reset

hasWeightExt

public boolean hasWeightExt()
Returns whether it has the weight of the tag.

Returns:
whether it has the weight of the tag

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

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getWeight

public java.lang.Integer getWeight()
                            throws ParseException
Description copied from interface: TagData
The weight of the tag is the number of times the tag appears in the collection of tags currently being viewed. This is a server-provided context sensitive measure of how often the tag is used, and can be used to implement tag-cloud like views.

Specified by:
getWeight in interface TagData
Returns:
the weight of the tag, or null if it doesn't have one.
Throws:
ParseException - for backwards compatibility

setWeight

public void setWeight(java.lang.Integer weight)
Description copied from interface: TagData
Set the weight of the tag. Used by the server, this field is read only on the client.

Specified by:
setWeight in interface TagData