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.stub.expression_evaluator.ExpressionEvaluator Class Reference
Inheritance diagram for google.appengine.api.search.stub.expression_evaluator.ExpressionEvaluator:

Public Member Functions

def __init__
 
def ValueOf
 
def Evaluate
 

Detailed Description

Evaluates an expression on scored documents.

Constructor & Destructor Documentation

def google.appengine.api.search.stub.expression_evaluator.ExpressionEvaluator.__init__ (   self,
  document,
  inverted_index,
  is_sort_expression = False 
)
Constructor.

Args:
  document: The ScoredDocument to evaluate the expression for.
  inverted_index: The search index (used for snippeting).
  is_sort_expression: The flag indicates if this is a sort expression. Some
operations (such as COUNT) are not supported in sort expressions.

Member Function Documentation

def google.appengine.api.search.stub.expression_evaluator.ExpressionEvaluator.Evaluate (   self,
  expression 
)
Evaluates the expression for a document and attaches the result.

Args:
  expression: The Expression protobuffer object.
def google.appengine.api.search.stub.expression_evaluator.ExpressionEvaluator.ValueOf (   self,
  expression,
  default_value = None,
  return_type = None 
)
Returns the value of an expression on a document.

Args:
  expression: The expression string.
  default_value: The value to return if the expression cannot be evaluated.
  return_type: The type the expression should evaluate to. Used to create
multiple sorts for ambiguous expressions. If None, the expression
evaluates to the inferred type or first type of a field it encounters in
a document.

Returns:
  The value of the expression on the evaluator's document, or default_value
  if the expression cannot be evaluated on the document.

Raises:
  ExpressionEvaluationError: sort expression cannot be evaluated
  because the expression or default value is malformed. Callers of
  ValueOf should catch and return error to user in response.
  QueryExpressionEvaluationError: same as ExpressionEvaluationError but
  these errors should return query as error status to users.

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