/ doc / toc / ARCCore / Class / IP / __TOCDet / Attribute

Attribute

Edit keys at this level only

AssemblyName = ARCCore
ClassNamespace = ARCCore
ClassType = IP
Description = IP = IProperty.0x000D0x000A0x000D0x000ACommon central mechanism for implementing -PropertyAccess-.0x000D0x000A0x000D0x000A'Everything' in your application, especially entity classes (like 'Customer', 'Order' and so on) but also classes which are (in a hierarchical sense) over and under the entity level,0x000D0x000Ashould implement this interface.0x000D0x000A0x000D0x000AExamples of classes implementing this interface as seen from a hierarchical storage viewpoint:0x000D0x000A-PCollection-: Collection of objects, like CustomerCollection.0x000D0x000A-PRich-: Customer object.0x000D0x000A-PValue-: Customer.FirstName.0x000D0x000A(note that the topmost level containing all collections should also implement this interface, this can be accomplished with the universal -PRich- class.)0x000D0x000AYou should also let internal parts of your application implement this interface. This will make logging and debugging much easier for instance (see -ExposingApplicationState-).0x000D0x000A0x000D0x000AMethods that must be implemented are:0x000D0x000A-TrySetP-0x000D0x000A-TryGetP-0x000D0x000A-TryGetV-0x000D0x000A-GetEnumerator-0x000D0x000Aand also:0x000D0x000A-DeepCopy-0x000D0x000A-TryRemoveP-0x000D0x000A-OnTrySetP-0x000D0x000A-TrySetPP-0x000D0x000A-GetKeysEqualToValue-0x000D0x000A0x000D0x000ASome of the implementing classes in -ARCCore- are:0x000D0x000A-PRich- Fully flexible storage. Can store anything. Typical inherited for entity representations like 'Customer' or 'Order'.0x000D0x000A-PExact- Very -MemoryConsumption- efficient alternative to -PRich-.0x000D0x000A-PConcurrent- A (somewhat) thread-safe alternative to -PRich- which also supports -ExposingApplicationState-.0x000D0x000A-PValue- Single value storage.0x000D0x000A-PValueEmpty-.0x000D0x000A-PCollection- A class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-.0x000D0x000A-PReadOnly- Experimental as of Feb 2022.0x000D0x000A0x000D0x000AUse these as base classes for your own entities and properties in your -ApplicationSpecificCode-.0x000D0x000A0x000D0x000AIn -ARCCore- there is also -PCollectionES- which supports -EventSourcing-.0x000D0x000A0x000D0x000ANOTE: Some ideas for new classes implementing this interface could be:0x000D0x000A1) PRichImmutable, a quasi-immutable class for which you could (after initialization) set a flag stopping further updates to the class.0x000D0x000A0x000D0x000A(The difference between -ITypeDescriber- and -IP- is that the former must be stored 'inside' an -IP-.0x000D0x000AIn RDBMS-terms a -ITypeDescriber- is the Field stored within a -IP- which is the Post.)0x000D0x000A0x000D0x000AThe more classes you have implementing this interface, the more classes you have that can participiate in the AgoRapide world with flexible concepts like -PropertyStream-, -TaggingOfPropertyKeys-, -PropertyAccess-, -ExposingApplicationState-.0x000D0x000AThe mechanism has been designed to be as flexible as possible. Experience shows that a great variety of objects can with great advantage be represented through this mechanism. That is, not only traditional entities like 'Customer', 'Order' and so on can be represented but also objects like internal parts of your application (classes, enums), 0x000D0x000Athe different methods in an API and even reports and aggregations.0x000D0x000A0x000D0x000A(Even the mechanism for describing this mechanism (-PK-) is an implementation of it).0x000D0x000A0x000D0x000AHINT: Whenever you are creating a new class in your application, instead of using traditional setters and getters / traditional properties, let class inherit -IP- and use this mechanism instead.0x000D0x000A0x000D0x000AUsing -IP- from the start makes the rich functionality of AgoRapide available without much work. (You can always build traditional setters and getters and / or traditional property storage on top of that mechanism at a later stage if you so prefer)0x000D0x000A0x000D0x000AReflecting the fact that instances of this interface often contain a collection of objects, this interface implements the following:0x000D0x000A1) Indexing. Enables you to query more 'direct' in C# like for instance 'DataStorage0x005B"Customer"0x005D0x005B"42"0x005D0x005B"FirstName"0x005D'.0x000D0x000A2) IEnumerable0x003CIKIP0x003E.0x000D0x000A3) The Keys and Values pattern from ordinary .NET Dictionary (see -Keys- and -Values-.0x000D0x000AThis functionality is of course not relevant for value only implementations like -PValue- but technically implemented nonetheless in all cases in order for any hierarchical structure to be 'probed' from the outside in a standardized manner.0x000D0x000A0x000D0x000ATODO: Implement IDictionary0x003CTKey, TValue0x003E also..0x000D0x000A0x000D0x000ASee also -PropertyAccess-.
Interfaces = IEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
InterfacesDirectlyImplemented = IEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
LongDescription = TODO: Regarding default interface methods defined here in this interface0x000D0x000ATODO: and the need for implementing an 'IP' property in implementing classes like -IP-.0x000D0x000ATODO: As AgoRapide matures, considering implementing copies of the default interface methods in a common super class0x000D0x000ATODO: for PRich, PConcurrent, PExact (not necessary for PValue, PEmpty and not possible for BaseAttribute).0x000D0x000A0x000D0x000ANote how AgoRapide internally uses this same mechanism ('eating its own dog food'), and also how you are encouraged to document your application through attributes like -ClassAttribute- and -ClassMemberAttribute- using the same mechanism.0x000D0x000A0x000D0x000ANote about packing of values: -PropertyAccess- uses packed values (everything is sent and received as -IP-) meaning for instance that a string-value would typically be packed inside a -PValue- object.0x000D0x000AConnected with this, classes implementing -IP- have a choice between0x000D0x000A1) Unpacking on receive, packing on send (like used by -PExact-) or0x000D0x000A2) Storing in packed form (like used by -PRich-).0x000D0x000AThe former is more memory efficient (see -MemoryConsumption-), but less able to store metadata (see -PP-) and hierarchical data.0x000D0x000A(see also -PackObjectForStorageInEntityObject- and -TryGetV-.)0x000D0x000ASee also -ITypeDescriber- which provides a standardized mechanism for describing single-property values.0x000D0x000A0x000D0x000A
SubTypes = DimAccount0x003BDimAccountCollection0x003BDimCurrency0x003BDimCustomer0x003BDimCustomerCollection0x003BDimDepartment0x003BDimDepartmentCollection0x003BDimEmployee0x003BDimEmployeeCollection0x003BDimGeography0x003BDimOrganization0x003BDimOrganizationCollection0x003BDimProduct0x003BDimProductCategory0x003BDimProductCollection0x003BDimProductSubcategory0x003BDimProductSubcategoryCollection0x003BDimPromotion0x003BDimReseller0x003BDimResellerCollection0x003BDimSalesReason0x003BDimSalesTerritory0x003BFactCallCenter0x003BFactCurrencyRate0x003BFactCurrencyRateCollection0x003BFactFinance0x003BFactFinanceCollection0x003BFactInternetSale0x003BFactInternetSaleCollection0x003BFactInternetSaleReason0x003BFactInternetSaleReasonCollection0x003BFactProductDescription0x003BFactProductDescriptionCollection0x003BFactProductInventory0x003BFactProductInventoryCollection0x003BFactResellerSale0x003BFactResellerSaleCollection0x003BFactSalesQuota0x003BFactSalesQuotaCollection0x003BFactSurveyResponse0x003BFactSurveyResponseCollection0x003BRoot

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

Edit single sub keys only: AssemblyName / ClassNamespace / ClassType / Description / Interfaces / InterfacesDirectlyImplemented / LongDescription / SubTypes

Generated 2024-05-09 10:15:46.046 UTC