Click or drag to resize

Predicate Class

Abstract base implementation of the IPredicate interface.
Inheritance Hierarchy
SystemObject
  SD.LLBLGen.Pro.ORMSupportClassesPredicate
    More...

Namespace:  SD.LLBLGen.Pro.ORMSupportClasses
Assembly:  SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.5.0.0 (5.5.18.1019)
Syntax
[SerializableAttribute]
public abstract class Predicate : IPredicate, 
	IPredicateInterpret, IXmlSerializable

The Predicate type exposes the following members.

Constructors
  NameDescription
Protected methodPredicate
CTor
Top
Properties
  NameDescription
Public propertyDatabaseSpecificCreator
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.
Public propertyInstanceType
The PredicateType of this instance. Used to determine the instance nature without a lot of casting.
Public propertyNegate
Flag for setting the Predicate to negate itself, i.e. to add 'NOT' to its result.
Public propertyObjectAlias
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).
Public propertyParameters
The list of parameters created when the Predicate was translated to text usable in a query. Only valid after a succesful call to ToQueryText
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetFrameworkElementsInPredicate
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.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInterpretPredicate
Interprets this predicate on the passed in entity
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodReadAdditionalXmlData
Reads the additional a derived type has from the reader's XML data. The reader is positioned at the 'predicate' element.
Public methodToQueryText
Retrieves a ready to use text representation of the contained Predicate.
Public methodToQueryText(Boolean)
Retrieves a ready to use text representation of the contained Predicate.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodWriteAdditionalXmlData
Writes the additional data a derived type has to the writer specified. The writer is positioned at the 'predicate' element.
Top
Operators
  NameDescription
Public operatorStatic memberBitwiseAnd
Operator overload for the '&' operator, to concatenate predicates together.
Public operatorStatic memberBitwiseOr
Operator overload for the '|' operator, to concatenate predicates together
Public operatorStatic memberLogicalNot
Operator overload for the ! operator, to negate the passed in predicate.
Top
Extension Methods
  NameDescription
Public Extension MethodAnd
Returns a new PredicateExpression with contents: predicate AND toAdd
(Defined by PredicateExtensionMethods.)
Public Extension MethodAndNot
Returns a new PredicateExpression with contents: predicate AND NOT toAdd
(Defined by PredicateExtensionMethods.)
Public Extension MethodAs
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.)
Public Extension MethodAsBooleanValue
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.)
Public Extension MethodIsEmpty
Determines whether the specified predicate or predicate expression is empty. A null passed in is also considered empty
(Defined by ORMClassExtensions.)
Public Extension MethodOr
Returns a new PredicateExpression with contents: predicate OR toAdd
(Defined by PredicateExtensionMethods.)
Public Extension MethodOrNot
Returns a new PredicateExpression with contents: predicate OR NOT toAdd
(Defined by PredicateExtensionMethods.)
Public Extension MethodToValue
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.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIXmlSerializableGetSchema
This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the XmlSchemaProviderAttribute to the class.
Explicit interface implementationPrivate methodIXmlSerializableReadXml
Generates an object from its XML representation.
Explicit interface implementationPrivate methodIXmlSerializableWriteXml
Converts an object into its XML representation.
Explicit interface implementationPrivate methodIPredicateReadXml
Deserializes the predicate data on the xml reader into a predicate instance
Explicit interface implementationPrivate methodIPredicateWriteXml
Serializes the predicate as xml to the writer specified.
Explicit interface implementationPrivate methodIPredicateInterpretInterpret
Interprets the implementing class on the entity passed in.
Top
See Also
Inheritance Hierarchy
SystemObject
  SD.LLBLGen.Pro.ORMSupportClassesPredicate
    SD.LLBLGen.Pro.ORMSupportClassesAggregateSetPredicate
    SD.LLBLGen.Pro.ORMSupportClassesDelegatePredicate
    SD.LLBLGen.Pro.ORMSupportClassesDelegatePredicateTEntity
    SD.LLBLGen.Pro.ORMSupportClassesFieldBetweenPredicate
    SD.LLBLGen.Pro.ORMSupportClassesFieldCompareExpressionPredicate
    SD.LLBLGen.Pro.ORMSupportClassesFieldCompareNullPredicate
    SD.LLBLGen.Pro.ORMSupportClassesFieldCompareRangePredicate
    SD.LLBLGen.Pro.ORMSupportClassesFieldCompareSetPredicate
    SD.LLBLGen.Pro.ORMSupportClassesFieldCompareValuePredicate
    SD.LLBLGen.Pro.ORMSupportClassesFieldFullTextSearchPredicate
    SD.LLBLGen.Pro.ORMSupportClassesFieldLikePredicate
    SD.LLBLGen.Pro.ORMSupportClassesMemberPredicate
    SD.LLBLGen.Pro.ORMSupportClassesPredicateExpression