It is intended to encode a character string comparison operator with pattern matching. More...

#include <Like.h>

Inheritance diagram for te::da::Like:

Public Types
typedef void	ReturnType

typedef QueryVisitor	VisitorType

Public Member Functions
virtual ReturnType	accept (VisitorType &guest) const =0
	It call the visit method from the guest object. More...

void	add (Expression *arg)
	It adds the argument to the function list of arguments. More...

Expression *	clone () const
	It creates a new copy of this expression. More...

Expression *	getArg (std::size_t i) const
	It returns the i-th function argument. More...

const std::string &	getEscapeChar () const
	It returns the escape character. More...

const std::string &	getName () const
	It returns the function name. More...

std::size_t	getNumArgs () const
	It returns the number of arguments informed to the function. More...

const std::string &	getPattern ()
	It returns the pattern used in the comparison. More...

const std::string &	getSingleChar () const
	It returns the single wild character. More...

Expression *	getString () const
	It returns the string expression to be compared with the like operator. More...

const std::string &	getWildCard () const
	It returns the wild character. More...

TE_DEFINE_VISITABLE	Like (Expression *str, const std::string &pattern, const std::string &wildCard="%", const std::string &singleChar="_", const std::string &escapeChar="\\")
	Constructor. More...

	Like (const Expression &str, const std::string &pattern, const std::string &wildCard="%", const std::string &singleChar="_", const std::string &escapeChar="\\")
	Constructor. More...

	Like (const Like &rhs)
	Copy constructor. More...

Like &	operator= (const Like &rhs)

Expression *	operator[] (std::size_t i) const
	It returns the i-th function argument. More...

void	setEscapeChar (const std::string &e)
	It sets the escape character. More...

void	setPattern (const std::string &p)
	It sets the pattern to be used in the comparison. More...

void	setSingleChar (const std::string &s)
	It sets the wild single character. More...

void	setString (Expression *str)
	It sets the string expression to be compared with the like operator. More...

void	setWildCard (const std::string &w)
	It sets the wild character. More...

	~Like ()
	Destructor. More...

Protected Attributes
std::vector< Expression * >	m_args
	The list of arguments. More...

std::string	m_name
	The function name. May be an operator symbol or just a regular name like ST_Intersects. More...

Private Attributes
std::string	m_escapeChar
	The escape char character is used to escape the meaning of the wild card, single char and escape char itself. More...

std::string	m_pattern
	The literal string pattern. More...

std::string	m_singleChar
	The single char character matches exactly one character. More...

std::string	m_wildCard
	The wild card character matches zero or more characters. More...

Detailed Description

It is intended to encode a character string comparison operator with pattern matching.

See Also: Function

Definition at line 43 of file Like.h.

Member Typedef Documentation

typedef void te::common::BaseVisitable< QueryVisitor , void >::ReturnType

inherited

Definition at line 58 of file BaseVisitable.h.

typedef QueryVisitor te::common::BaseVisitable< QueryVisitor , void >::VisitorType

inherited

Definition at line 57 of file BaseVisitable.h.

Constructor & Destructor Documentation

te::da::Like::Like	(	Expression *	str,
		const std::string &	pattern,
		const std::string &	wildCard = `"%"`,
		const std::string &	singleChar = `"_"`,
		const std::string &	escapeChar = `"\\"`
	)

Constructor.

Parameters

str	The operator will take the expression ownership.

Definition at line 35 of file Like.cpp.

References te::da::Function::m_args.

te::da::Like::Like	(	const Expression &	str,
		const std::string &	pattern,
		const std::string &	wildCard = `"%"`,
		const std::string &	singleChar = `"_"`,
		const std::string &	escapeChar = `"\\"`
	)

Constructor.

Definition at line 49 of file Like.cpp.

References te::da::Expression::clone(), and te::da::Function::m_args.

te::da::Like::~Like ( )

Destructor.

Definition at line 63 of file Like.cpp.

te::da::Like::Like ( const Like & rhs )

Copy constructor.

Definition at line 67 of file Like.cpp.

Member Function Documentation

virtual ReturnType te::common::BaseVisitable< QueryVisitor , void >::accept ( VisitorType & guest ) const

pure virtualinherited

It call the visit method from the guest object.

Parameters

guest The guest or visitor.

Returns: Any valid value define by the template type R.

void te::da::Function::add ( Expression * arg )

inherited

It adds the argument to the function list of arguments.

Parameters

arg	The argument to be added.

Note: The Function will take the ownership of the given argument.

Definition at line 79 of file Function.cpp.

Referenced by te::map::QueryEncoder::getExpression(), te::da::ObjectIdSet::getExpression(), and te::map::QueryEncoder::visit().

te::da::Expression * te::da::Like::clone ( ) const

virtual

It creates a new copy of this expression.

Reimplemented from te::da::Function.

Definition at line 90 of file Like.cpp.

te::da::Expression * te::da::Function::getArg ( std::size_t i ) const

inherited

It returns the i-th function argument.

Parameters

i	The argument position.

Returns: The it-th function argument.

Definition at line 67 of file Function.cpp.

Referenced by te::da::SpatialRestrictionVisitor::getGeometryRestriction(), te::da::SpatialRestrictionVisitor::getPropertyName(), te::da::SpatialRestrictionVisitor::isFromEnvelope(), and te::serialize::xml::Save().

const std::string & te::da::Like::getEscapeChar ( ) const

It returns the escape character.

Returns: The escape character.

Definition at line 141 of file Like.cpp.

const std::string& te::da::Function::getName ( ) const

inlineinherited

It returns the function name.

Returns: The function name.

Definition at line 79 of file Function.h.

Referenced by te::da::AttributeRestrictionVisitor::getOperator(), te::da::SpatialRestrictionVisitor::getSpatialRelation(), te::da::AttributeRestrictionVisitor::isAttributeRestrictionFunction(), te::da::SpatialRestrictionVisitor::isSpatialRestrictionFunction(), te::serialize::xml::Save(), te::da::SpatialQueryProcessor::supportsSpatialTopologicOperatos(), and te::da::SQLVisitor::visit().

std::size_t te::da::Function::getNumArgs ( ) const

inherited

It returns the number of arguments informed to the function.

Returns: The number of parameters.

Definition at line 62 of file Function.cpp.

Referenced by te::da::SpatialRestrictionVisitor::getGeometryRestriction(), te::da::SpatialRestrictionVisitor::getPropertyName(), te::da::SpatialRestrictionVisitor::isFromEnvelope(), te::serialize::xml::Save(), te::da::FunctionNoArgsEncoder::toSQL(), te::da::BinaryOpEncoder::toSQL(), te::da::UnaryOpEncoder::toSQL(), te::da::FunctionEncoder::toSQL(), te::da::TemplateEncoder::toSQL(), te::da::AttributeRestrictionVisitor::visit(), te::da::SpatialRestrictionVisitor::visit(), and te::da::SQLVisitor::visit().

const std::string & te::da::Like::getPattern ( )

It returns the pattern used in the comparison.

Returns: The pattern used in the comparison.

Definition at line 106 of file Like.cpp.

const std::string & te::da::Like::getSingleChar ( ) const

It returns the single wild character.

Returns: The single wild character.

Definition at line 131 of file Like.cpp.

te::da::Expression * te::da::Like::getString ( ) const

It returns the string expression to be compared with the like operator.

Returns: The string expression to be compared with the like operator.

Definition at line 95 of file Like.cpp.

const std::string & te::da::Like::getWildCard ( ) const

It returns the wild character.

Returns: The wild character.

Definition at line 121 of file Like.cpp.

te::da::Like & te::da::Like::operator= ( const Like & rhs )

Assignment operator.

Definition at line 76 of file Like.cpp.

References m_escapeChar, m_pattern, m_singleChar, m_wildCard, and te::da::Function::operator=().

te::da::Expression * te::da::Function::operator[] ( std::size_t i ) const

inherited

It returns the i-th function argument.

Parameters

i	The argument position.

Returns: The it-th function argument.

Definition at line 73 of file Function.cpp.

void te::da::Like::setEscapeChar ( const std::string & e )

It sets the escape character.

Parameters

e	The escape character.

Definition at line 136 of file Like.cpp.

void te::da::Like::setPattern ( const std::string & p )

It sets the pattern to be used in the comparison.

Parameters

p	The pattern to be used in the comparison.

Definition at line 111 of file Like.cpp.

void te::da::Like::setSingleChar ( const std::string & s )

It sets the wild single character.

Parameters

s	The wild single character.

Definition at line 126 of file Like.cpp.

void te::da::Like::setString ( Expression * str )

It sets the string expression to be compared with the like operator.

Parameters

str	The string expression to be compared with the like operator.

Definition at line 100 of file Like.cpp.

void te::da::Like::setWildCard ( const std::string & w )

It sets the wild character.

Parameters

w	The wild character.

Definition at line 116 of file Like.cpp.

Member Data Documentation

std::vector<Expression*> te::da::Function::m_args

protectedinherited

The list of arguments.

Definition at line 118 of file Function.h.

Referenced by te::da::BinaryFunction::BinaryFunction(), te::da::Function::Function(), Like(), te::da::Function::operator=(), te::da::ST_Buffer::ST_Buffer(), te::da::ST_DistanceBuffer::ST_DistanceBuffer(), te::da::ST_Relate::ST_Relate(), te::da::ST_Transform::ST_Transform(), te::da::Substring::Substring(), and te::da::UnaryFunction::UnaryFunction().

std::string te::da::Like::m_escapeChar

private

The escape char character is used to escape the meaning of the wild card, single char and escape char itself.

Definition at line 154 of file Like.h.

Referenced by operator=().

std::string te::da::Function::m_name

protectedinherited

The function name. May be an operator symbol or just a regular name like ST_Intersects.

Definition at line 117 of file Function.h.

Referenced by te::da::Function::operator=().

std::string te::da::Like::m_pattern

private

The literal string pattern.

Definition at line 151 of file Like.h.

Referenced by operator=().

std::string te::da::Like::m_singleChar

private

The single char character matches exactly one character.

Definition at line 153 of file Like.h.

Referenced by operator=().

std::string te::da::Like::m_wildCard

private

The wild card character matches zero or more characters.

Definition at line 152 of file Like.h.

Referenced by operator=().

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

/home/castejon/castejon_files/develop/terralib5/git/src/terralib/dataaccess/query/Like.h
/home/castejon/castejon_files/develop/terralib5/git/src/terralib/dataaccess/query/Like.cpp

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation