GoogleBaseMediaEntry

Class Overview

Media entry representing a media attachment of a Google Base item. It is used in conjuction with the GoogleBaseMediaFeed for managing the media attachments (e.g. images) of an item.

An object of this type will include the following information:

• atom:title contains the caption of the media attachment.
• atom:content points to the cached version of the attachment
• media:content points to the safe cached version of the attachment and will include several links to generated, cached thumbnails
• atom:link with the 'via' relation points to the URI from where the attachment was crawled by the cache system. If the attachment was directly uploaded by a user, this atom link will not be included in the entry.

Summary

[Expand] Inherited Fields
From class com.google.gdata.data.BaseEntry private BaseEntry<?> adaptedEntry private final Collection<Kind.Adaptor> adaptors private XmlNamespace atomPubNs private final List<Person> contributors private final Link editLink private final String etag private final Link htmlLink private final List<Link> links private final Link mediaEditLink private static final Collection<XmlNamespace> namespaceDeclsAtom Top-level namespace declarations for generated XML. private static final Collection<XmlNamespace> namespaceDeclsRss private final Link resumableEditMediaLink private final String rights private final E extends BaseEntry self private final Link selfLink private final Service service private final Source source protected BaseEntry.EntryState state Basic state for this entry.
From class com.google.gdata.data.ExtensionPoint private final Collection<Extension> extensions private ExtensionManifest manifest Manifest for this instance. private Map<Class<? extends Extension>, Extension> nonRepeatingExtensionMap Collection of non-repeating extensions. private Map<Class<? extends Extension>, List<Extension>> repeatingExtensionMap Collection of repeating extensions. private final Collection<Extension> repeatingExtensions protected XmlBlob xmlBlob Arbitrary XML (unrecognized extensions).
From class com.google.gdata.data.AbstractExtension private final String extensionLocalName private final XmlNamespace extensionNamespace private boolean immutable Indicates that the extension is constant after construction (false by default). protected final String localName XML local name for this extension or null if not defined protected final XmlNamespace namespace XML namespace for this extension or null if not defined private static ThreadLocal<Boolean> strictValidation Indicates if strict XML parsing/generation validation enabled/disabled

[Expand] Inherited Methods
From class com.google.gdata.data.media.MediaEntry Content.ChildHandlerInfo getContentHandlerInfo(ExtensionProfile extProfile, Attributes attrs) Returns information about the content element processing. Link getMediaEditLink() Retrieves the media resource edit link. MediaSource getMediaSource() Returns the MediaSource that contains the media data for the entry. void setMediaSource(MediaSource mediaSource) Sets the MediaSource that contains the media data for the entry. void setService(Service v) Sets the service that this resource is being used with. E updateMedia(boolean updateEntry) Updates the media content associated with this entry by sending the data contained in the MediaSource of the entry to the associated GData service.
From class com.google.gdata.data.BaseEntry void addAdaptor(Kind.Adaptor adaptor) Associates a new Kind.Adaptor with this Adaptable instance. void addHtmlLink(String htmlUri, String lang, String title) Adds a link pointing to an HTML representation. void addLink(Link link) Link addLink(String rel, String type, String href) Adds a link with the given rel, type, and href. void delete() Deletes this entry by sending a request to the associated GData service. void generate(XmlWriter w, ExtensionProfile p) Generates an XML representation for the extension. void generateAtom(XmlWriter w, ExtensionProfile extProfile) Generates XML in the Atom format. void generateRss(XmlWriter w, ExtensionProfile extProfile) Generates XML in the RSS format. BaseEntry<?> getAdaptedEntry() Locates and returns the most specific Kind.Adaptor BaseEntry subtype for this entry. <A extends Kind.Adaptor> A getAdaptor(Class<A> adaptorClass) Collection<Kind.Adaptor> getAdaptors() Returns the collection of Kind.Adaptor instances associated with the this Adaptable instance. List<Person> getAuthors() Returns the list of all authors on this resource. boolean getCanEdit() Returns true if the entry can be modified by a client. Set<Category> getCategories() Returns a set of categories on this resource. Content getContent() Gets the content of this entry. Content.ChildHandlerInfo getContentHandlerInfo(ExtensionProfile extProfile, Attributes attrs) Returns information about the content element processing. List<Person> getContributors() Link getEditLink() Retrieves the resource edit link. DateTime getEdited() Get a DateTime instance representing the last time this entry was edited. String getEtag() Gets the value of the gd:etag attribute for this resource. XmlParser.ElementHandler getHandler(ExtensionProfile p, String namespace, String localName, Attributes attrs) The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension. Link getHtmlLink() Retrieves the first HTML link. String getId() Get the unique id for this resource. String getKind() Returns the value of the gd:kind attribute for this resource. Link getLink(String rel, String type) Retrieves the first link with the supplied rel and/or type value. List<Link> getLinks() Returns a list of atom:link elements on this resource. List<Link> getLinks(String relToMatch, String typeToMatch) Return the links that match the given rel and type values. Link getMediaEditLink() Retrieves the media resource edit link. String getPlainTextContent() Assumes the element's contents are plain-text and returns its value as a string PubControl getPubControl() Gets the app:control tag. DateTime getPublished() Get a DateTime instance representing the time that this entry was created. Link getResumableEditMediaLink() Retrieves the media resource resumable upload link. TextConstruct getRights() String getSelectedFields() Returns the current fields selection for this partial entry. E getSelf() Retrieves the current version of this Entry by requesting it from the associated GData service. Link getSelfLink() Retrieves the resource access link. Service getService() Source getSource() TextConstruct getSummary() Returns the atom:summary element of this entry. TextContent getTextContent() Assumes the content element's contents are text and returns them as a TextContent. TextConstruct getTitle() Returns the atom:title element of this resource. DateTime getUpdated() Get a DateTime instance representing the last time this resource was updated. String getVersionId() Version ID. boolean isDraft() Draft status. void parseAtom(ExtensionProfile extProfile, XmlEventSource eventSource) Parses XML in the Atom format from a parser-defined content source. void parseAtom(ExtensionProfile extProfile, InputStream input) Parses XML in the Atom format. void parseAtom(ExtensionProfile extProfile, Reader reader) Parses XML in the Atom format. static <T extends BaseEntry> T readEntry(ParseSource source, Class<T> entryClass, ExtensionProfile extProfile) Reads an entry of type T using the given extension profile. static BaseEntry<?> readEntry(ParseSource source) Reads an entry representation from the provided ParseSource. void removeLinks() Remove all links. void removeLinks(String relToMatch, String typeToMatch) Remove all links that match the given rel and type values. void setCanEdit(boolean v) Sets whether the server allows this entry to be modified by the client. void setContent(Content v) void setContent(TextConstruct tc) void setDraft(Boolean v) Set draft status. void setEdited(DateTime v) Set the last time this entry was edited using the app:edited element. void setEtag(String v) Sets the value of the gd:etag attribute for this resource. void setId(String v) Sets the unique id for this resource. void setKind(String v) Sets the value of the gd:kind attribute for this resource. void setPubControl(PubControl value) Sets the app:control tag, which usually contains app:draft. void setPublished(DateTime v) Sets the date of publishing for this entry. void setRights(TextConstruct v) void setSelectedFields(String v) Sets the current fields selection for this partial entry. void setService(Service s) Sets the service that this resource is being used with. void setSource(Source v) void setSummary(TextConstruct v) void setTitle(TextConstruct v) void setUpdated(DateTime v) Sets the last time this resource was updated. void setVersionId(String v) Sets the versionId. E update() Updates this entry by sending the current representation to the associated GData service. void visitChildren(ExtensionVisitor ev) Called to visit all children of this extension point.
From class com.google.gdata.data.ExtensionPoint boolean addExtension(Extension ext, Class<? extends Extension> extClass) Internal helper method. void addExtension(Extension ext) Adds an extension object. void addRepeatingExtension(Extension ext) Adds a repeating extension object. void addRepeatingExtension(Extension ext, Class<? extends Extension> extClass) Internal helper method. void checkRequiredExtensions(ExtensionManifest profManifest) Checks whether all required extensions are present. static <T extends Extension> T createExtensionInstance(Class<T> extClass) Creates an instance of the given extension class. void declareExtensions(ExtensionProfile extProfile) Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. void generate(XmlWriter w, ExtensionProfile p, XmlNamespace namespace, String localName, List<XmlWriter.Attribute> attrs, AttributeGenerator generator) Generates the XML into the XML writer. XmlBlob generateCumulativeXmlBlob(ExtensionProfile extProfile) Generates an XML blob containing all recognized and unrecognized extensions. void generateExtensions(XmlWriter w, ExtensionProfile extProfile) Generates XML corresponding to extended properties. void generateStartElement(XmlWriter w, XmlNamespace namespace, String elementName, Collection<XmlWriter.Attribute> additionalAttrs, Collection<XmlNamespace> additionalNs) Generates XML corresponding to the type implementing ExtensionPoint. <T extends Extension> T getExtension(Class<T> extensionClass) Retrieves a non-repeating extension or null if not present. ExtensionDescription getExtensionDescription(ExtensionProfile extProfile, Class<? extends ExtensionPoint> extPoint, String namespaceUri, String localName) Returns the extension description for the namespace URI and local name for the XML element based on the extension point in the extension profile. XmlParser.ElementHandler getExtensionHandler(ExtensionProfile extProfile, Class<? extends ExtensionPoint> extPoint, String namespaceUri, String localName, Attributes attrs) XML parser callback for extended properties. Collection<Extension> getExtensions() Returns an unmodifiable collection of non-repeating extensions in this ExtensionPoint. XmlParser.ElementHandler getHandler(ExtensionProfile p, String namespace, String localName, Attributes attrs) The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension. ExtensionManifest getManifest(ExtensionProfile extProfile, Class<? extends ExtensionPoint> extendedClass) Retrieves the manifest for the specified class. <T extends Extension> List<T> getRepeatingExtension(Class<T> extensionClass) Retrieves a repeating extension list (an empty list if not present). Collection<List<Extension>> getRepeatingExtensions() Returns an unmodifiable collection of lists of repeating extensions in this ExtensionPoint. XmlBlob getXmlBlob() Retrieves the XML blob containing arbitrary (unrecognized) extensions. final <T extends Extension> boolean hasExtension(Class<T> extensionClass) Returns whether the non-repeating extension is present. final <T extends Extension> boolean hasRepeatingExtension(Class<T> extensionClass) Returns whether the repeating extension is present. void initializeArbitraryXml(ExtensionProfile profile, Class<? extends ExtensionPoint> extPoint, XmlParser.ElementHandler handler) Initializes parser handler's XML blob state. void parseCumulativeXmlBlob(XmlBlob blob, ExtensionProfile extProfile, Class<? extends ExtensionPoint> extendedClass) Reverses generateCumulativeXmlBlob(ExtensionProfile). void removeExtension(Extension ext) Removes an extension object. void removeExtension(Class<? extends Extension> extensionClass) Removes an extension object based on its class. void removeRepeatingExtension(Extension ext) Removes a repeating extension object. void setExtension(Extension ext) Sets an extension object. <T extends Extension> void setRepeatingExtension(Class<T> extensionClass, List<T> value) void setXmlBlob(XmlBlob xmlBlob) Sets the XML blob containing arbitrary (unrecognized) extensions. void visit(ExtensionVisitor ev, ExtensionPoint parent) Visits the tree of extension data associated with this extension point instance using the specified ExtensionVisitor, starting at this extension point. void visitChild(ExtensionVisitor ev, Extension child) Called to visit a child of this extension point. void visitChildren(ExtensionVisitor ev) Called to visit all children of this extension point.
From class com.google.gdata.data.AbstractExtension void consumeAttributes(AttributeHelper helper) Consumes attributes from the attribute helper. final static void disableStrictValidation() final static void enableStrictValidation() static boolean eq(Object o1, Object o2) void generate(XmlWriter w, ExtensionProfile p) Generates an XML representation for the extension. void generate(XmlWriter w, ExtensionProfile p, XmlNamespace namespace, String localName, List<XmlWriter.Attribute> attrs, AttributeGenerator generator) Generates the XML into the XML writer. void generateAttributes(List<XmlWriter.Attribute> attrs, AttributeGenerator generator) Generates the attributes in the generator into the list of attributes. final String getExtensionLocalName() Gets the extension's localname. final XmlNamespace getExtensionNamespace() Gets the extension's namespace. XmlParser.ElementHandler getHandler(ExtensionProfile p, String namespace, String localName, Attributes attrs) The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension. final boolean isImmutable() final static boolean isStrictValidation() void putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator. boolean sameClassAs(Object o) final void setImmutable(boolean isImmutable) final static void throwExceptionForMissingAttribute(String attrName) Throws an IllegalStateException if the value is required and it is missing. final void throwExceptionIfImmutable() Throws an IllegalStateException if this instance is immutable. void validate() Checks the attributes to see if there are any problems.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.google.gdata.data.Extension abstract void generate(XmlWriter w, ExtensionProfile extProfile) Generates an XML representation for the extension. abstract XmlParser.ElementHandler getHandler(ExtensionProfile extProfile, String namespace, String localName, Attributes attrs) Gets an XML element handler for the extension.
From interface com.google.gdata.data.IAtom abstract ILink addLink(String rel, String type, String href) Adds a link with the given rel, type, and href. abstract List<? extends IPerson> getAuthors() Returns the list of all authors on this resource. abstract Set<? extends ICategory> getCategories() Returns a set of categories on this resource. abstract String getEtag() Gets the value of the gd:etag attribute for this resource. abstract String getId() Get the unique id for this resource. abstract String getKind() Returns the value of the gd:kind attribute for this resource. abstract ILink getLink(String rel, String type) Returns a particular atom:link element with the given rel and type, or null if one was not found. abstract List<? extends ILink> getLinks() Returns a list of atom:link elements on this resource. abstract ILink getSelfLink() Returns the self link for the resource. abstract ITextConstruct getTitle() Returns the atom:title element of this resource. abstract DateTime getUpdated() Get a DateTime instance representing the last time this resource was updated. abstract String getVersionId() Version ID. abstract void removeLinks(String relToMatch, String typeToMatch) Remove all links that match the given rel and type values. abstract void removeLinks() Removes all links from the this resource. abstract void setEtag(String etag) Sets the value of the gd:etag attribute for this resource. abstract void setId(String id) Sets the unique id for this resource. abstract void setKind(String kind) Sets the value of the gd:kind attribute for this resource. abstract void setService(Service s) Sets the service that this resource is being used with. abstract void setUpdated(DateTime updated) Sets the last time this resource was updated. abstract void setVersionId(String versionId) Sets the versionId.
From interface com.google.gdata.data.IEntry abstract boolean getCanEdit() Returns true if the entry can be modified by a client. abstract IContent getContent() Gets the content of this entry. abstract ILink getEditLink() Gets the edit link, which is the link to PUT an updated version of the entry to. abstract DateTime getEdited() Get a DateTime instance representing the last time this entry was edited. abstract ILink getMediaEditLink() Gets the media-edit link, which is the link to PUT an updated version of the media content to. abstract DateTime getPublished() Get a DateTime instance representing the time that this entry was created. abstract ILink getResumableEditMediaLink() Gets the resumable-edit-media link, which is the link to PUT an updated version of the media content to using Resumable Upload IO. abstract String getSelectedFields() Returns the set of selected fields for the entry if the entry contains a partial representation or null if it is a full representation. abstract ITextConstruct getSummary() Returns the atom:summary element of this entry. abstract void setCanEdit(boolean canEdit) Sets whether the server allows this entry to be modified by the client. abstract void setEdited(DateTime edited) Set the last time this entry was edited using the app:edited element. abstract void setPublished(DateTime published) Sets the date of publishing for this entry. abstract void setSelectedFields(String fields) Sets the current fields selection for this partial entry.
From interface com.google.gdata.data.Kind.Adaptable abstract void addAdaptor(Kind.Adaptor adaptor) Associates a new Kind.Adaptor with this Adaptable instance. abstract <E extends Kind.Adaptor> E getAdaptor(Class<E> adaptorClass) Returns a Kind.Adaptor instance associated with this Adaptable instance of the specified type, or {code null} if none is available.. abstract Collection<Kind.Adaptor> getAdaptors() Returns the collection of Kind.Adaptor instances associated with the this Adaptable instance.
From interface com.google.gdata.data.Kind.Adaptor abstract void declareExtensions(ExtensionProfile extProfile) Declares the ExtensionDescription of each Extension expected by the implementing ExtensionPoint in the target profile.
From interface com.google.gdata.data.media.IMediaEntry abstract MediaSource getMediaSource() Returns the MediaSource that contains the media data for the entry. abstract void setMediaSource(MediaSource source) Sets the MediaSource that contains the media data for the entry.