Public Member Functions | List of all members
ibis::qKeyword Class Reference

The class qKeyword encapsulates a search for a single keyword in a text field. More...

#include <qExpr.h>

Inheritance diagram for ibis::qKeyword:
ibis::qExpr

Public Member Functions

const char * colName () const
 Return the column name. More...
 
virtual qKeyworddup () const
 !< Reorder the expressions tree. More...
 
virtual void getTableNames (std::set< std::string > &plist) const
 Identify the data partitions involved in the query expression. More...
 
const char * keyword () const
 Return the keyword looking for. More...
 
virtual void print (std::ostream &) const
 Print out the node in the string form. More...
 
virtual void printFull (std::ostream &out) const
 Print out the full expression. More...
 
 qKeyword (const char *ls, const char *rs)
 
- Public Member Functions inherited from ibis::qExpr
bool directEval () const
 Can the expression be directly evaluated?
 
void extractDeprecatedJoins (std::vector< const deprecatedJoin * > &) const
 Extract conjunctive terms of the deprecated joins.
 
qRangefindRange (const char *vname)
 Find the first range condition involving the named variable.
 
void getConjunctiveTerms (termTableList &) const
 Extract the top-level conjunctive terms. More...
 
qExpr *& getLeft ()
 Return a pointer to the left child. More...
 
const qExprgetLeft () const
 Return a const pointer to the left child.
 
qExpr *& getRight ()
 Return a pointer to the right child. More...
 
const qExprgetRight () const
 Return a const pointer to the right child.
 
TYPE getType () const
 Return the node type.
 
virtual bool isConstant () const
 Is this expression a constant? A constant remains the same not matter which row it is applied to. More...
 
virtual bool isSimple () const
 Is the expression simple? A simple expression contains only range conditions connected with logical operators. More...
 
bool isTerminal () const
 Is this expression a terminal node of an expression tree?
 
virtual uint32_t nItems () const
 Count the number of items in the query expression.
 
qExproperator= (const qExpr &rhs)
 Assignment operator.
 
 qExpr ()
 Default constructor. It generates a node of undefined type.
 
 qExpr (TYPE op)
 Construct a node of specified type. Not for implicit type conversion.
 
 qExpr (TYPE op, qExpr *qe1, qExpr *qe2)
 Construct a full specified node. More...
 
 qExpr (const qExpr &qe)
 Copy Constructor. Deep copy.
 
double reorder (const weight &)
 After reordering, the lightest weight is one the left side of a group of commutable operators. More...
 
int separateSimple (ibis::qExpr *&simple, ibis::qExpr *&tail) const
 Separate an expression tree into two connected with an AND operator. More...
 
void setLeft (qExpr *expr)
 Change the left child. More...
 
void setRight (qExpr *expr)
 Change the right child. More...
 
void swap (qExpr &rhs)
 Swap the content. No exception expected.
 
virtual ~qExpr ()
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from ibis::qExpr
enum  COMPARE {
  OP_UNDEFINED, OP_LT, OP_GT, OP_LE,
  OP_GE, OP_EQ
}
 Comparison operator supported in RANGE.
 
typedef std::vector< TTNtermTableList
 
enum  TYPE {
  LOGICAL_UNDEFINED, LOGICAL_NOT, LOGICAL_AND, LOGICAL_OR,
  LOGICAL_XOR, LOGICAL_MINUS, RANGE, DRANGE,
  STRING, ANYSTRING, KEYWORD, ALLWORDS,
  COMPRANGE, MATHTERM, DEPRECATEDJOIN, TOPK,
  EXISTS, ANYANY, LIKE, INTHOD,
  UINTHOD
}
 Definition of node types. More...
 
- Static Public Member Functions inherited from ibis::qExpr
static std::string extractTableName (const char *)
 Extract the data partition name from the column name cn. More...
 
static void simplify (ibis::qExpr *&)
 Attempt to simplify the query expressions. More...
 
static void splitColumnName (const char *, std::string &, std::string &)
 Split the incoming name into data partition name and column name. More...
 
- Protected Member Functions inherited from ibis::qExpr
void adjust ()
 Adjust the tree to favor the sequential evaluation order. More...
 
- Protected Attributes inherited from ibis::qExpr
qExprleft
 The left child.
 
qExprright
 The right child.
 
TYPE type
 The type of node. More...
 

Detailed Description

The class qKeyword encapsulates a search for a single keyword in a text field.

Only exact match is supported at this point. This is similar to the transct-SQL CONTAINS command, but does not accept nearly as many options. In addition, the keyword CONTAINS is used like a binary operator as the keyword IN, e.g., <colunm-name> CONTAINS "keyword".

Member Function Documentation

const char* ibis::qKeyword::colName ( ) const
inline

Return the column name.

This is the first argument inside the CONTAINS operator.

Referenced by ibis::part::keywordSearch().

virtual qKeyword* ibis::qKeyword::dup ( ) const
inlinevirtual

!< Reorder the expressions tree.

Duplicate this query expression. Return the pointer to the new object.

Reimplemented from ibis::qExpr.

void ibis::qKeyword::getTableNames ( std::set< std::string > &  plist) const
virtual

Identify the data partitions involved in the query expression.

Return the list of data partition names in a set.

It records a '*' for the variables without explicit partition names.

Reimplemented from ibis::qExpr.

References ibis::qExpr::extractTableName().

const char* ibis::qKeyword::keyword ( ) const
inline

Return the keyword looking for.

This is the second argument inside the CONTAINS operator.

Referenced by ibis::part::keywordSearch().

void ibis::qKeyword::print ( std::ostream &  out) const
virtual

Print out the node in the string form.

The short-form of the print function.

It only prints information about the current node of the query expression tree.

Reimplemented from ibis::qExpr.

virtual void ibis::qKeyword::printFull ( std::ostream &  out) const
inlinevirtual

Print out the full expression.

The long form of the print function.

It recursively prints out the whole query expression tree, which can be quite long.

Reimplemented from ibis::qExpr.

References ibis::qExpr::print().


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

Make It A Bit Faster
Contact us
Disclaimers
FastBit source code
FastBit mailing list archive