IPredicate Interface |
Interface for a predicate. Predicates are expressions which result in true or false, and which are used in WHERE clauses.
Generic
Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.4.0.0 (5.4.0)
SyntaxThe IPredicate type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | DatabaseSpecificCreator |
Object which will be used to create valid parameter objects, field names, including prefix/postfix characters,
and conversion routines, and field names, including prefix/postfix characters.
Uses the strategy pattern so the generic code can work with more than one target database.
|
| InstanceType |
The PredicateType of this instance. Used to determine the instance nature without a lot of casting.
|
| Negate |
Flag for setting the Predicate to negate itself, i.e. to add 'NOT' to its result.
|
| ObjectAlias |
Alias for the object the field belongs to. Used to identify which entity to use when the entity
is present multiple times in a relation collection. Alias has to match an alias specified in the relation collection or should be
left empty if no alias is specified (or no relation collection is used).
|
| Parameters |
The list of parameters created when the Predicate was translated to text usable in a query. Only valid after a succesful call to ToQueryText
|
Methods| Name | Description | |
|---|---|---|
 | GetFrameworkElementsInPredicate |
Gets a list of all framework objects (fields, expression objects etc.) which are located in this IPredicate instance. E.g. a
FieldCompareValuePredicate will return a list with 1 IEntityFieldCore instance: the field to compare. If no framework elements are present in the
predicate, the base implementation is used, which returns an empty list. This routine is used to gather information for Linq queries.
|
| ReadXml |
Deserializes the predicate data on the xml reader into a predicate instance
|
| ToQueryText |
Retrieves a ready to use text representation of the contained Predicate.
|
| ToQueryText(Boolean) |
Retrieves a ready to use text representation of the contained Predicate.
|
| WriteXml |
Serializes the predicate as xml to the writer specified.
|
Extension Methods| Name | Description | |
|---|---|---|
 | And |
Returns a new PredicateExpression with contents: predicate AND toAdd
(Defined by PredicateExtensionMethods.) |
| AndNot |
Returns a new PredicateExpression with contents: predicate AND NOT toAdd
(Defined by PredicateExtensionMethods.) |
| As |
Specifies an alias for the value returned by the predicate when the predicate is used in a projection. Equal to:
Functions.IIF(predicate, true, false).As(alias)
(Defined by PredicateExtensionMethods.) |
| AsBooleanValue |
Returns the predicate wrapped in a CASE WHEN (predicate) THEN 1 ELSE 0 END construct (as a function call expression) so the predicate can be
used as a real boolean value in other places than the Where clause.
(Defined by PredicateExtensionMethods.) |
| IsEmpty |
Determines whether the specified predicate or predicate expression is empty. A null passed in is also considered empty
(Defined by ORMClassExtensions.) |
| Or |
Returns a new PredicateExpression with contents: predicate OR toAdd
(Defined by PredicateExtensionMethods.) |
| OrNot |
Returns a new PredicateExpression with contents: predicate OR NOT toAdd
(Defined by PredicateExtensionMethods.) |
| ToValue |
Placeholder method which is used in a Select(lambda func) projection inside the lambda to specify the type of the result of the passed in predicate.
Use this method only when specifying a predicate in the projection lambda.
(Defined by PredicateExtensionMethods.) |
See Also