IEntityField Interface |
Namespace: SD.LLBLGen.Pro.ORMSupportClasses
The IEntityField type exposes the following members.
Name | Description | |
---|---|---|
ActAsDerivedTableField |
Gets or sets a value indicating whether this field should be threated as a derived table field. This is necessary when this field is in a query
and targets a derived table while this field is actually a full entity field (so it has field info). If this flag is true, the field will result in
objectAlias.Alias instead of persistenceinfo.Fieldname as alias (alias only if required)
(Inherited from IEntityFieldCore.) | |
ActualContainingObjectName |
The name of the object this field is currently in. Differs only from ContainingObjectName if the field instance is in a subtype while it is
originally defined in a supertype.
(Inherited from IFieldInfo.) | |
ActualDotNetType |
The .NET type of the field in the DB. This value is used to convert a currentvalue back to this type using TypeConverterToUse.
(Inherited from IFieldPersistenceInfo.) | |
AggregateFunctionToApply |
The aggregate function to apply on this field in a select query. Ignored in INSERT/UPDATE/DELETE queries.
Designed to be used in TypedList/TypedView classes.
(Inherited from IEntityFieldCore.) | |
Alias |
The alias to use for this field. Only used when this field object is part of a typed list.
Adapter: returns the alias set in the designer
SelfServicing: returns Name
(Inherited from IEntityFieldCore.) | |
ContainingObjectName |
Name of the containing object this field belongs to (entity or typed view). This name is required to retrieve persistence information in Adapter
Set via constructor. This name is also used by EntityRelation to determine alias - table connection.
(Inherited from IFieldInfo.) | |
CurrentValue |
Gets the current value for this field and sets the new value for this field, by overwriting current value. The value in
currentValue is discarded, versioning control has to save the original value of currentValue before this property is called.
(Inherited from IEntityFieldCore.) | |
DataType |
The Type of the values of this field.
(Inherited from IFieldInfo.) | |
DbValue |
Gets the value read from the database for this field. Use this field in optimistic concurrency predicates.
Set by ForcedCurrentValueWrite(object, value) by the object fetcher logic.
(Inherited from IEntityFieldCore.) | |
ExpressionToApply |
The expression to apply to this field in a select list, update statement or predicate or expression.
Expression is applied before AggregateFunctionToApply.
(Inherited from IEntityFieldCore.) | |
FieldIndex |
Gets the field index related to this IEntityField, so the field can be used to retrieve the field index.
(Inherited from IFieldInfo.) | |
IdentityValueSequenceName |
If IsIdentity is set to true, this property has to be set to the name of the sequence which supplies the value for the EntityField's
corresponding table field. On SqlServer this is @@IDENTITY or SCOPE_IDENTITY() and only used when the row is succesfully inserted, however on Oracle
this value is used to specify a new value and to retrieve the new value. Is undefined when IsIdentity is set to false.
(Inherited from IFieldPersistenceInfo.) | |
IsChanged |
If the value of this field is changed, this property is set to true. Set when CurrentValue receives a valid value.
(Inherited from IEntityFieldCore.) | |
IsForeignKey |
If set to true, in the constructor, this field is part of a foreign key. This field is not used in LLBLGen Pro's code, however
can be useful in user code.
(Inherited from IFieldInfo.) | |
IsIdentity |
If set to true, the Dynamic Query Engine (DQE) will assume the field is an Identity field and will act accordingly (i.e.: as the target database
handles Identity fields: SqlServer will generate a new value itself, Oracle wants to have a sequence input.
(Inherited from IFieldPersistenceInfo.) | |
IsInMultiTargetEntity |
Flag to signal if the field is in a multi-target entity. Used for alias production during query building in scenario's with inheritance.
(Inherited from IFieldInfo.) | |
IsNull |
If the original value in the column for this entityfield is DBNull (NULL), this parameter should be set to true, otherwise to false.
In BL Logic, it's impractical to work with NULL values, so these are converted to handable values. The developer can still determine if
the original value was DBNull by checking this field.
(Inherited from IEntityFieldCore.) | |
IsNullable |
Will be true if this field can be set to NULL in the database, false otherwise. The Field Validation logic in an entity will use this
flag to check if the field indeed can be set to NULL or not. Set by constructor.
(Inherited from IFieldInfo.) | |
IsOfEnumDataType |
Gets a value indicating whether the DataType is an enum type. This is a helper boolean so it doesn't have to be determined for every field
set during a fetch.
(Inherited from IFieldInfo.) | |
IsPrimaryKey |
If set to true, in the constructor, this field will end up in the PrimaryKey field list of the containing IEntityFields object.
(Inherited from IFieldInfo.) | |
IsReadOnly |
If set to true, in the constructor, no changes can be made to this field.
(Inherited from IFieldInfo.) | |
LinkedSuperTypeField |
Gets the linked super type field, if this field is a subtype field and it's linked to a supertype field, otherwise null.
(Inherited from IEntityFieldCore.) | |
MaxLength |
The maximum length of the value of the entityfield (string/binary data). Is ignored for entityfields which hold non-string and non-binary values.
Value initially set for this field is the length of the database column this field is mapped on.
(Inherited from IFieldInfo.) | |
Name |
The name of the field. Name cannot be of zero length nor can they consist of solely spaces. Leading and trailing spaces are trimmed.
(Inherited from IFieldInfo.) | |
ObjectAlias |
Alias for the object containing the field this entity field is mapped on. Used in typed list selection lists.
(Inherited from IEntityFieldCore.) | |
Precision |
The precision of the value for this field.
Value initially set for this field is the precision of the database column this field is mapped on.
(Inherited from IFieldInfo.) | |
RealDataType |
Gets the real datatype. This is the underlying datatype of DataType and if that's a Nullable(Of T) it's the type of T. This is a helper property
so it's not determined over and over again for every field during a fetch.
(Inherited from IFieldInfo.) | |
Scale |
The scale of the value for this field.
Value initially set for this field is the scale of the database column this field is mapped on.
(Inherited from IFieldInfo.) | |
SourceCatalogName |
The name of the catalog the SourceSchemaName is located in.
(Inherited from IFieldPersistenceInfo.) | |
SourceColumnDbType |
The type of the Column mapped onto the EntityField(2). The value stored here is the string representation of the enum value of the type, e.g.
SqlDbType.Int will result in "Int"
(Inherited from IFieldPersistenceInfo.) | |
SourceColumnIsNullable |
Flag if the Column mapped onto the entityfield is nullable or not.
Used for update/insert operations on the column
(Inherited from IFieldPersistenceInfo.) | |
SourceColumnMaxLength |
The maximum length of the value of the entityfield (string/binary data). Is ignored for entityfields which hold non-string and non-binary values.
ColumnMaxLength
Used for update/insert operations on the column
(Inherited from IFieldPersistenceInfo.) | |
SourceColumnName |
The name of the corresponding column in a view or table for an entityfield. This name is used to map a column in a resultset onto the entity field.
(Inherited from IFieldPersistenceInfo.) | |
SourceColumnPrecision |
The precision of the Column mapped onto the entityfield.
Used for update/insert operations on the column
(Inherited from IFieldPersistenceInfo.) | |
SourceColumnScale |
The scale of the Column mapped onto the entityfield.
Used for update/insert operations on the column
(Inherited from IFieldPersistenceInfo.) | |
SourceObjectName |
The name of the source object which holds SourceColumnName. Can be a view or a table (or synonym of those).
Used to generate SQL on the fly.
(Inherited from IFieldPersistenceInfo.) | |
SourceSchemaName |
The name of the schema which holds SourceObjectName. Schema is used to generate SQL on the fly.
A common schema name in SqlServer is f.e. 'dbo'.
(Inherited from IFieldPersistenceInfo.) | |
TypeConverterToUse |
Gets the type converter to use. Only set through constructor and when a conversion is required from the .NET type returned by the
ADO.NET provider and the defined .NET type for this field.
(Inherited from IFieldPersistenceInfo.) |
Name | Description | |
---|---|---|
Clone |
Clones this field instance
(Inherited from IEntityFieldCore.) | |
ForcedCurrentValueWrite(Object) |
Overwrites the current value with the value passed. This bypasses value checking and field properties like readonly.
Used by internal code only. Do not call this from your code.
(Inherited from IEntityFieldCore.) | |
ForcedCurrentValueWrite(Object, Object) |
Overwrites the current value with the value passed. This bypasses value checking and field properties like readonly.
Used by internal code only. Do not call this from your code.
(Inherited from IEntityFieldCore.) | |
GetDiscriminatorColumnFlag |
Gets the discriminator column flag.
(Inherited from IEntityFieldCore.) | |
GetHashCode |
Overrides the GetHashCode() method. It will return the hashcode of the value of the field as the hashcode.
(Inherited from IEntityFieldCore.) | |
GetHashCodeForExpressionKey |
Returns the hashcode for this field which can be used for an expression key. This value is based on the field info hashcode and alias, as well as expression hashcode (if present)
(Inherited from IEntityFieldCore.) | |
ReadDefinitionFromXml |
Deserializes the field's definition data on the xml reader into a field instance
(Inherited from IEntityFieldCore.) | |
ReadXml |
Deserializes the data on the xml reader into a fieldinfo instance
(Inherited from IFieldInfo.) | |
SetAggregateFunction |
Sets the EntityField's AggregateFunctionToApply property
| |
SetExpression |
Sets the Entity Field's ExpressionToToApply property
| |
SetFieldAlias |
Sets the field alias.
| |
SetFieldIndex |
Sets the FieldIndex, if FieldInfo is null. Used in DefineField.
(Inherited from IEntityFieldCore.) | |
SetObjectAlias |
Sets the entity field's ObjectAlias property to the specified value
| |
WriteDefinitionAsXml |
Serializes the field's definition as xml to the writer specified.
(Inherited from IEntityFieldCore.) | |
WriteXml(XmlWriter) |
Serializes object as xml to the writer specified.
(Inherited from IFieldInfo.) | |
WriteXml(XmlWriter, XmlFormatAspect) |
Writes the XML of this Field object to the writer specified
(Inherited from IEntityFieldCore.) | |
WriteXml(XmlFormatAspect, XmlDocument, XmlNode) |
Converts this EntityField2 to an XmlNode.
|
Name | Description | |
---|---|---|
AddDays |
Defines the mapping for the field.AddDays(numberOfDays) method mapping
(Defined by FunctionMappingExtensionMethods.) | |
AddHours |
Defines the mapping for the field.AddHours(numberOfHours) method mapping
(Defined by FunctionMappingExtensionMethods.) | |
AddMilliseconds |
Defines the mapping for the field.AddMilliseconds(numberOfMilliseconds) method mapping
(Defined by FunctionMappingExtensionMethods.) | |
AddMinutes |
Defines the mapping for the field.AddMinutes(numberOfMinutes) method mapping
(Defined by FunctionMappingExtensionMethods.) | |
AddMonths |
Defines the mapping for the field.AddMonths(numberOfMonths) method mapping
(Defined by FunctionMappingExtensionMethods.) | |
AddSeconds |
Defines the mapping for the field.AddSeconds(numberOfSeconds) method mapping
(Defined by FunctionMappingExtensionMethods.) | |
AddYears |
Defines the mapping for the field.AddYears(numberOfYears) method mapping
(Defined by FunctionMappingExtensionMethods.) | |
As(String) | Overloaded.
Specifies the field alias on the field, returning the field.
(Defined by FieldExtensionMethods.) | |
As(String) | Overloaded.
Specifies the field alias on the field, returning the field.
(Defined by FieldExtensionMethods.) | |
Ascending |
Creates an ascending sort clause for the field specified
(Defined by SortClauseProducers.) | |
Avg |
Places the Avg aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
AvgDistinct |
Places the Avg(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
Between |
Creates a Between predicate which is true if the field specified is between valueBegin and valueEnd, valueBegin and valueEnd included.
(Defined by BetweenPredicateProducers.) | |
CastToTResult |
Specifies the result type of the field to be TResult
(Defined by FieldExtensionMethods.) | |
Char |
Defines the mapping for the field.Char[index] property to method mapping
(Defined by FunctionMappingExtensionMethods.) | |
Contains |
Creates a Like predicate using the pattern: '%pattern%' for the field specified.
(Defined by StringMethodPredicateProducers.) | |
Count |
Places the Count aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
CountBig |
Places the CountBig aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
CountBigDistinct |
Places the CountBig(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
CountDistinct |
Places the Count(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
Date |
Defines the mapping for the field.Date property to method mapping
(Defined by FunctionMappingExtensionMethods.) | |
Day |
Defines the mapping for the field.Day property to method mapping
(Defined by FunctionMappingExtensionMethods.) | |
Descending |
Creates a descending sort clause for the field specified
(Defined by SortClauseProducers.) | |
EndsWith |
Creates a Like predicate using the pattern: '%pattern' for the field specified.
(Defined by StringMethodPredicateProducers.) | |
Equal(Object) | Overloaded.
Creates an equality comparison predicate between the expression and the value specified. If the value is null or DBNull.Value a null comparison predicate is created
(Defined by EqualOpPredicateProducers.) | |
Equal(IEntityFieldCore) | Overloaded.
Creates an equality comparison predicate between the two fields specified.
(Defined by EqualOpPredicateProducers.) | |
Equal(IExpression) | Overloaded.
Creates an equality comparison predicate between the field and the expression specified.
(Defined by EqualOpPredicateProducers.) | |
GreaterEqual(Object) | Overloaded.
Creates a greater or equal comparison predicate between the expression and the value specified.
(Defined by GreaterEqualOpPredicateProducers.) | |
GreaterEqual(IEntityFieldCore) | Overloaded.
Creates a greater or equal comparison predicate between the two fields specified.
(Defined by GreaterEqualOpPredicateProducers.) | |
GreaterEqual(IExpression) | Overloaded.
Creates a greater or equal comparison predicate between the field and the expression specified.
(Defined by GreaterEqualOpPredicateProducers.) | |
GreaterThan(Object) | Overloaded.
Creates a greater than comparison predicate between the expression and the value specified.
(Defined by GreaterThanOpPredicateProducers.) | |
GreaterThan(IEntityFieldCore) | Overloaded.
Creates a greater than comparison predicate between the two fields specified.
(Defined by GreaterThanOpPredicateProducers.) | |
GreaterThan(IExpression) | Overloaded.
Creates a greater than comparison predicate between the field and the expression specified.
(Defined by GreaterThanOpPredicateProducers.) | |
Hour |
Defines the mapping for the field.Hour property to method mapping
(Defined by FunctionMappingExtensionMethods.) | |
In(Object) | Overloaded.
Creates a Field IN (values) predicate
(Defined by InPredicateProducers.) | |
In(DynamicQuery) | Overloaded.
Creates a Field IN (query) predicate
(Defined by InPredicateProducers.) | |
IndexOf |
Defines the mapping for the field.IndexOf(value) method mapping
(Defined by FunctionMappingExtensionMethods.) | |
IsNotNull |
Generates a negated FieldCompareNull predicate on the field specified.
(Defined by IsNullPredicateProducers.) | |
IsNull |
Generates a FieldCompareNull predicate on the field specified.
(Defined by IsNullPredicateProducers.) | |
Length |
Defines the mapping for the field.Length property to method mapping, if field represents a string value.
(Defined by FunctionMappingExtensionMethods.) | |
LesserEqual(Object) | Overloaded.
Creates a lesser or equal comparison predicate between the expression and the value specified.
(Defined by LesserEqualOpPredicateProducers.) | |
LesserEqual(IEntityFieldCore) | Overloaded.
Creates a lesser or equal comparison predicate between the two fields specified.
(Defined by LesserEqualOpPredicateProducers.) | |
LesserEqual(IExpression) | Overloaded.
Creates a lesser or equal comparison predicate between the field and the expression specified.
(Defined by LesserEqualOpPredicateProducers.) | |
LesserThan(Object) | Overloaded.
Creates a lesser than comparison predicate between the expression and the value specified.
(Defined by LesserThanOpPredicateProducers.) | |
LesserThan(IEntityFieldCore) | Overloaded.
Creates a lesser than comparison predicate between the two fields specified.
(Defined by LesserThanOpPredicateProducers.) | |
LesserThan(IExpression) | Overloaded.
Creates a lesser than comparison predicate between the field and the expression specified.
(Defined by LesserThanOpPredicateProducers.) | |
Like |
Creates a Like predicate for the field specified using the pattern specified. The pattern has to contain the wildcards required.
(Defined by StringMethodPredicateProducers.) | |
Max |
Places the Max aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
Millisecond |
Defines the mapping for the field.Millisecond property to method mapping
(Defined by FunctionMappingExtensionMethods.) | |
Min |
Places the Min aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
Minute |
Defines the mapping for the field.Minute property to method mapping
(Defined by FunctionMappingExtensionMethods.) | |
Month |
Defines the mapping for the field.Month property to method mapping
(Defined by FunctionMappingExtensionMethods.) | |
NotBetween |
Creates a Between predicate which is true if the field specified is not between valueBegin and valueEnd, valueBegin and valueEnd included.
(Defined by BetweenPredicateProducers.) | |
NotEqual(Object) | Overloaded.
Creates a negated equality comparison predicate between the expression and the value specified. If the value is null or DBNull.Value a null comparison predicate is created
(Defined by NotEqualOpPredicateProducers.) | |
NotEqual(IEntityFieldCore) | Overloaded.
Creates a negated equality comparison predicate between the two fields specified.
(Defined by NotEqualOpPredicateProducers.) | |
NotEqual(IExpression) | Overloaded.
Creates a negated equality comparison predicate between the field and the expression specified.
(Defined by NotEqualOpPredicateProducers.) | |
NotIn(Object) | Overloaded.
Creates a NOT (Field IN (values)) predicate
(Defined by InPredicateProducers.) | |
NotIn(DynamicQuery) | Overloaded.
Creates a NOT (Field IN (query)) predicate
(Defined by InPredicateProducers.) | |
Replace |
Defines the mapping for the field.Replace(oldValue, newValue) method mapping
(Defined by FunctionMappingExtensionMethods.) | |
Second |
Defines the mapping for the field.Second property to method mapping
(Defined by FunctionMappingExtensionMethods.) | |
StartsWith |
Creates a Like predicate using the pattern: 'pattern%' for the fieldl specified.
(Defined by StringMethodPredicateProducers.) | |
StDev |
Places the StDev aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
StDevDistinct |
Places the StDev(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
Substring(Int32) | Overloaded.
Defines the mapping for the field.Substring(startIndex) method mapping
(Defined by FunctionMappingExtensionMethods.) | |
Substring(Int32, Int32) | Overloaded.
Defines the mapping for the field.Substring(startIndex, length) method mapping
(Defined by FunctionMappingExtensionMethods.) | |
Sum |
Places the Sum aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
SumDistinct |
Places the Sum(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
ToLower |
Defines the mapping for the field.ToLower() method mapping
(Defined by FunctionMappingExtensionMethods.) | |
ToUnicode |
Defines the mapping for the field.ToUnicode() method mapping
(Defined by FunctionMappingExtensionMethods.) | |
ToUpper |
Defines the mapping for the field.ToUpper() method mapping
(Defined by FunctionMappingExtensionMethods.) | |
ToValueTValue | Overloaded.
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 field.
(Defined by FieldExtensionMethods.) | |
ToValueTValue(Int32) | Overloaded.
Placeholder method which is used in a generated lambda from a call to Select<T>>(fields) to specify the type of the result of the passed in field and as well the
ordinal the source field has in the actual projection of the query.
(Defined by FieldExtensionMethods.) | |
Trim |
Defines the mapping for the field.Trim() method mapping
(Defined by FunctionMappingExtensionMethods.) | |
Variance |
Places the Variance aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
VarianceDistinct |
Places the Variance(Distinct) aggregate function on the field specified
(Defined by AggregateRelatedExtensionMethods.) | |
Year |
Defines the mapping for the field.Year property to method mapping
(Defined by FunctionMappingExtensionMethods.) |