App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | List of all members
google.appengine.api.search.search.Field Class Reference
Inheritance diagram for google.appengine.api.search.search.Field:
google.appengine.api.search.search.AtomField google.appengine.api.search.search.DateField google.appengine.api.search.search.GeoField google.appengine.api.search.search.HtmlField google.appengine.api.search.search.NumberField google.appengine.api.search.search.TextField

Public Member Functions

def __init__
 
def name
 
def language
 
def value
 
def __repr__
 
def __eq__
 
def __ne__
 
def __hash__
 
def __str__
 

Detailed Description

An abstract base class which represents a field of a document.

This class should not be directly instantiated.

Constructor & Destructor Documentation

def google.appengine.api.search.search.Field.__init__ (   self,
  name,
  value,
  language = None 
)
Initializer.

Args:
  name: The name of the field. Field names must have maximum length
MAXIMUM_FIELD_NAME_LENGTH and match pattern "[A-Za-z][A-Za-z0-9_]*".
  value: The value of the field which can be a str, unicode or date.
  language: The ISO 693-1 two letter code of the language used in the value.
See http://www.sil.org/iso639-3/codes.asp?order=639_1&letter=%25 for a
list of valid codes. Correct specification of language code will assist
in correct tokenization of the field. If None is given, then the
language code of the document will be used.

Raises:
  TypeError: If any of the parameters have invalid types, or an unknown
attribute is passed.
  ValueError: If any of the parameters have invalid values.

Member Function Documentation

def google.appengine.api.search.search.Field.language (   self)
Returns the code of the language the content in value is written in.
def google.appengine.api.search.search.Field.name (   self)
Returns the name of the field.
def google.appengine.api.search.search.Field.value (   self)
Returns the value of the field.

The documentation for this class was generated from the following file: