PredicateExpression Class

Implementation of the IPredicateExpression interface.

Inheritance Hierarchy

SystemObject
  SD.LLBLGen.Pro.ORMSupportClassesPredicate
    SD.LLBLGen.Pro.ORMSupportClassesPredicateExpression
      SD.LLBLGen.Pro.ORMSupportClassesCorrelationPredicateExpression

Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.4.0.0 (5.4.0)

Syntax

Copy

[SerializableAttribute]
public class PredicateExpression : Predicate, 
	IPredicateExpression, IPredicate, IEnumerable, IEnumerable<IPredicateExpressionElement>

<SerializableAttribute>
Public Class PredicateExpression
	Inherits Predicate
	Implements IPredicateExpression, IPredicate, IEnumerable, IEnumerable(Of IPredicateExpressionElement)

The PredicateExpression type exposes the following members.

Constructors

	Name	Description
	PredicateExpression	CTor. This empty constructor is not recommended when adding this instance directly to another PredicateExpression.
	PredicateExpression(IPredicate)	CTor.
	PredicateExpression(IPredicate, PredicateExpressionOperator, IPredicate)	CTor

Top

Properties

	Name	Description
	Count	Gets the amount of predicate expression elements in this predicate expression. This is including all operators.
	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. (Inherited from Predicate.)
	InstanceType	The PredicateType of this instance. Used to determine the instance nature without a lot of casting. (Inherited from Predicate.)
	Item	Gets the predicate expression element at the index specified
	Negate	Flag for setting the Predicate to negate itself, i.e. to add 'NOT' to its result. (Inherited from Predicate.)
	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). (Inherited from Predicate.)
	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 (Inherited from Predicate.)

Top

Methods

	Name	Description
	Add	Adds an IPredicate implementing object to the PredicateExpression. This can be a Predicate derived class or a PredicateExpression. If no object is present yet in the PredicateExpression, no operator is added, otherwise the object is added with an 'And'-operator.
	AddWithAnd	Adds an IPredicate implementing object to the PredicateExpression with an 'And'-operator. The object added can be a Predicate derived class or a PredicateExpression. If no objects are present yet in the PredicateExpression, the operator is ignored.
	AddWithOr	Adds an IPredicate implementing object to the PredicateExpression with an 'Or'-operator. The object added can be a Predicate derived class or a PredicateExpression. If no objects are present yet in the PredicateExpression, the operator is ignored.
	Clear	Clears this instance.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator	Returns an enumerator that iterates through a collection.
	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. (Overrides PredicateGetFrameworkElementsInPredicate.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InterpretPredicate	Interprets this predicate on the passed in entity (Overrides PredicateInterpretPredicate(IEntityCore).)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReadAdditionalXmlData	Reads the additional a derived type has from the reader's XML data. The reader is positioned at the 'predicate' element. (Overrides PredicateReadAdditionalXmlData(XmlReader).)
	ToQueryText	Implements the IPredicate ToQueryText method. Retrieves a ready to use text representation of the contained PredicateExpression. (Overrides PredicateToQueryText.)
	ToQueryText(Boolean)	Retrieves a ready to use text representation of the contained Predicate. (Overrides PredicateToQueryText(Boolean).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WriteAdditionalXmlData	Writes the additional data a derived type has to the writer specified. (Overrides PredicateWriteAdditionalXmlData(XmlWriter).)

Top

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.)

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableIPredicateExpressionElementGetEnumerator	Returns an enumerator that iterates through the collection.
	IXmlSerializableGetSchema	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. (Inherited from Predicate.)
	IXmlSerializableReadXml	Generates an object from its XML representation. (Inherited from Predicate.)
	IXmlSerializableWriteXml	Converts an object into its XML representation. (Inherited from Predicate.)
	IPredicateReadXml	Deserializes the predicate data on the xml reader into a predicate instance (Inherited from Predicate.)
	IPredicateWriteXml	Serializes the predicate as xml to the writer specified. (Inherited from Predicate.)
	IPredicateInterpretInterpret	Interprets the implementing class on the entity passed in. (Inherited from Predicate.)

Top

Reference

SD.LLBLGen.Pro.ORMSupportClasses Namespace