EntityRelation Class

Generic implementation of the IEntityRelation interface, which is used for relations between IEntity* instances.

Inheritance Hierarchy

SystemObject
SD.LLBLGen.Pro.ORMSupportClassesEntityRelation

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 EntityRelation : IEntityRelation, 
	IRelation, IXmlSerializable

<SerializableAttribute>
Public Class EntityRelation
	Implements IEntityRelation, IRelation, IXmlSerializable

The EntityRelation type exposes the following members.

Constructors

	Name	Description
	EntityRelation	CTor
	EntityRelation(RelationType)	CTor
	EntityRelation(RelationType, Boolean)	Initializes a new instance of the EntityRelation class.
	EntityRelation(RelationType, String)	Initializes a new instance of the EntityRelation class.
	EntityRelation(IEntityField, IEntityField, RelationType)	CTor
	EntityRelation(IEntityField2, IEntityField2, RelationType)	CTor
	EntityRelation(RelationType, String, Boolean)	Initializes a new instance of the EntityRelation class.
	EntityRelation(IEntityField, IEntityField, RelationType, Boolean, String)	Initializes a new instance of the EntityRelation class.
	EntityRelation(IEntityField2, IEntityField2, RelationType, Boolean, String)	Initializes a new instance of the EntityRelation class.

Top

Properties

	Name	Description
	AliasEndEntity	Gets the alias of the end entity.
	AliasFKSide	Alias value for the entity which is on the FK side of the relation. Determined from the relation type and the pk/fk fields
	AliasPKSide	Alias value for the entity which is on the PK side of the relation. Determined from the relation type and the pk/fk fields
	AliasStartEntity	Gets the alias of the start entity.
	AmountFields	Returns the amount of fields in the EntityRelation object.
	CustomFilter	Custom filter for JOIN clauses which are added with AND to the ON clause resulting from this EntityRelation. By adding a predicate expression with fieldcomparevalue predicate objects for example, you can add extra filtering inside the JOIN.
	CustomFilterReplacesOnClause	Flag to signal the join creator logic to use the CustomFilter specified as the ON clause, instead of appending the CustomFilter to the ON clause. Ignored if CustomFilter is null or empty. Default is false.
	HintForJoins	Hint value for the consideration of the jointype of this relation. Default: JoinHint.None
	InheritanceInfoFkSideEntity	Gets or sets the inheritance info for the fk side entity.
	InheritanceInfoPkSideEntity	Gets or sets the inheritance info for the pk side entity.
	IsHierarchyRelation	Gets or sets a value indicating whether this instance is a hierarchy relation.
	IsWeak	Flag to signal if this relation is a 'weak' relation or not. Weak relations are optional relations, which means when A and B have a weak relation, not all instances of A have to have a related instance of B.
	MappedFieldName	Gets or sets the name of the field mapped onto this relation in the start entity.
	StartEntityIsPkSide	Set to true if the start entity of the relation is the PK side of the relation. This is set in the generated code. This property is true in 1:n relations and in 1:1 relations where the start entity is the PK side and the end entity is thus the FK side. Required for determining which alias belongs to which entity.
	TypeOfRelation	The relation type the IEntityRelation instance represents.

Top

Methods

	Name	Description
	AddEntityFieldPairTEntityField	Adds a new pair of entity field instances to the relation. Primary Key fields and Foreign Key Fields have to be added in pairs.
	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.)
	GetAllFKEntityFieldCoreObjects	Returns in an arraylist all IEntityFieldCore objects for the FK fields in this entityrelation
	GetAllFKFieldPersistenceInfoObjects	Returns in an arraylist all IFieldPersistenceInfo objects for the FK fields in this entityrelation
	GetAllPKEntityFieldCoreObjects	Returns in an arraylist all IEntityFieldCore objects for the PK fields in this entityrelation
	GetAllPKFieldPersistenceInfoObjects	Returns in an arraylist all IFieldPersistenceInfo objects for the PK fields in this entityrelation
	GetFKEntityFieldCore	Gets the IEntityFieldCore information about the FK field at index specified
	GetFKFieldPersistenceInfo	Gets the IFieldPersistenceInfo data for the FK field at index specified.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetPKEntityFieldCore	Gets the IEntityFieldCore information about the PK field at index specified
	GetPKFieldPersistenceInfo	Gets the IFieldPersistenceInfo data for the PK field at index specified.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUsedEntityTypeNamesAndAliases	Gets per alias specified in a relation all entity names covered by that alias. This means that if an entity in a relation is based on multiple entities (through inheritance) it will return all entity names the entity is based on, from the actual entity to the root of the hierarchy path and every entity name in between.
	InjectInheritanceInfo	Injects for the PK and FK side the inheritance info for this entity relation. It sets InheritanceInfoPkSideEntity and InheritanceInfoFkSideEntity using the provider specified.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetAliases	Sets the aliases for the start entity and the end entity formed by the fields stored in this entityrelation. The start entity and end entity are determined based on the type of the relation and the primary key / foreign key fields. Mainly used by RelationCollection.Add().
	SetFKFieldPersistenceInfo	Sets the IFieldPersistenceInfo data for the FK field at index specified.
	SetPKFieldPersistenceInfo	Sets the IFieldPersistenceInfo data for the PK field at index specified.
	ToString	Returns a String that represents the current Object. (Overrides ObjectToString.)

Top

Extension Methods

	Name	Description
	SetCustomFilter(IPredicate)	Overloaded. Sets the CustomFilter on the specified relation, and passing false for ReplacesOnClause. A custom filter is a predicate(-expression) which is appended to the ON clause created from the relation specified. (Defined by JoinOperandExtensionMethods.)
	SetCustomFilter(IPredicate, Boolean)	Overloaded. Sets the CustomFilter on the specified relation. A custom filter is a predicate(-expression) which is appended to the ON clause created from the relation specified. If replacesOnClause is true, it replaces the ON clause with the filter specified. (Defined by JoinOperandExtensionMethods.)

Top

Explicit Interface Implementations

	Name	Description
	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.
	IXmlSerializableReadXml	Generates an object from its XML representation.
	IXmlSerializableWriteXml	Converts an object into its XML representation.
	IRelationAliasLeftOperand	Gets the alias for the left operand (Start entity)
	IRelationAliasRightOperand	Gets the alias for the right operand (End entity)
	IRelationGetUsedEntityTypeNamesAndAliases	Gets per alias specified in a relation all entity names covered by that alias. This means that if an entity in a relation is based on multiple entities (through inheritance) it will return all entity names the entity is based on, from the actual entity to the root of the hierarchy path and every entity name in between.
	IRelationHintTargetNameLeftOperand	Gets the name of the left operand for hint targeting. This is either AliasLeftOperand, or if that's empty the containing entity name of the left operand field, if applicable otherwise an empty string.
	IRelationHintTargetNameRightOperand	Gets the name of the right operand for hint targeting. This is either AliasRightOperand, or if that's empty the containing entity name of the right operand field, if applicable otherwise an empty string.
	IRelationJoinType	The join type to use.
	IRelationLeftOperandInheritanceInfo	Gets the left operand's InheritanceInfo
	IRelationReadXml	Deserializes the object data on the xml reader into this instance
	IRelationRightOperandInheritanceInfo	Gets the right operand's InheritanceInfo
	IRelationStartElementIsPkSide	Returns true if the start element of the relation (the left operand) is the Pkside.
	IRelationToggleArtificialAliasingForTargetPerEntityRelations	Enables / disables the artificial aliasing for target per entity relations. This method is used to enable the artificial aliasing of entities which are in a hierarchy of TargetPerEntity and which are in this relation. This is switched on for dyn/typedlist fetches to be sure dyn/typedlists with fields from multiple entities in the same inheritance hierarchy will be retrievable properly, as they need aliasing under the hood but if the developer didn't alias the entities, the query will fail because the supertype(s) aren't joined multiple types.
	IRelationWriteXml	Serializes the object as xml to the writer specified.

Top

Reference

SD.LLBLGen.Pro.ORMSupportClasses Namespace