gdata.health
index
/usr/local/svn/gdata-python-client/src/gdata/health/__init__.py

Contains extensions to Atom objects used with Google Health.

 
Package Contents
       
service

 
Classes
       
atom.AtomBase(atom.ExtensionContainer)
Ccr
gdata.GDataEntry(atom.Entry, gdata.LinkFinder)
ProfileEntry
ProfileListEntry
gdata.GDataFeed(atom.Feed, gdata.LinkFinder)
ProfileFeed
ProfileListFeed

 
class Ccr(atom.AtomBase)
    Represents a Google Health <ContinuityOfCareRecord>.
 
 
Method resolution order:
Ccr
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods defined here:
GetAlerts(self)
Helper for extracting Alert/Allergy data from the CCR.
 
Returns:
  A list of ExtensionElements (one for each allergy found) or None if
  no allergies where found in this CCR.
GetAllergies(self)
Alias for GetAlerts().
GetConditions(self)
Alias for GetProblems().
GetImmunizations(self)
Helper for extracting Immunization data from the CCR.
 
Returns:
  A list of ExtensionElements (one for each immunization found) or None if
  no immunizations where found in this CCR.
GetMedications(self)
Helper for extracting Medication data from the CCR.
 
Returns:
  A list of ExtensionElements (one for each medication found) or None if
  no medications where found in this CCR.
GetProblems(self)
Helper for extracting Problem/Condition data from the CCR.
 
Returns:
  A list of ExtensionElements (one for each problem found) or None if
  no problems where found in this CCR.
GetProcedures(self)
Helper for extracting Procedure data from the CCR.
 
Returns:
  A list of ExtensionElements (one for each procedure found) or None if
  no procedures where found in this CCR.
GetResults(self)
Helper for extracting Results/Labresults data from the CCR.
 
Returns:
  A list of ExtensionElements (one for each result found) or None if
  no results where found in this CCR.
__init__(self, extension_elements=None, extension_attributes=None, text=None)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class ProfileEntry(gdata.GDataEntry)
    The Google Health version of an Atom Entry.
 
 
Method resolution order:
ProfileEntry
gdata.GDataEntry
atom.Entry
atom.FeedEntryParent
atom.AtomBase
atom.ExtensionContainer
gdata.LinkFinder
atom.LinkFinder
__builtin__.object

Methods defined here:
__init__(self, ccr=None, author=None, category=None, content=None, atom_id=None, link=None, published=None, title=None, updated=None, text=None, extension_elements=None, extension_attributes=None)

Methods inherited from gdata.GDataEntry:
GetMediaURL(self)
Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
IsMedia(self)
Determines whether or not an entry is a GData Media entry.

Data descriptors inherited from gdata.GDataEntry:
id

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Methods inherited from gdata.LinkFinder:
GetAclLink(self)
GetEditLink(self)
GetEditMediaLink(self)
The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
GetFeedLink(self)
GetHtmlLink(self)
Find the first link with rel of alternate and type of text/html
 
Returns:
  An atom.Link or None if no links matched
GetNextLink(self)
GetPostLink(self)
Get a link containing the POST target URL.
 
The POST target URL is used to insert new entries.
 
Returns:
  A link object with a rel matching the POST type.
GetPrevLink(self)
GetSelfLink(self)
Find the first link with rel set to 'self'
 
Returns:
  An atom.Link or none if none of the links had rel equal to 'self'

Methods inherited from atom.LinkFinder:
GetAlternateLink(self)
GetLicenseLink(self)

 
class ProfileFeed(gdata.GDataFeed)
    A feed containing a list of Google Health profile entries.
 
 
Method resolution order:
ProfileFeed
gdata.GDataFeed
atom.Feed
atom.Source
atom.FeedEntryParent
atom.AtomBase
atom.ExtensionContainer
gdata.LinkFinder
atom.LinkFinder
__builtin__.object

Methods inherited from gdata.GDataFeed:
__init__(self, author=None, category=None, contributor=None, generator=None, icon=None, atom_id=None, link=None, logo=None, rights=None, subtitle=None, title=None, updated=None, entry=None, total_results=None, start_index=None, items_per_page=None, extension_elements=None, extension_attributes=None, text=None)
Constructor for Source
 
Args:
  author: list (optional) A list of Author instances which belong to this
      class.
  category: list (optional) A list of Category instances
  contributor: list (optional) A list on Contributor instances
  generator: Generator (optional)
  icon: Icon (optional)
  id: Id (optional) The entry's Id element
  link: list (optional) A list of Link instances
  logo: Logo (optional)
  rights: Rights (optional) The entry's Rights element
  subtitle: Subtitle (optional) The entry's subtitle element
  title: Title (optional) the entry's title element
  updated: Updated (optional) the entry's updated element
  entry: list (optional) A list of the Entry instances contained in the
      feed.
  text: String (optional) The text contents of the element. This is the
      contents of the Entry's XML text node.
      (Example: <foo>This is the text</foo>)
  extension_elements: list (optional) A list of ExtensionElement instances
      which are children of this element.
  extension_attributes: dict (optional) A dictionary of strings which are
      the values for additional XML attributes of this element.

Data descriptors inherited from gdata.GDataFeed:
generator
id

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Methods inherited from gdata.LinkFinder:
GetAclLink(self)
GetEditLink(self)
GetEditMediaLink(self)
The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
GetFeedLink(self)
GetHtmlLink(self)
Find the first link with rel of alternate and type of text/html
 
Returns:
  An atom.Link or None if no links matched
GetNextLink(self)
GetPostLink(self)
Get a link containing the POST target URL.
 
The POST target URL is used to insert new entries.
 
Returns:
  A link object with a rel matching the POST type.
GetPrevLink(self)
GetSelfLink(self)
Find the first link with rel set to 'self'
 
Returns:
  An atom.Link or none if none of the links had rel equal to 'self'

Methods inherited from atom.LinkFinder:
GetAlternateLink(self)
GetLicenseLink(self)

 
class ProfileListEntry(gdata.GDataEntry)
    The Atom Entry in the Google Health profile list feed.
 
 
Method resolution order:
ProfileListEntry
gdata.GDataEntry
atom.Entry
atom.FeedEntryParent
atom.AtomBase
atom.ExtensionContainer
gdata.LinkFinder
atom.LinkFinder
__builtin__.object

Methods defined here:
GetProfileId(self)
GetProfileName(self)

Methods inherited from gdata.GDataEntry:
GetMediaURL(self)
Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
IsMedia(self)
Determines whether or not an entry is a GData Media entry.

Data descriptors inherited from gdata.GDataEntry:
id

Methods inherited from atom.Entry:
__init__(*args, **kwargs)
# The deprecated_function wraps the actual call to f.

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Methods inherited from gdata.LinkFinder:
GetAclLink(self)
GetEditLink(self)
GetEditMediaLink(self)
The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
GetFeedLink(self)
GetHtmlLink(self)
Find the first link with rel of alternate and type of text/html
 
Returns:
  An atom.Link or None if no links matched
GetNextLink(self)
GetPostLink(self)
Get a link containing the POST target URL.
 
The POST target URL is used to insert new entries.
 
Returns:
  A link object with a rel matching the POST type.
GetPrevLink(self)
GetSelfLink(self)
Find the first link with rel set to 'self'
 
Returns:
  An atom.Link or none if none of the links had rel equal to 'self'

Methods inherited from atom.LinkFinder:
GetAlternateLink(self)
GetLicenseLink(self)

 
class ProfileListFeed(gdata.GDataFeed)
    A feed containing a list of Google Health profile list entries.
 
 
Method resolution order:
ProfileListFeed
gdata.GDataFeed
atom.Feed
atom.Source
atom.FeedEntryParent
atom.AtomBase
atom.ExtensionContainer
gdata.LinkFinder
atom.LinkFinder
__builtin__.object

Methods inherited from gdata.GDataFeed:
__init__(self, author=None, category=None, contributor=None, generator=None, icon=None, atom_id=None, link=None, logo=None, rights=None, subtitle=None, title=None, updated=None, entry=None, total_results=None, start_index=None, items_per_page=None, extension_elements=None, extension_attributes=None, text=None)
Constructor for Source
 
Args:
  author: list (optional) A list of Author instances which belong to this
      class.
  category: list (optional) A list of Category instances
  contributor: list (optional) A list on Contributor instances
  generator: Generator (optional)
  icon: Icon (optional)
  id: Id (optional) The entry's Id element
  link: list (optional) A list of Link instances
  logo: Logo (optional)
  rights: Rights (optional) The entry's Rights element
  subtitle: Subtitle (optional) The entry's subtitle element
  title: Title (optional) the entry's title element
  updated: Updated (optional) the entry's updated element
  entry: list (optional) A list of the Entry instances contained in the
      feed.
  text: String (optional) The text contents of the element. This is the
      contents of the Entry's XML text node.
      (Example: <foo>This is the text</foo>)
  extension_elements: list (optional) A list of ExtensionElement instances
      which are children of this element.
  extension_attributes: dict (optional) A dictionary of strings which are
      the values for additional XML attributes of this element.

Data descriptors inherited from gdata.GDataFeed:
generator
id

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Methods inherited from gdata.LinkFinder:
GetAclLink(self)
GetEditLink(self)
GetEditMediaLink(self)
The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
GetFeedLink(self)
GetHtmlLink(self)
Find the first link with rel of alternate and type of text/html
 
Returns:
  An atom.Link or None if no links matched
GetNextLink(self)
GetPostLink(self)
Get a link containing the POST target URL.
 
The POST target URL is used to insert new entries.
 
Returns:
  A link object with a rel matching the POST type.
GetPrevLink(self)
GetSelfLink(self)
Find the first link with rel set to 'self'
 
Returns:
  An atom.Link or none if none of the links had rel equal to 'self'

Methods inherited from atom.LinkFinder:
GetAlternateLink(self)
GetLicenseLink(self)

 
Functions
       
ProfileEntryFromString(xml_string)
Converts an XML string into a ProfileEntry object.
 
Args:
  xml_string: string The XML describing a Health profile feed entry.
 
Returns:
  A ProfileEntry object corresponding to the given XML.
ProfileFeedFromString(xml_string)
Converts an XML string into a ProfileFeed object.
 
Args:
  xml_string: string The XML describing a ProfileFeed feed.
 
Returns:
  A ProfileFeed object corresponding to the given XML.
ProfileListEntryFromString(xml_string)
Converts an XML string into a ProfileListEntry object.
 
Args:
  xml_string: string The XML describing a Health profile list feed entry.
 
Returns:
  A ProfileListEntry object corresponding to the given XML.
ProfileListFeedFromString(xml_string)
Converts an XML string into a ProfileListFeed object.
 
Args:
  xml_string: string The XML describing a ProfileListFeed feed.
 
Returns:
  A ProfileListFeed object corresponding to the given XML.

 
Data
        CCR_NAMESPACE = 'urn:astm-org:CCR'
METADATA_NAMESPACE = 'http://schemas.google.com/health/metadata'
__author__ = 'api.eric@google.com (Eric Bidelman)'

 
Author
        api.eric@google.com (Eric Bidelman)