AEBooleanExpr Class Reference

The base class for all the bool expressions such as AND, OR, IN, and etc. More...

Inherits Simba::SQLEngine::AENode.

Inherited by AEBinaryExprT< AEBooleanExpr, AEBooleanExpr >, AEBinaryExprT< AEBooleanExpr, AEValueExpr, AEValueExpr, SharedPtr< AEValueExpr >, SharedPtr< AEValueExpr > >, AEBinaryExprT< AEBooleanExpr, AEValueList >, AEBinaryExprT< AEBooleanExpr, AEValueList, AENode >, AEBinaryExprT< AEBooleanExpr, AEValueList, AERelationalExpr >, AETerminalExprT< AEBooleanExpr >, AEUnaryExprT< AEBooleanExpr, AEBooleanExpr >, AEUnaryExprT< AEBooleanExpr, AERelationalExpr >, and AEUnaryExprT< AEBooleanExpr, AEValueList >.

List of all members.

Public Member Functions

virtual AEBooleanExprClone () const =0
 Creates a clone of this node object.
virtual const AEAndGetAsAnd () const
 Get the object as an AEAnd object.
virtual AEAndGetAsAnd ()
 Get the object as an AEAnd object.
virtual const AEBinaryBooleanExprGetAsBinaryBooleanExpr () const
 Retrieve this node as an AEBinaryBooleanExpr node.
virtual AEBinaryBooleanExprGetAsBinaryBooleanExpr ()
 Retrieve this node as an AEBinaryBooleanExpr node.
virtual const AEBooleanExprGetAsBooleanExpr () const
 Get the object as an AEBooleanExpr object.
virtual AEBooleanExprGetAsBooleanExpr ()
 Get the object as an AEBooleanExpr object.
virtual const AEBooleanTrueGetAsBooleanTrue () const
 Get the object as an AEBooleanTrue object.
virtual AEBooleanTrueGetAsBooleanTrue ()
 Get the object as an AEBooleanTrue object.
virtual const AEComparisonGetAsComparison () const
 Get the object as an AEComparison object.
virtual AEComparisonGetAsComparison ()
 Get the object as an AEComparison object.
virtual const AEExistsPredicateGetAsExistsPredicate () const
 Get the object as an AEExistsPredicate object.
virtual AEExistsPredicateGetAsExistsPredicate ()
 Get the object as an AEExistsPredicate object.
virtual const AEInPredicateGetAsInPredicate () const
 Get the object as an AEInPredicate object.
virtual AEInPredicateGetAsInPredicate ()
 Get the object as an AEInPredicate object.
virtual const AELikePredicateGetAsLikePredicate () const
 Get the object as an AELikePredicate object.
virtual AELikePredicateGetAsLikePredicate ()
 Get the object as an AELikePredicate object.
virtual const AENotGetAsNot () const
 Retrieves the object as an AENot object.
virtual AENotGetAsNot ()
 Get the object as an AENot object.
virtual const AENullPredicateGetAsNullPredicate () const
 Get the object as an AENullPredicate object.
virtual AENullPredicateGetAsNullPredicate ()
 Get the object as an AENullPredicate object.
virtual const AEOrGetAsOr () const
 Get the object as an AEOr object.
virtual AEOrGetAsOr ()
 Get the object as an AEOr object.
virtual const
AEQuantifiedComparison
GetAsQuantifiedComparison () const
 Get the object as an AEQuantifiedComparison object.
virtual AEQuantifiedComparisonGetAsQuantifiedComparison ()
 Get the object as an AEQuantifiedComparison object.
virtual const
Simba::DSI::DSIColumnMetadata
GetColumnMetadata () const
 Get this node's DSIColumnMetadata.
virtual
Simba::DSI::DSIColumnMetadata
GetColumnMetadata ()
 Get this node's DSIColumnMetadata.
ETBooleanExprGetMaterializedExpr () const
 Get the materialized ET boolean expression for this AE boolean expression.
virtual SqlTypeMetadataGetMetadata ()
 Get this nodes SqlTypeMetadata.
virtual bool HasBeenOptimized () const
 Get whether this AEBooleanExpr has had push-down filter optimization applied to it.
virtual bool IsBinaryBooleanExpr () const
 Determines if this is an AEBinaryBooleanExpr node.
virtual bool IsBooleanExpr () const
 Tells whether this is an AEBooleanExpr node.
virtual bool IsPredicate () const
 Determines if this is a predicate node.
virtual void SetColumnMetadata (Simba::DSI::DSIColumnMetadata *in_colMetadata)
 Set this node's DSIColumnMetadata.
virtual void SetHasBeenOptimized (bool in_hasBeenOptimized)
 Set whether this AEBooleanExpr has had push-down filter optimization applied to it.
void SetMaterializedExpr (ETBooleanExpr *in_boolExpr)
 Set the materialized ET boolean expression for this AE boolean expression.
virtual void SetMetadata (SqlTypeMetadata *in_metadata)
 Set this nodes SqlTypeMetadata.
virtual ~AEBooleanExpr ()
 Destructor.

Protected Member Functions

 AEBooleanExpr (const AEBooleanExpr &in_other)
 Copy constructor.
 AEBooleanExpr ()
 Default constructor.

Detailed Description

The base class for all the bool expressions such as AND, OR, IN, and etc.

The list of end nodes which subclass AEBooleanExpr is:


Constructor & Destructor Documentation

virtual ~AEBooleanExpr (  )  [virtual]

Destructor.

AEBooleanExpr (  )  [protected]

Default constructor.

AEBooleanExpr ( const AEBooleanExpr in_other  )  [protected]

Copy constructor.

To support "cloning". See Clone() method.

Parameters:
in_other The other node to create copy from.

Member Function Documentation

virtual AEBooleanExpr* Clone (  )  const [pure virtual]

Creates a clone of this node object.

Returns:
A clone of this node object. (OWN)

Implements AENode.

Implemented in AEAnd, AEBinaryBooleanExpr, AEBooleanTrue, AEComparison, AEExistsPredicate, AEInPredicate, AENot, AENullPredicate, and AEOr.

virtual const AEAnd* GetAsAnd (  )  const [virtual]

Get the object as an AEAnd object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEAnd object.

Reimplemented in AEAnd.

virtual AEAnd* GetAsAnd (  )  [virtual]

Get the object as an AEAnd object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEAnd object.

Reimplemented in AEAnd.

virtual const AEBinaryBooleanExpr* GetAsBinaryBooleanExpr (  )  const [virtual]

Retrieve this node as an AEBinaryBooleanExpr node.

This default implementation always throws an exception. The appropriate sub-class must override this method along with IsBinaryBooleanExpr().

Exceptions:
SEInvalidOperationException if this is not an AEBinaryBooleanExpr node.
Returns:
This node as an AEBinaryBooleanExpr node. (NOT OWN)

Reimplemented in AEBinaryBooleanExpr.

virtual AEBinaryBooleanExpr* GetAsBinaryBooleanExpr (  )  [virtual]

Retrieve this node as an AEBinaryBooleanExpr node.

This default implementation always throws an exception. The appropriate sub-class must override this method along with IsBinaryBooleanExpr().

Exceptions:
SEInvalidOperationException if this is not an AEBinaryBooleanExpr node.
Returns:
This node as an AEBinaryBooleanExpr node. (NOT OWN)

Reimplemented in AEBinaryBooleanExpr.

virtual const AEBooleanExpr* GetAsBooleanExpr (  )  const [virtual]

Get the object as an AEBooleanExpr object.

Overrides the method defined in AENode. Sub-classes must _NOT_ override this method again.

Returns:
This object always.

Reimplemented from AENode.

virtual AEBooleanExpr* GetAsBooleanExpr (  )  [virtual]

Get the object as an AEBooleanExpr object.

Overrides the method defined in AENode. Sub-classes must _NOT_ override this method again.

Returns:
This object always.

Reimplemented from AENode.

virtual const AEBooleanTrue* GetAsBooleanTrue (  )  const [virtual]

Get the object as an AEBooleanTrue object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEBooleanTrue object.

Reimplemented in AEBooleanTrue.

virtual AEBooleanTrue* GetAsBooleanTrue (  )  [virtual]

Get the object as an AEBooleanTrue object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEBooleanTrue object.

Reimplemented in AEBooleanTrue.

virtual const AEComparison* GetAsComparison (  )  const [virtual]

Get the object as an AEComparison object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEComparison object.

Reimplemented in AEComparison.

virtual AEComparison* GetAsComparison (  )  [virtual]

Get the object as an AEComparison object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEComparison object.

Reimplemented in AEComparison.

virtual const AEExistsPredicate* GetAsExistsPredicate (  )  const [virtual]

Get the object as an AEExistsPredicate object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEExistsPredicate object.

Reimplemented in AEExistsPredicate.

virtual AEExistsPredicate* GetAsExistsPredicate (  )  [virtual]

Get the object as an AEExistsPredicate object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEExistsPredicate object.

Reimplemented in AEExistsPredicate.

virtual const AEInPredicate* GetAsInPredicate (  )  const [virtual]

Get the object as an AEInPredicate object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEInPredicate object.

Reimplemented in AEInPredicate.

virtual AEInPredicate* GetAsInPredicate (  )  [virtual]

Get the object as an AEInPredicate object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEInPredicate object.

Reimplemented in AEInPredicate.

virtual const AELikePredicate* GetAsLikePredicate (  )  const [virtual]

Get the object as an AELikePredicate object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AELikePredicate object.
virtual AELikePredicate* GetAsLikePredicate (  )  [virtual]

Get the object as an AELikePredicate object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AELikePredicate object.
virtual const AENot* GetAsNot (  )  const [virtual]

Retrieves the object as an AENot object.

Overrides the method defined in AEBooleanExpr.

Returns:
this object as an AENot object. (NOT OWN)

Reimplemented in AENot.

virtual AENot* GetAsNot (  )  [virtual]

Get the object as an AENot object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AENot object.

Reimplemented in AENot.

virtual const AENullPredicate* GetAsNullPredicate (  )  const [virtual]

Get the object as an AENullPredicate object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AENullPredicate object.

Reimplemented in AENullPredicate.

virtual AENullPredicate* GetAsNullPredicate (  )  [virtual]

Get the object as an AENullPredicate object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AENullPredicate object.

Reimplemented in AENullPredicate.

virtual const AEOr* GetAsOr (  )  const [virtual]

Get the object as an AEOr object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEOr object.

Reimplemented in AEOr.

virtual AEOr* GetAsOr (  )  [virtual]

Get the object as an AEOr object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEOr object.

Reimplemented in AEOr.

virtual const AEQuantifiedComparison* GetAsQuantifiedComparison (  )  const [virtual]

Get the object as an AEQuantifiedComparison object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEQuantifiedComparison object.
virtual AEQuantifiedComparison* GetAsQuantifiedComparison (  )  [virtual]

Get the object as an AEQuantifiedComparison object.

This default implementation always throws an exception. The appropriate sub-class must override this method.

Exceptions:
SEInvalidOperationException if this object is not of expected type.
Returns:
this object as an AEQuantifiedComparison object.
virtual const Simba::DSI::DSIColumnMetadata* GetColumnMetadata (  )  const [virtual]

Get this node's DSIColumnMetadata.

Returns:
The DSIColumnMetadata for this boolean expression node. (NOT OWN)
virtual Simba::DSI::DSIColumnMetadata* GetColumnMetadata (  )  [virtual]

Get this node's DSIColumnMetadata.

Returns:
The DSIColumnMetadata for this boolean expression node. (NOT OWN)
ETBooleanExpr* GetMaterializedExpr (  )  const [inline]

Get the materialized ET boolean expression for this AE boolean expression.

Returns:
the materialized ET boolean expression for this AE boolean expression if that's available, NULL otherwise.
virtual SqlTypeMetadata* GetMetadata (  )  [virtual]

Get this nodes SqlTypeMetadata.

Returns:
The SqlTypeMetadata for this boolean expression node. (NOT OWN)

Reimplemented in AENullPredicate.

virtual bool HasBeenOptimized (  )  const [virtual]

Get whether this AEBooleanExpr has had push-down filter optimization applied to it.

This is so that a filter does not go through the push-down process twice.

Returns:
True if this node has had push-down filter optimization applied to it; false otherwise.
virtual bool IsBinaryBooleanExpr (  )  const [virtual]

Determines if this is an AEBinaryBooleanExpr node.

This default implementation always returns false. The appropriate sub-class must override this method along with GetAsBinaryBooleanExpr().

Returns:
True if this is an AEBinaryBooleanExpr node, false otherwise.

Reimplemented in AEBinaryBooleanExpr.

virtual bool IsBooleanExpr (  )  const [virtual]

Tells whether this is an AEBooleanExpr node.

Overrides the method defined in AENode. Sub-classes must _NOT_ override this method again.

Returns:
True if this is an AEBooleanExpr node, false otherwise.

Reimplemented from AENode.

virtual bool IsPredicate (  )  const [virtual]

Determines if this is a predicate node.

This default implementation always returns false. All predicate node must override it.

Returns:
True if this is a predicate node, false otherwise.

Reimplemented in AEComparison, AEExistsPredicate, AEInPredicate, and AENullPredicate.

virtual void SetColumnMetadata ( Simba::DSI::DSIColumnMetadata in_colMetadata  )  [virtual]

Set this node's DSIColumnMetadata.

Parameters:
in_colMetadata The DSIColumnMetadata to set for this node. (OWN)
virtual void SetHasBeenOptimized ( bool  in_hasBeenOptimized  )  [virtual]

Set whether this AEBooleanExpr has had push-down filter optimization applied to it.

This is so that a filter does not go through the push-down process twice.

Parameters:
in_hasBeenOptimized True if this node has had push-down filter optimization applied to it.
void SetMaterializedExpr ( ETBooleanExpr in_boolExpr  )  [inline]

Set the materialized ET boolean expression for this AE boolean expression.

Parameters:
in_boolExpr The materialized ET boolean expression for this expression.
Exceptions:
SEInvalidArgumentException when in_boolExpr is NULL
virtual void SetMetadata ( SqlTypeMetadata in_metadata  )  [virtual]

Set this nodes SqlTypeMetadata.

Parameters:
in_metadata The SqlTypeMetadata to set for this node. (OWN)

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

Generated on Wed May 17 14:21:16 2017 for SimbaEngine 10.1.3.1011 by simba