DSIExtColumnRangeCondition Class Reference

A class which defines a range condition for a column in a seek. More...

Inherits Simba::SQLEngine::DSIExtColumnCondition.

List of all members.

Public Member Functions

virtual AutoPtr
< DSIExtColumnCondition
Clone () const
 Makes a deep copy of this object.
 DSIExtColumnRangeCondition (const SqlTypeMetadata &in_columnMeta, DSIExtRangeEndpointType in_minimumType, DSIExtRangeEndpointType in_maximumType)
 Constructor.
virtual
DSIExtColumnRangeCondition
GetAsColumnRange ()
 Get this object as a DSIExtColumnRangeCondition.
virtual const
DSIExtColumnRangeCondition
GetAsColumnRange () const
 Get this object as a DSIExtColumnRangeCondition.
DSIExtKeySegment GetMaximumSegment () const
 Get data for the maximum.
DSIExtRangeEndpointType GetMaximumType () const
 Get the type of the maximum endpoint of the range.
DSIExtKeySegment GetMinimumSegment () const
 Get data for the minimum.
DSIExtRangeEndpointType GetMinimumType () const
 Get the type of the minimum endpoint of the range.
void SetMaximumSegment (const DSIExtKeySegment &in_segment, bool in_mustCopy=false)
 Set data for the maximum endpoint of the range.
void SetMaximumType (DSIExtRangeEndpointType in_maximumType)
 Set the type of the maximum endpoint.
void SetMinimumSegment (const DSIExtKeySegment &in_segment, bool in_mustCopy=false)
 Set data for the minimum endpoint of the range.
void SetMinimumType (DSIExtRangeEndpointType in_minimumType)
 Set the type of the minimum endpoint.
virtual ~DSIExtColumnRangeCondition ()
 Destructor.

Detailed Description

A class which defines a range condition for a column in a seek.


Constructor & Destructor Documentation

DSIExtColumnRangeCondition ( const SqlTypeMetadata &  in_columnMeta,
DSIExtRangeEndpointType  in_minimumType,
DSIExtRangeEndpointType  in_maximumType 
)

Constructor.

Parameters:
in_columnMeta Metadata for the column this condition works on.
in_minimumType The type of the minimum end of the range. If DSI_EXT_ENDPOINT_UNUSED, there is no minimum.
in_maximumType The type of the maximum end of the range. If DSI_EXT_ENDPOINT_UNUSED, there is no maximum.
Exceptions:
SEInvalidArgumentException If both in_minimumType and in_maximumType are DSI_EXT_ENDPOINT_UNUSED
virtual ~DSIExtColumnRangeCondition (  )  [virtual]

Destructor.


Member Function Documentation

virtual AutoPtr<DSIExtColumnCondition> Clone (  )  const [virtual]

Makes a deep copy of this object.

Returns:
A deep copy of this object.

Implements DSIExtColumnCondition.

virtual DSIExtColumnRangeCondition& GetAsColumnRange (  )  [virtual]

Get this object as a DSIExtColumnRangeCondition.

Returns:
This object as a DSIExtColumnRangeCondition.

Reimplemented from DSIExtColumnCondition.

virtual const DSIExtColumnRangeCondition& GetAsColumnRange (  )  const [virtual]

Get this object as a DSIExtColumnRangeCondition.

Returns:
This object as a DSIExtColumnRangeCondition.

Reimplemented from DSIExtColumnCondition.

DSIExtKeySegment GetMaximumSegment (  )  const

Get data for the maximum.

Exceptions:
SEInvalidOperationException If there is no maximum.
Returns:
A DSIExtKeySegment containing data for the maximum
DSIExtRangeEndpointType GetMaximumType (  )  const

Get the type of the maximum endpoint of the range.

If this returns DSI_EXT_ENDPOINT_UNUSED, there is no maximum.

Returns:
The type of the maximum endpoint of the range.
DSIExtKeySegment GetMinimumSegment (  )  const

Get data for the minimum.

Exceptions:
SEInvalidOperationException If there is no minimum.
Returns:
A DSIExtKeySegment containing data for the minimum
DSIExtRangeEndpointType GetMinimumType (  )  const

Get the type of the minimum endpoint of the range.

If this returns DSI_EXT_ENDPOINT_UNUSED, there is no minimum.

Returns:
The type of the minimum endpoint of the range.
void SetMaximumSegment ( const DSIExtKeySegment in_segment,
bool  in_mustCopy = false 
)

Set data for the maximum endpoint of the range.

Parameters:
in_segment The data to set the maximum to.
in_mustCopy Whether in_data must be copied to an OWNed buffer, or if it can just cache the pointer to return later in GetMaximumSegment()
Exceptions:
SEInvalidOperationException If there is no maximum.
void SetMaximumType ( DSIExtRangeEndpointType  in_maximumType  ) 

Set the type of the maximum endpoint.

Exceptions:
SEInvalidArgumentException If this operation would cause this object to have no endpoints.
void SetMinimumSegment ( const DSIExtKeySegment in_segment,
bool  in_mustCopy = false 
)

Set data for the minimum endpoint of the range.

Parameters:
in_segment The data to set the minimum to.
in_mustCopy Whether in_data must be copied to an OWNed buffer, or if it can just cache the pointer to return later in GetMinimumSegment()
Exceptions:
SEInvalidOperationException If there is no minimum.
void SetMinimumType ( DSIExtRangeEndpointType  in_minimumType  ) 

Set the type of the minimum endpoint.

Exceptions:
SEInvalidArgumentException If this operation would cause this object to have no endpoints.

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

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