MetaFilter Class - Teradata Meta Data Services

Teradata Meta Data Services Programmer Guide

Product
Teradata Meta Data Services
Release Number
15.00
Language
English (United States)
Last Update
2018-09-28
Product Category
Teradata Tools and Utilities

MetaFilter Class

The IMetaFilter interface contains the basic properties of the CMetaFilterInfo class. See “CMetaFilterInfo Class Functions” for more detailed information.

 

Property

Type

Description

Operator

MetaComparisonOperator

The comparison operator used by the search.

Logical

MetaLogicalOperator

The logical operator used if multiple filters are used.

Filter

IMetaPropertyItem

The value of the filter.

OpenParenthesesCount

Short

Sets/gets the count of opened parentheses to allow grouping of filters. Used with CloseParaenthesesCount.

CloseParenthesesCount

Short

Sets/gets the count of closed parentheses to allow grouping of filters. Used with OpenParaenthesesCount.

get_Filter

Purpose:

Gets the filter value.

Syntax:

HRESULT get_Filter(
[out, retval] IMetaPropertyItem* *pVal);

put_Filter

Purpose:

Sets the filter value.

Syntax:

HRESULT put_Filter(
[in] IMetaPropertyItem* newVal);

get_Logical

Purpose:

Gets the Logical Operator. This operator can be used between two or more property filter items, to indicate how they are logically connected (“and” or “or”). If no logical operator is specified between two filter items, “and” is assumed. The logical operator “and” has precedence over “or”, but the use of parentheses can be used to change this.

Syntax:

HRESULT get_Logical(
[out, retval] MetaLogicalOperator *pVal);

put_Logical

Purpose:

Sets the Logical Operator. This operator can be used between two or more property filter items, to indicate how they are logically connected (“and” or “or”). If no logical operator is specified between two filter items, “and” is assumed. The logical operator “and” has precedence over “or”, but the use of parentheses can be used to change this.

Syntax:

HRESULT put_Logical(
[in] MetaLogicalOperator newVal);

get_Operator

Purpose:

Gets the Comparison Operator. The operator is used to create a comparison between the property and the value named in the filter. If no Operator value is set, EQUAL is assumed.

Syntax:

HRESULT get_Operator(
[out, retval] MetaComparisonOperator *pVal);

put_Operator

Purpose:

Sets the Comparison Operator. The operator is used to create a comparison between the property and the value named in the filter. If no Operator value is set, EQUAL is assumed.

Syntax:

HRESULT put_Operator(
[in] MetaComparisonOperator newVal);

get_OpenParenthesesCount

Purpose:

Gets the current count of opened parentheses, effectively enclosing filters in groups. This can be done to over-ride the usual precedence of AND over OR.

Syntax:

HRESULT get_OpenParenthesesCount(
[out, retval] short *pVal);

put_OpenParenthesesCount

Purpose:

Sets the current count of opened parentheses, effectively enclosing filters in groups. This can be done to over-ride the usual precedence of AND over OR.

Syntax:

HRESULT put_OpenParenthesesCount(
[in] short newVal);

get_CloseParenthesesCount

Purpose:

Gets the current count of closed parentheses, effectively enclosing filters in groups. This can be done to over-ride the usual precedence of AND over OR.

Syntax:

HRESULT get_CloseParenthesesCount (
[out, retval] short *pVal);

put_CloseParenthesesCount

Purpose:

Sets the current count of closed parentheses, effectively enclosing filters in groups. This can be done to over-ride the usual precedence of AND over OR.

Syntax:

HRESULT put_CloseParenthesesCount (
[in] short newVal);