EntitySpaces esPlugIn for MyGeneration

esHelper Class

The esPlugIn for MyGeneration is used to encapsulate the logic used to determine class names and property names for EntitySpaces. The esPlugIn allows users to customize the naming conventions of their EntitySpaces classes.

For a list of all members of this type, see esHelper Members.

System.Object
   EntitySpaces.PlugIn.esHelper

[Visual Basic]
Public Class esHelper
[C#]
public class esHelper

Thread Safety

Public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread-safe.

Remarks

The Pascal convention can be turned off via the UseRawNames property however it is not recommended. The default naming conventions are stored in a file called esPluginSettings.xml located in the MyGeneration Settings folder. The default naming conventions for EntitySpaces are listed below.

Using a table named "my_employees" the default "Concrete" classes are as follows:

esPlugIn.Entity("my_employees")MyEmployees
esPlugIn.Collection("my_employees")MyEmployeesCollection
esPlugIn.Query("my_employees")MyEmployeesQuery
esPlugIn.Metadata("my_employees")MyEmployeesMetadata


Using a table named "my_employees" the default "Abstract/MustInherit" classes are as follows:

esPlugIn.esEntity("my_employees")esMyEmployees
esPlugIn.esCollection("my_employees")esMyEmployeesCollection
esPlugIn.esQuery("my_employees")esMyEmployeesQuery


The default formula for constructing Stored Procedure names is:
Formula = [sProcPrefix + source.Name + Verb + sProcSuffix]
Where Verb is one of the following: sProcInsert, sProcUpdate, sProcDelete, sProcLoadAll, sProcLoadByPK

Using a table named "my_employees" the default Stored Procedure names are as follows:

esPlugin.ProcInsert("my_employees")proc_my_employeesInsert
esPlugin.ProcUpdate("my_employees")proc_my_employeesUpdate
esPlugin.ProcDelete("my_employees")proc_my_employeesDelete
esPlugin.ProcLoadAll("my_employees")proc_my_employeesLoadAll
esPlugin.ProcLoadByPK("my_employees")proc_my_employeesLoadByPrimaryKey
You can use ProcVerbFirst to change from the default EntityVerb order to VerbEntity order, but it is not recommended.

Requirements

Namespace: EntitySpaces.PlugIn

Assembly: esPlugIn (in esPlugIn.dll)

See Also

esHelper Members | EntitySpaces.PlugIn Namespace