Class Overview
This represents a single web site entry. It conveys information about a
given site that is identified by site URL. It specifies whether site is
indexed by Google, verified, last time the web site has been crawled, etc.
The entry list all the available verification methods that can be used by
this web site for verification with one of the methods marked to be in-use
at the time. See VerificationMethod for more information.
Example (common Atom nodes are omitted):
http://www.websiteurl.com/
true
US
normal
preferwww
true
Summary
| Nested Classes |
|---|
|
class |
SitesEntry.Crawled |
This class is deprecated.
This class is not used any more.
|
|
class |
SitesEntry.CrawlingRate |
Crawl Rate construct to represent field. |
|
class |
SitesEntry.EnhancedImageSearch |
Boolean value construct to represent field. |
|
class |
SitesEntry.Geolocation |
Region code value construct to represent field. |
|
class |
SitesEntry.Indexed |
This class is deprecated.
This class is not used any more.
|
|
class |
SitesEntry.PreferredDomain |
Domain Preference construct to represent field. |
|
class |
SitesEntry.Verified |
Boolean value construct to represent field. |
| Fields |
|---|
|
private
static
final
Category |
CATEGORY |
Kind category used to label entry. |
| Public Constructors |
|---|
|
|
SitesEntry()
Constructs a new SitesEntry instance
|
| Protected Methods |
|---|
|
void
|
validate()
Validates that the list of verification methods contains no duplicate
method types and in-use flag is only set once.
|
|
[Expand]
Inherited Methods |
|---|
From class
com.google.gdata.data.BaseEntry
|
void
|
addAdaptor(Kind.Adaptor adaptor)
|
|
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)
|
|
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)
|
|
<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)
|
|
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)
|
|
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)
|
|
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
|
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
|
|
From interface
com.google.gdata.data.Kind.Adaptor
|
Constants
private
static
final
String
CRAWLED
Constant Value:
"crawled"
private
static
final
String
CRAWL_RATE
Constant Value:
"crawl-rate"
private
static
final
String
ENHANCED_IMAGE_SEARCH
Constant Value:
"enhanced-image-search"
private
static
final
String
GEOLOCATION
Constant Value:
"geolocation"
private
static
final
String
INDEXED
These define XML node names defined inside of this entry.
Constant Value:
"indexed"
private
static
final
String
PREFERRED_DOMAIN
Constant Value:
"preferred-domain"
private
static
final
String
VERIFIED
Constant Value:
"verified"
Fields
private
static
final
Category
CATEGORY
Kind category used to label entry.
Public Constructors
public
SitesEntry
()
Constructs a new SitesEntry instance
Public Methods
public
void
addVerificationMethod
(VerificationMethod method)
Add available verification method for the site.
public
void
declareExtensions
(ExtensionProfile extProfile)
Initializes an ExtensionProfile based upon the extensions expected
by a SitesEntry. Extension profile specifies which nodes are expected to
be in the entry.
Parameters
| extProfile
| The ExtensionProfile to initialize.
|
public
DateTime
getCrawled
()
This method is deprecated.
This field is not used any more.
Returns site last crawl time.
Returns
- last crawl time or
null if time is not set.
public
boolean
getEnhancedImageSearch
()
Returns the Enhanced Image Search setting.
Returns
true if Enhanced Image Search is enabled, false
if it is disabled.
public
List<EntryLink>
getEntryLinks
()
Returns a List of EntryLink for the links of this class, which
are the child feeds.
public
String
getGeolocation
()
Returns site geographic location. See
http://www.unicode.org/cldr/data/diff/supplemental/territory_containment_un_m_49.html.
Returns
- A two-letter code representing a country.
public
boolean
getIndexed
()
This method is deprecated.
This field is not used any more.
Returns site indexing status.
Returns
true if site is indexed or false otherwise.
Returns the domain preference for the site.
Returns
- A
DomainPreference value that indicates which one of
the domain preferences for the site is preferred.
public
List<VerificationMethod>
getVerificationMethods
()
Returns List of the verification methods for the site.
public
boolean
getVerified
()
Returns site verification status.
Returns
true if site is indexed or false otherwise.
public
void
setCrawlRate
(CrawlRate rate)
Parameters
| rate
| Is an integer representing the desired crawl rate.
|
public
void
setCrawled
(DateTime crawlTime)
This method is deprecated.
This field is not used any more.
Changes the latest crawl time.
Parameters
| crawlTime
| Specifies site last crawl time.
|
public
void
setEnhancedImageSearch
(boolean enabled)
Changes the Enhanced Image Search setting.
Parameters
| enabled
| Specifies whether enhanced image should be enabled.
|
public
void
setGeolocation
(String regionCode)
Changes site geographic location. See
http://www.unicode.org/cldr/data/diff/supplemental/territory_containment_un_m_49.html.
Parameters
| regionCode
| Is a two-letter code representing a country.
|
public
void
setIndexed
(boolean isIndexed)
This method is deprecated.
This field is not used any more.
Changes site indexing status.
Parameters
| isIndexed
| Specifies if site is indexed or not.
|
public
void
setPreferredDomain
(DomainPreference preference)
Changes the domain preference.
Parameters
| preference
| Is a DomainPreference that indicates which one
of the possibilities is preferred, using domain, www.domain, or no
association at all.
|
public
void
setVerified
(boolean isVerified)
Changes site verification status.
Parameters
| isVerified
| Specifies if site is verified or not.
|
Protected Methods
protected
void
validate
()
Validates that the list of verification methods contains no duplicate
method types and in-use flag is only set once.
