C# Class DotNetNuke.Extensions.Data.Filter

Inheritance: IFilter

显示文件 Open project: JonHaywood/DotNetNuke.Extensions Class Usage Examples

Public Methods

Method	Description
And ( ) : Filter
ContainsString ( string columnName, string subString ) : Filter
ContainsStringWithinCommaSeparatedValues ( string columnName, string csvValue ) : Filter
CreateEmpty ( ) : Filter	Gets an empty query.
EqualTo ( string columnName, object equalTo ) : Filter	Extends the Query (using the AND operator) such that only rows with values equal to that specified in the named column should be included.
Equals ( object obj ) : bool
Filter ( ) : System	Constructs a new, empty, query.
GetExpressionString ( ) : string	Returns the where clause without the leading 'Where' command. To access the statement with a where command, use ToString().
GetHashCode ( ) : int
GreaterThan ( string columnName, object greaterThan ) : Filter	Extends the Query (using the AND operator) such that only rows with values greater than that specified in the named column should be included.
GreaterThanOrEqualTo ( string columnName, object greaterThanOrEqualTo ) : Filter	Extends the Query (using the AND operator) such that only rows with values greater than or equal to that specified in the named column should be included.
IsNotNull ( string columnName ) : Filter
IsNull ( string columnName ) : Filter
LessThan ( string columnName, object lessThan ) : Filter	Extends the Query (using the AND operator) such that only rows with values less than that specified in the named column should be included.
LessThanOrEqualTo ( string columnName, object lessThanOrEqualTo ) : Filter	Extends the Query (using the AND operator) such that only rows with values less than or equal to that specified in the named column should be included.
Like ( string columnName, string likePattern ) : Filter	Performs wildcard string matching upon the specified column.
NotEqualTo ( string columnName, object notEqualTo ) : Filter	Extends the Query (using the AND operator) such that only rows with values not equal to that specified in the named column should be included.
Or ( ) : Filter	Adds the specified sub-query using the OR logical operator.
OrContainsString ( string columnName, string subString ) : Filter
OrContainsStringWithinCommaSeparatedValues ( string columnName, string csvValue ) : Filter
OrEqualTo ( string columnName, object equalTo ) : Filter
OrGreaterThan ( string columnName, object greaterThan ) : Filter
OrGreaterThanOrEqualTo ( string columnName, object greaterThanOrEqualTo ) : Filter
OrIsNotNull ( string columnName ) : Filter
OrIsNull ( string columnName ) : Filter
OrLessThan ( string columnName, object lessThan ) : Filter
OrLessThanOrEqualTo ( string columnName, object lessThanOrEqualTo ) : Filter
OrLike ( string columnName, string likePattern ) : Filter
OrNotEqualTo ( string columnName, object notEqualTo ) : Filter
OrStartsWithString ( string columnName, string prefix ) : Filter
StartsWithString ( string columnName, string prefix ) : Filter
ToString ( ) : string	Returns the query's expression as a SQL string, prefixed with the 'Where' command. For example, `Where Column1='Value1'`.

Private Methods

Method	Description
And ( ConditionNode newCondition ) : Filter
CreateContainsStringCondition ( string subString, string columnName ) : ConditionNode
CreateContainsStringWithinCommaSeparatedValuesCondition ( string columnName, string csvValue ) : ConditionNode
CreateEqualToCondition ( string columnName, object equalTo ) : ConditionNode
CreateGreaterThanCondition ( string columnName, object greaterThan ) : ConditionNode
CreateGreaterThanOrEqualToCondition ( string columnName, object greaterThanOrEqualTo ) : ConditionNode
CreateIsNotNullCondition ( string columnName ) : ConditionNode
CreateIsNullCondition ( string columnName ) : ConditionNode
CreateLessThanCondition ( string columnName, object lessThan ) : ConditionNode
CreateLessThanOrEqualToCondition ( string columnName, object lessThanOrEqualTo ) : ConditionNode
CreateLikeCondition ( string columnName, string likePattern ) : ConditionNode
CreateNotEqualToCondition ( string columnName, object notEqualTo ) : ConditionNode
CreateStartsWithStringCondition ( string prefix, string columnName ) : ConditionNode
MergeConditionIntoTree ( LogicalOperator desiredLogicalOperator, ConditionNode newCondition ) : void
Or ( ConditionNode newCondition ) : Filter

Method Details

And() public method

public And ( ) : Filter
return	Filter

ContainsString() public method

public ContainsString ( string columnName, string subString ) : Filter
columnName	string
subString	string
return	Filter

ContainsStringWithinCommaSeparatedValues() public method

public ContainsStringWithinCommaSeparatedValues ( string columnName, string csvValue ) : Filter
columnName	string
csvValue	string
return	Filter

CreateEmpty() public static method

Gets an empty query.

public static CreateEmpty ( ) : Filter
return	Filter

EqualTo() public method

Extends the Query (using the AND operator) such that only rows with values equal to that specified in the named column should be included.

public EqualTo ( string columnName, object equalTo ) : Filter
columnName	string	The column to filter within.
equalTo	object
return	Filter

Equals() public method

public Equals ( object obj ) : bool
obj	object
return	bool

Filter() public method

Constructs a new, empty, query.

public Filter ( ) : System
return	System

GetExpressionString() public method

Returns the where clause without the leading 'Where' command. To access the statement with a where command, use ToString().

public GetExpressionString ( ) : string
return	string

GetHashCode() public method

public GetHashCode ( ) : int
return	int

GreaterThan() public method

Extends the Query (using the AND operator) such that only rows with values greater than that specified in the named column should be included.

public GreaterThan ( string columnName, object greaterThan ) : Filter
columnName	string	The column to filter within.
greaterThan	object
return	Filter

GreaterThanOrEqualTo() public method

Extends the Query (using the AND operator) such that only rows with values greater than or equal to that specified in the named column should be included.

public GreaterThanOrEqualTo ( string columnName, object greaterThanOrEqualTo ) : Filter
columnName	string	The column to filter within.
greaterThanOrEqualTo	object
return	Filter

IsNotNull() public method

public IsNotNull ( string columnName ) : Filter
columnName	string
return	Filter

IsNull() public method

public IsNull ( string columnName ) : Filter
columnName	string
return	Filter

LessThan() public method

Extends the Query (using the AND operator) such that only rows with values less than that specified in the named column should be included.

public LessThan ( string columnName, object lessThan ) : Filter
columnName	string	The column to filter within.
lessThan	object	The value that remaining rows must be less than.
return	Filter

LessThanOrEqualTo() public method

Extends the Query (using the AND operator) such that only rows with values less than or equal to that specified in the named column should be included.

public LessThanOrEqualTo ( string columnName, object lessThanOrEqualTo ) : Filter
columnName	string	The column to filter within.
lessThanOrEqualTo	object	The value that remaining rows must be less than or equal to.
return	Filter

Like() public method

Performs wildcard string matching upon the specified column.

public Like ( string columnName, string likePattern ) : Filter
columnName	string	The column to match within.
likePattern	string	The wildcard expression. Patterns commonly use the % symbol as a wildcard.
return	Filter

NotEqualTo() public method

Extends the Query (using the AND operator) such that only rows with values not equal to that specified in the named column should be included.

public NotEqualTo ( string columnName, object notEqualTo ) : Filter
columnName	string	The column to filter within.
notEqualTo	object
return	Filter

Or() public method

Adds the specified sub-query using the OR logical operator.

public Or ( ) : Filter
return	Filter

OrContainsString() public method

public OrContainsString ( string columnName, string subString ) : Filter
columnName	string
subString	string
return	Filter

OrContainsStringWithinCommaSeparatedValues() public method

public OrContainsStringWithinCommaSeparatedValues ( string columnName, string csvValue ) : Filter
columnName	string
csvValue	string
return	Filter

OrEqualTo() public method

public OrEqualTo ( string columnName, object equalTo ) : Filter
columnName	string
equalTo	object
return	Filter

OrGreaterThan() public method

public OrGreaterThan ( string columnName, object greaterThan ) : Filter
columnName	string
greaterThan	object
return	Filter

OrGreaterThanOrEqualTo() public method

public OrGreaterThanOrEqualTo ( string columnName, object greaterThanOrEqualTo ) : Filter
columnName	string
greaterThanOrEqualTo	object
return	Filter

OrIsNotNull() public method

public OrIsNotNull ( string columnName ) : Filter
columnName	string
return	Filter

OrIsNull() public method

public OrIsNull ( string columnName ) : Filter
columnName	string
return	Filter

OrLessThan() public method

public OrLessThan ( string columnName, object lessThan ) : Filter
columnName	string
lessThan	object
return	Filter

OrLessThanOrEqualTo() public method

public OrLessThanOrEqualTo ( string columnName, object lessThanOrEqualTo ) : Filter
columnName	string
lessThanOrEqualTo	object
return	Filter

OrLike() public method

public OrLike ( string columnName, string likePattern ) : Filter
columnName	string
likePattern	string
return	Filter

OrNotEqualTo() public method

public OrNotEqualTo ( string columnName, object notEqualTo ) : Filter
columnName	string
notEqualTo	object
return	Filter

OrStartsWithString() public method

public OrStartsWithString ( string columnName, string prefix ) : Filter
columnName	string
prefix	string
return	Filter

StartsWithString() public method

public StartsWithString ( string columnName, string prefix ) : Filter
columnName	string
prefix	string
return	Filter

ToString() public method

Returns the query's expression as a SQL string, prefixed with the 'Where' command. For example, Where Column1='Value1'.

public ToString ( ) : string
return	string