Menu
▾
▴
[Jcframework-commits] dotnet AFCustomAttributes.vb,1.10,1.11 AtomsFramework.ndoc,1.4,1.5 AtomsFramework.xml,1.14,1.15 CAssociationTable.vb,1.4,1.5 CCacheEntry.vb,1.35,1.36 CClassMap.vb,1.60,1.61 CColumnMap.vb,1.14,1.15 CCriteriaCondition.vb,1.23,1.24 CCursor.vb,1.20,1.21 CPersistenceBroker.vb,1.111,1.112 CPersistentCollection.vb,1.22,1.23 CQueuedDelete.vb,1.2,1.3 CRelationalDatabase.vb,1.25,1.26 CResultset.vb,1.7,1.8 CRetrieveCriteria.vb,1.15,1.16 CSelectInCriteria.vb,1.11,1.12 CSelectInListCriteria.vb,1.4,1.5 CSummaryCriteria.vb,1.13,1.14 CTableMap.vb,1.9,1.10 CXMLConfigLoader.vb,1.36,1.37 IClassFactory.vb,1.2,1.3 IPersistentObject.vb,1.16,1.17
Update of /cvsroot/jcframework/dotnet In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv5782 Modified Files: AFCustomAttributes.vb AtomsFramework.ndoc AtomsFramework.xml CAssociationTable.vb CCacheEntry.vb CClassMap.vb CColumnMap.vb CCriteriaCondition.vb CCursor.vb CPersistenceBroker.vb CPersistentCollection.vb CQueuedDelete.vb CRelationalDatabase.vb CResultset.vb CRetrieveCriteria.vb CSelectInCriteria.vb CSelectInListCriteria.vb CSummaryCriteria.vb CTableMap.vb CXMLConfigLoader.vb IClassFactory.vb IPersistentObject.vb Log Message: Documentation updates Index: CPersistenceBroker.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CPersistenceBroker.vb,v retrieving revision 1.111 retrieving revision 1.112 diff -u -d -r1.111 -r1.112 --- CPersistenceBroker.vb 24 May 2005 07:43:42 -0000 1.111 +++ CPersistenceBroker.vb 25 May 2005 01:26:11 -0000 1.112 @@ -1032,16 +1032,22 @@ statement = cm.GetInsertSqlFor(obj) conn.ProcessStatement(statement) usedInsert = True - PCSQLHits.Increment() - PCUpdates.Increment() + Try + PCSQLHits.Increment() + PCUpdates.Increment() + Catch + End Try Catch Debug.WriteLine("Couldn't insert object in unknown state, trying to update...") Try statement = cm.GetUpdateSqlFor(obj) conn.ProcessStatement(statement) usedInsert = False - PCSQLHits.Increment() - PCUpdates.Increment() + Try + PCSQLHits.Increment() + PCUpdates.Increment() + Catch + End Try Catch Debug.WriteLine("Couldn't update object in unknown state, throwing initial exception") Throw Index: IPersistentObject.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/IPersistentObject.vb,v retrieving revision 1.16 retrieving revision 1.17 diff -u -d -r1.16 -r1.17 --- IPersistentObject.vb 24 May 2005 07:43:44 -0000 1.16 +++ IPersistentObject.vb 25 May 2005 01:26:13 -0000 1.17 @@ -796,10 +796,10 @@ '''<remarks>The event indicates that the object has been dirtied by changing one of it's properties or that the dirty flag has been manually set.</remarks> Event MarkedAsDirty As EventHandler '''<summary>Fires when object retrieval commences</summary> - ''<remarks> </remarks> + '''<remarks> </remarks> Event LoadStarted As EventHandler '''<summary>Fires when object retrieval has completed</summary> - ''<remarks> </remarks> + '''<remarks> </remarks> Event LoadFinished As EventHandler End Interface Index: CSelectInListCriteria.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CSelectInListCriteria.vb,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- CSelectInListCriteria.vb 20 May 2005 06:03:42 -0000 1.4 +++ CSelectInListCriteria.vb 25 May 2005 01:26:12 -0000 1.5 @@ -17,6 +17,17 @@ Public Class SelectInListCriteria Inherits SelectionCriteria + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Adds an IN() clause to an SQL Statement. + ''' </summary> + ''' <param name="statement">The statement to modify</param> + ''' <remarks>Adds an sql clause in the form of "IN (x,y,z)" where the comma separated values are obtained from the collection referenced by ValueA. + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Overrides Sub FillSqlStatement(ByVal statement As AtomsSqlStatement) If TableAlias.Length = 0 Then statement.AddSqlClause(AttrMap.ColumnMap.GetFullyQualifiedName & ClassMap.RelationalDatabase.GetClauseStringInList(ValueA)) Index: CAssociationTable.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CAssociationTable.vb,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- CAssociationTable.vb 24 May 2005 07:43:42 -0000 1.4 +++ CAssociationTable.vb 25 May 2005 01:26:11 -0000 1.5 @@ -44,7 +44,7 @@ ''' <summary> ''' The database owner of the table. If not specified the database provider will normally default to "dbo" ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> Index: IClassFactory.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/IClassFactory.vb,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- IClassFactory.vb 20 May 2005 06:03:42 -0000 1.2 +++ IClassFactory.vb 25 May 2005 01:26:13 -0000 1.3 @@ -2,7 +2,7 @@ ''' <summary> ''' Interface for class factories used by the framework ''' </summary> -''' <returns></returns> +''' <returns> </returns> ''' <remarks>For each interface you wish to persist to the database a class factory must be provided. Those class factories must impement ''' this interface in order to work. ''' <para>The interface itself is pretty simple and contains a single function called CreateObject that must be implemented.</para> Index: CQueuedDelete.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CQueuedDelete.vb,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- CQueuedDelete.vb 11 Apr 2005 00:31:44 -0000 1.2 +++ CQueuedDelete.vb 25 May 2005 01:26:12 -0000 1.3 @@ -13,6 +13,17 @@ Friend Class QueuedDelete Private m_object As IPersistableObject + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' The object that is to be deleted. + ''' </summary> + ''' <returns> </returns> + ''' <remarks>A simple property to keep track of the object we need to delete. + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Property ObjectToDelete() As IPersistableObject Get Return m_object Index: AtomsFramework.ndoc =================================================================== RCS file: /cvsroot/jcframework/dotnet/AtomsFramework.ndoc,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- AtomsFramework.ndoc 24 May 2005 07:43:31 -0000 1.4 +++ AtomsFramework.ndoc 25 May 2005 01:26:10 -0000 1.5 @@ -23,14 +23,8 @@ <property name="Title" value="AtomsFramework Persistence Layer Reference Guide" /> <property name="ShowVisualBasic" value="True" /> <property name="SdkLinksOnWeb" value="True" /> - <property name="FooterHtml" value="(c) Copyright, Richard Banks, 2005. Licensed using the LGPL License<br>This project is hosted by Sourceforge <a href="http://sourceforge.net/projects/jcframework"> <IMG src="http://sourceforge.net/sflogo.php?group_id=61771&type=5" width="105" height="31" border="0" alt="SourceForge.net Logo" /></a>" /> - <property name="ShowMissingSummaries" value="True" /> - <property name="ShowMissingRemarks" value="True" /> - <property name="ShowMissingParams" value="True" /> - <property name="ShowMissingReturns" value="True" /> - <property name="ShowMissingValues" value="True" /> + <property name="FooterHtml" value="<p>(c) Copyright, Richard Banks, 2005. Licensed for use under the <a href="http://www.gnu.org/copyleft/lesser.html">LGPL License</a></p><p>The AtomsFramework project is hosted by Sourceforge <a href="http://sourceforge.net/projects/jcframework"> <IMG src="http://sourceforge.net/sflogo.php?group_id=61771&type=5" width="105" height="31" border="0" alt="SourceForge.net Logo" align="absMiddle"/></a></p><p>Documentation for %ASSEMBLY_NAME% [%ASSEMBLY_VERSION%] is built with <a href="http://ndoc.sourceforge.net/">NDoc</a></p>" /> <property name="AssemblyVersionInfo" value="AssemblyVersion" /> - <property name="CopyrightText" value="(c) Copyright, Richard Banks, 2005. Licensed using the LGPL License" /> <property name="FeedbackEmailAddress" value="rba...@ms..." /> <property name="UseNamespaceDocSummaries" value="True" /> <property name="Preliminary" value="True" /> @@ -44,10 +38,13 @@ </documenter> <documenter name="VS.NET 2003"> <property name="OutputDirectory" value=".\doc2\" /> - <property name="HtmlHelpName" value="AtomsFramework Documentation" /> + <property name="HtmlHelpName" value="AtomsFramework" /> <property name="Title" value="AtomsFramework Documentation" /> - <property name="CollectionNamespace" value="Atoms.Framework" /> + <property name="CollectionNamespace" value="AtomsFramework" /> <property name="GenerateCollectionFiles" value="True" /> + <property name="PlugInNamespace" value="ms.vscc.2003" /> + <property name="Version" value="2.2.0.0" /> + <property name="FooterHtml" value="<p>(c) Copyright, Richard Banks, 2005. Licensed for use under the <a href="http://www.gnu.org/copyleft/lesser.html">LGPL License</a></p><p>The AtomsFramework project is hosted by Sourceforge <a href="http://sourceforge.net/projects/jcframework"> <IMG src="http://sourceforge.net/sflogo.php?group_id=61771&type=5" width="105" height="31" border="0" alt="SourceForge.net Logo" align="absMiddle"/></a></p><p>Documentation for %ASSEMBLY_NAME% [%ASSEMBLY_VERSION%] is built with <a href="http://ndoc.sourceforge.net/">NDoc</a></p>" /> <property name="AssemblyVersionInfo" value="AssemblyVersion" /> <property name="UseNamespaceDocSummaries" value="True" /> </documenter> Index: CRelationalDatabase.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CRelationalDatabase.vb,v retrieving revision 1.25 retrieving revision 1.26 diff -u -d -r1.25 -r1.26 --- CRelationalDatabase.vb 24 May 2005 07:43:44 -0000 1.25 +++ CRelationalDatabase.vb 25 May 2005 01:26:12 -0000 1.26 @@ -1263,7 +1263,8 @@ ''' See <see cref="P:AtomsFramework.IRelationalDatabase.GetClauseStringTableAlias">IRelationalDatabase</see>. ''' </summary> ''' <param name="table"> </param> - ''' <param name="aliasName"> </param> + ''' <param name="owner"> </param> + ''' <param name="aliasValue"> </param> ''' <returns> </returns> ''' <remarks> </remarks> ''' <history> @@ -1384,8 +1385,29 @@ GC.SuppressFinalize(Me) End Sub + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Disposes the database + ''' </summary> + ''' <param name="disposing"> </param> + ''' <remarks>Must be overriden by subclasses. + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Protected MustOverride Overloads Sub Dispose(ByVal disposing As Boolean) + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Finalizes the database after disposal. + ''' </summary> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Protected Overrides Sub Finalize() Dispose(False) MyBase.Finalize() Index: CCriteriaCondition.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CCriteriaCondition.vb,v retrieving revision 1.23 retrieving revision 1.24 diff -u -d -r1.23 -r1.24 --- CCriteriaCondition.vb 24 May 2005 07:43:42 -0000 1.23 +++ CCriteriaCondition.vb 25 May 2005 01:26:11 -0000 1.24 @@ -51,7 +51,7 @@ ''' <summary> ''' Indicates wether the condition should be appended to the parent condition using OR or AND ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> Index: CSelectInCriteria.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CSelectInCriteria.vb,v retrieving revision 1.11 retrieving revision 1.12 diff -u -d -r1.11 -r1.12 --- CSelectInCriteria.vb 24 May 2005 07:43:44 -0000 1.11 +++ CSelectInCriteria.vb 25 May 2005 01:26:12 -0000 1.12 @@ -145,6 +145,16 @@ Me.ClassMap = obj.GetClassMap(obj) End Sub + '''----------------------------------------------------------------------------- + ''' <summary> + ''' Creates a new instance of the SelectInCriteria and sets the primary object. + ''' </summary> + ''' <param name="obj">The object to use in the sub-query.</param> + ''' <remarks> </remarks> + ''' <history> + ''' [rbanks] 17/12/2003 Created + ''' </history> + '''----------------------------------------------------------------------------- Public Sub New(ByVal obj As Object) Me.New() Dim injObj As InjectedObject @@ -283,7 +293,7 @@ If m_joins Is Nothing Then statement.AddSqlClause(Me.Tables(1).Name) Else - statement.AddSqlClause(m_joins.GetSQLString) + statement.AddSqlClause(m_joins.GetSqlString) End If 'Need to set correct table aliases for the selection criteria in the where condition Index: CXMLConfigLoader.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CXMLConfigLoader.vb,v retrieving revision 1.36 retrieving revision 1.37 diff -u -d -r1.36 -r1.37 --- CXMLConfigLoader.vb 24 May 2005 07:43:44 -0000 1.36 +++ CXMLConfigLoader.vb 25 May 2005 01:26:13 -0000 1.37 @@ -93,7 +93,7 @@ ''' <summary> ''' Creates a new instance of the Class and sets the FileName property. ''' </summary> - ''' <param name="xmlFile"></param> + ''' <param name="xmlFile">The file containing the XML mappings</param> ''' <remarks> </remarks> ''' <history> ''' [rbanks] 18/12/2003 Created Index: AFCustomAttributes.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/AFCustomAttributes.vb,v retrieving revision 1.10 retrieving revision 1.11 diff -u -d -r1.10 -r1.11 --- AFCustomAttributes.vb 20 May 2005 06:03:36 -0000 1.10 +++ AFCustomAttributes.vb 25 May 2005 01:26:09 -0000 1.11 @@ -90,7 +90,7 @@ ''' <summary> ''' Gets the database table name of the mapped class ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -107,7 +107,7 @@ ''' <summary> ''' Gets the database name for the mapped class ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>The returned value is the name of the database from the XML file and is ''' not the physical database server name ''' </remarks> @@ -125,7 +125,7 @@ ''' <summary> ''' Returns the database key type. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -142,7 +142,7 @@ ''' <summary> ''' The table owner for the mapped class. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>The table owner defaults to "dbo" and is only used in databases where ''' ownership information is included in the table naming (ie MSSQL, etc) ''' </remarks> @@ -163,7 +163,7 @@ ''' <summary> ''' The parent class for this class ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>Database mappings will be inherited from the parent class. ''' </remarks> ''' <history> @@ -183,7 +183,7 @@ ''' <summary> ''' Indicates that the class is readonly. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>Attempting to save objects of this class will cause an exception to ''' be thrown. ''' </remarks> @@ -205,7 +205,7 @@ ''' Indicates that the class allows existing objects to be saved, but that no new objects ''' can be created. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>If an object of this class is created and then saved and exception will be ''' thrown. Objects that are already persistent can be saved without error. ''' </remarks> @@ -226,7 +226,7 @@ ''' <summary> ''' The database column used to store the created date timestamp ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -246,7 +246,7 @@ ''' <summary> ''' The database column used to store the modified date timestamp. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -266,7 +266,7 @@ ''' <summary> ''' The database column used to store to object ID value. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>This is only required when the key type for the table is useOIDValue ''' </remarks> ''' <history> @@ -286,7 +286,7 @@ ''' <summary> ''' The database column used to store to GUID value. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>This is only required when the key type for the table is useGUIDValue ''' </remarks> ''' <history> @@ -306,7 +306,7 @@ ''' <summary> ''' The key field to reference in the parent class. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>When a class inherits from a super class there must be a link between the ''' two classes. This attribute is used to define the linkage between the sub class and the ''' parent class @@ -329,7 +329,7 @@ ''' <summary> ''' The database column used to differentiate between parent and child classes. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>When a parent and child class share the same database table instead ''' of having separate tables a column in the table is used to flag wether the ''' record in question is an instance of the parent class or the child class. @@ -353,7 +353,7 @@ ''' <summary> ''' The value to check for in the SharedTableField ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>When a parent and child classes share the same database table the ''' SharedTableField is checked and if the value of the column matches the value ''' specified here then the record belongs to this class. @@ -420,7 +420,7 @@ ''' <summary> ''' The database column an attribute maps to. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -437,7 +437,7 @@ ''' <summary> ''' Indicates if this column is part of the tables key fields. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>This flag only needs to be set if the table key is not an OID or GUID column. ''' Also, this flag may be set against multiple properties to build a multipart key. ''' </remarks> @@ -458,7 +458,7 @@ ''' <summary> ''' The field in the parent class that this attribute references ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>To maintain the linkage between a sub class and a super class a reference ''' from the subclasses properties to the parent class must be present. This attribute property ''' maps the sub class property to the super class property. @@ -480,7 +480,7 @@ ''' <summary> ''' Indicates that the field participates in Find operations. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -522,7 +522,7 @@ ''' <summary> ''' Indicates that the mapped column is an identity column ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -591,7 +591,7 @@ ''' <summary> ''' ReadOnly. The class the association links to. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -608,7 +608,7 @@ ''' <summary> ''' ReadOnly. The property in this class that stores the association. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>For 1:1 associations the property is typically a reference to an object ''' of the target class. ''' <para>For 1:M associations the property must be an reference to a PersistentObjectCollection @@ -628,7 +628,7 @@ ''' <summary> ''' ReadOnly. The cardinality of the association. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>Possible values are OneToOne or OneToMany. To support Many to Many (N:M) ''' associations you should create two OneToMany associations, one for each class linking ''' to the other. @@ -647,7 +647,7 @@ ''' <summary> ''' The name of the association ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>When there are multiple associations between two classes this property can ''' be used to distinguish between the associations. If the value is not set then the name ''' of the targetproperty is used as the name for the association. @@ -670,7 +670,7 @@ ''' Inidicates that any associated objects should be automatically deleted when an object of this ''' class is deleted. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -691,7 +691,7 @@ ''' Indicates that any associated objects should be automatically saved when an object ''' of this class is saved. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -712,7 +712,7 @@ ''' Indicates that any associated objects should be automatically retrieved when an object ''' of this class is retrieved. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -733,7 +733,7 @@ ''' Indicates that proxy objects should be retrieved when an object's ''' associated objects are retrieved. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -798,7 +798,7 @@ ''' <summary> ''' ReadOnly. The name of the association this pairing belongs to. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -815,7 +815,7 @@ ''' <summary> ''' ReadOnly. The name of a property in this class. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -832,7 +832,7 @@ ''' <summary> ''' ReadOnly. The name of a property in the target class. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> Index: CCacheEntry.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CCacheEntry.vb,v retrieving revision 1.35 retrieving revision 1.36 diff -u -d -r1.35 -r1.36 --- CCacheEntry.vb 24 May 2005 07:43:42 -0000 1.35 +++ CCacheEntry.vb 25 May 2005 01:26:11 -0000 1.36 @@ -204,7 +204,7 @@ ''' <summary> ''' Creates a string representation of the cache entry ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>The string returned by this method shows the state of the cache entry, and provides ''' and indication of the referenced object using the objects type name and the key properties of the object. ''' </remarks> @@ -1056,7 +1056,7 @@ ''' <summary> ''' Indicates if the cache is currently loading new objects. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>This flag controls the behaviour of the cache when returning objects. If the flag is true then the cache will return object references to the cached object. ''' When the flag is false, copies of the cached object are made and a reference to the copied object is returned. ''' </remarks> @@ -1111,7 +1111,7 @@ ''' <summary> ''' Produces a string that represents the current state of the cache. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>The method is useful for debugging purposes. ''' </remarks> ''' <history> @@ -1164,7 +1164,7 @@ ''' <summary> ''' Get an ArrayList containing the objects currently in the cache. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>This method is useful for debugging purposes if you wish to see what the current contents of the cache are. ''' It is not recommended that this method be used for any other purpose. ''' </remarks> @@ -1185,7 +1185,7 @@ ''' <summary> ''' Get an ArrayList containing the keys of the cache entries currently in the cache. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>This method is useful for debugging purposes but is not recommended for any other use. ''' </remarks> ''' <history> Index: CTableMap.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CTableMap.vb,v retrieving revision 1.9 retrieving revision 1.10 diff -u -d -r1.9 -r1.10 --- CTableMap.vb 24 May 2005 07:43:44 -0000 1.9 +++ CTableMap.vb 25 May 2005 01:26:13 -0000 1.10 @@ -67,7 +67,7 @@ ''' <summary> ''' The database usercode of the table owner ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>This value is used in databases that can specify tables using the owner ''' (ie MSSQL, etc but not MSAccess). ''' </remarks> Index: CPersistentCollection.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CPersistentCollection.vb,v retrieving revision 1.22 retrieving revision 1.23 diff -u -d -r1.22 -r1.23 --- CPersistentCollection.vb 24 May 2005 10:35:34 -0000 1.22 +++ CPersistentCollection.vb 25 May 2005 01:26:12 -0000 1.23 @@ -26,8 +26,42 @@ Private m_container As PersistentObject + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Event to indicate the collection has been changed (dirtied) + ''' </summary> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Event ItemDirtied As EventHandler + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Occurs when an object is removed from the collection. + ''' </summary> + ''' <param name="index">Index of the object that was removed</param> + ''' <param name="value">The removed object</param> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Event ObjectRemoved(ByVal index As Integer, ByRef value As Object) + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Occurs when an object is added to the collection. + ''' </summary> + ''' <param name="index">Index where the object was added</param> + ''' <param name="value">The object that was added</param> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Event ObjectAdded(ByVal index As Integer, ByRef value As Object) #Region "Collection Properties and Methods" @@ -74,7 +108,7 @@ ''' <summary> ''' Adds an item to the collection. ''' </summary> - ''' <param name="cp">A PersistentObject to be added.</param> + ''' <param name="value">A PersistentObject to be added.</param> ''' <remarks>The persistent object is added to the collection. If the container ''' object reference is set then the dirty flag on the container object is set.</remarks> ''' <history> @@ -157,10 +191,10 @@ ''' ----------------------------------------------------------------------------- ''' <summary> - ''' + ''' Inserts a PersistentObject into the collection ''' </summary> - ''' <param name="index"></param> - ''' <param name="value"></param> + ''' <param name="index">The position in the collection to insert into</param> + ''' <param name="value">The object to insert</param> ''' <remarks> ''' </remarks> ''' <history> @@ -171,13 +205,11 @@ list.Insert(index, value) End Sub - - '''----------------------------------------------------------------------------- ''' <summary> ''' Attempts to save each item in the collection ''' </summary> - ''' <value>An integer containing the number of objects that were actually saved.</value> + ''' <returns>An integer containing the number of objects that were actually saved.</returns> ''' <remarks>Each item in the collection is saved. If an error occurs during the saving ''' of any object the process is immediately aborted and an exception is thrown. ''' All objects are saved as part of a single transaction and the transaction is rolled back @@ -248,10 +280,32 @@ #End Region #Region "IBindlingList" + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Stub method for IBindingList.AddIndex + ''' </summary> + ''' <param name="property"> </param> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Overridable Sub AddIndex(ByVal [property] As System.ComponentModel.PropertyDescriptor) Implements System.ComponentModel.IBindingList.AddIndex End Sub + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Stub method for IBindingList.AddNew + ''' </summary> + ''' <returns> </returns> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Overridable Function AddNew() As Object Implements System.ComponentModel.IBindingList.AddNew End Function @@ -273,66 +327,212 @@ End Get End Property + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Implementation of IBindingList.AllowNew + ''' </summary> + ''' <returns>False</returns> + ''' <remarks>To allow new items to be added to your collection through data binding override this method and return true. + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- <Browsable(False)> Public Overridable ReadOnly Property AllowNew() As Boolean Implements System.ComponentModel.IBindingList.AllowNew Get Return False End Get End Property + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Implementation of IBindingList.AllowRemove + ''' </summary> + ''' <returns>False</returns> + ''' <remarks>To allow existing items to be removed from your collection through data binding, override this method and return true. + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- <Browsable(False)> Public Overridable ReadOnly Property AllowRemove() As Boolean Implements System.ComponentModel.IBindingList.AllowRemove Get Return False End Get End Property + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Stub method for IBindlingList.ApplySort + ''' </summary> + ''' <param name="property"> </param> + ''' <param name="direction"> </param> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Overridable Sub ApplySort(ByVal [property] As System.ComponentModel.PropertyDescriptor, ByVal direction As System.ComponentModel.ListSortDirection) Implements System.ComponentModel.IBindingList.ApplySort End Sub + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Stub method for IBindingList.Find + ''' </summary> + ''' <param name="property"> </param> + ''' <param name="key"> </param> + ''' <returns> </returns> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Overridable Function Find(ByVal [property] As System.ComponentModel.PropertyDescriptor, ByVal key As Object) As Integer Implements System.ComponentModel.IBindingList.Find End Function + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Stub method for IBindlingList.IsSorted. + ''' </summary> + ''' <returns> </returns> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- <Browsable(False)> Public Overridable ReadOnly Property IsSorted() As Boolean Implements System.ComponentModel.IBindingList.IsSorted Get End Get End Property + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Event definition for IBindingList.ListChanged + ''' </summary> + ''' <param name="sender">The object that fired the event</param> + ''' <param name="e">ListChangedEventArgs arguments</param> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Event ListChanged(ByVal sender As Object, ByVal e As System.ComponentModel.ListChangedEventArgs) Implements System.ComponentModel.IBindingList.ListChanged + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Stub method for IBindingList.RemoveIndex + ''' </summary> + ''' <param name="property"> </param> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Overridable Sub RemoveIndex(ByVal [property] As System.ComponentModel.PropertyDescriptor) Implements System.ComponentModel.IBindingList.RemoveIndex End Sub + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Stub method for IBindingList.RemoveSort + ''' </summary> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Overridable Sub RemoveSort() Implements System.ComponentModel.IBindingList.RemoveSort End Sub + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Stub method for IBindingList.SortDirection + ''' </summary> + ''' <returns> </returns> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- <Browsable(False)> Public Overridable ReadOnly Property SortDirection() As System.ComponentModel.ListSortDirection Implements System.ComponentModel.IBindingList.SortDirection Get End Get End Property + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Stub method for IBindingList.SortProperty + ''' </summary> + ''' <returns> </returns> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- <Browsable(False)> Public Overridable ReadOnly Property SortProperty() As System.ComponentModel.PropertyDescriptor Implements System.ComponentModel.IBindingList.SortProperty Get End Get End Property + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Implementation of IBindingList.SupportsChangeNotification + ''' </summary> + ''' <returns>True</returns> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- <Browsable(False)> Public Overridable ReadOnly Property SupportsChangeNotification() As Boolean Implements System.ComponentModel.IBindingList.SupportsChangeNotification Get Return True End Get End Property + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Implementation of IBindingList.SupportsSearching + ''' </summary> + ''' <returns>False</returns> + ''' <remarks>If you implement searching in your collection, override this method to return True. + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- <Browsable(False)> Public Overridable ReadOnly Property SupportsSearching() As Boolean Implements System.ComponentModel.IBindingList.SupportsSearching Get Return False End Get End Property + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Implementation of IBindingList.SupportsSorting + ''' </summary> + ''' <returns>False</returns> + ''' <remarks>If you implement sorting in your collection, override this method to return True. + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- <Browsable(False)> Public Overridable ReadOnly Property SupportsSorting() As Boolean Implements System.ComponentModel.IBindingList.SupportsSorting Get Return False @@ -341,6 +541,19 @@ #End Region #Region "Collection Events" + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Overrides CollectionBase.OnInsertComplete + ''' </summary> + ''' <param name="index">The index inserted</param> + ''' <param name="value">The object inserted</param> + ''' <remarks>Adds event handlers for the RemoveMe and ItemDirtied events for the inserted object. Also fires to ListChanged and ObjectAdded events and sets + ''' the container object to dirty (if it exists). + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Protected Overrides Sub OnInsertComplete(ByVal index As Integer, ByVal value As Object) AddHandler CType(value, PersistentObject).RemoveMe, AddressOf Remove AddHandler CType(value, PersistentObject).MarkedAsDirty, AddressOf ItemDirtiedHandler @@ -351,10 +564,32 @@ End If End Sub + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Overrides the CollectionBase.OnClearComplete method + ''' </summary> + ''' <remarks>Fires the ListChanged event with appropriate arguments + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Protected Overrides Sub OnClearComplete() RaiseEvent ListChanged(Me, New ListChangedEventArgs(ListChangedType.Reset, 0)) End Sub + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Overrides the CollectionBase.OnRemovedComplete method + ''' </summary> + ''' <param name="index">The index where the object was removed</param> + ''' <param name="value">The object that was removed</param> + ''' <remarks>Fires the ListChanged and ObectRemoved events and sets the container object dirty flag. + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Protected Overrides Sub OnRemoveComplete(ByVal index As Integer, ByVal value As Object) RaiseEvent ListChanged(Me, New ListChangedEventArgs(ListChangedType.ItemDeleted, index)) RaiseEvent ObjectRemoved(index, value) @@ -363,10 +598,33 @@ End If End Sub + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Overrides the CollectionBase.OnSetComplete + ''' </summary> + ''' <param name="index">The zero-based index at which oldValue can be found.</param> + ''' <param name="oldValue">The value to replace with newValue.</param> + ''' <param name="newValue">The new value of the element at index.</param> + ''' <remarks>Fires the ListChanged event + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Protected Overrides Sub OnSetComplete(ByVal index As Integer, ByVal oldValue As Object, ByVal newValue As Object) RaiseEvent ListChanged(Me, New ListChangedEventArgs(ListChangedType.ItemChanged, index)) End Sub + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Overrides the CollectionBase.OnClear method + ''' </summary> + ''' <remarks>Removes the MarkedAsDirty event handler for every object in the list. + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Protected Overrides Sub OnClear() For Each cp As PersistentObject In list RemoveHandler cp.MarkedAsDirty, AddressOf ItemDirtiedHandler @@ -375,19 +633,53 @@ #End Region #Region "IComponent Interface" + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Implements the IComponent.Disposed method + ''' </summary> + ''' <param name="sender">The object being disposed</param> + ''' <param name="e">EventArgs (empty)</param> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Event Disposed(ByVal sender As Object, ByVal e As System.EventArgs) Implements IComponent.Disposed Private m_curCPCSite As ISite + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Implementation of the IComponent.Site property + ''' </summary> + ''' <returns> </returns> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- <Browsable(False)> Public Property Site() As System.ComponentModel.ISite Implements IComponent.Site Get Return m_curCPCSite End Get Set(ByVal value As System.ComponentModel.ISite) - m_curCPCSite = Value + m_curCPCSite = value End Set End Property Private m_disposed As Boolean + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Disposes the collection. + ''' </summary> + ''' <param name="disposing"> </param> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Protected Overridable Overloads Sub Dispose(ByVal disposing As Boolean) If Not m_disposed Then If disposing Then @@ -396,6 +688,16 @@ End If End Sub + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Disposes the collection. + ''' </summary> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Overloads Sub Dispose() Implements System.IDisposable.Dispose Dispose(True) GC.SuppressFinalize(Me) Index: CClassMap.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CClassMap.vb,v retrieving revision 1.60 retrieving revision 1.61 diff -u -d -r1.60 -r1.61 --- CClassMap.vb 24 May 2005 07:43:42 -0000 1.60 +++ CClassMap.vb 25 May 2005 01:26:11 -0000 1.61 @@ -194,7 +194,7 @@ ''' <summary> ''' The number of associations originating with this class ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>The association map count includes the count of all association types and includes associations fo any super classes. ''' </remarks> ''' <history> @@ -217,7 +217,7 @@ ''' <summary> ''' Retrieves an association map based on it's name. ''' </summary> - ''' <param name="mapname">The name of the association map to retrieve</param> + ''' <param name="mapName">The name of the association map to retrieve</param> ''' <returns>An association map (if found) or nothing</returns> ''' <remarks>Returns the association map based on the name supplied. If no matching ''' association map can be found then Nothing is returned. @@ -460,7 +460,7 @@ ''' <summary> ''' The field that is used to differentiate between parent classes and sub classes ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>This property is used when a parent class and sub classes share the same ''' database table. The value from the SharedTableValue property is checked against the ''' SharedTableField and if the value matches then the record in the database belongs @@ -483,7 +483,7 @@ ''' <summary> ''' The value of the SharedTableField that indicates a record belongs to this class ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -1951,7 +1951,7 @@ ''' </summary> ''' <param name="broker">An instance of the persistence broker.</param> ''' <param name="parameters">A collection of parameters to pass</param> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>A shell SQL find is built and saved in the class map. ''' <para>This SQL shell is then processed and parameter placeholders and values are substituted into the AtomsSqlStatement..</para> ''' </remarks> @@ -2089,7 +2089,7 @@ ''' </summary> ''' <param name="broker">An instance of the persistence broker.</param> ''' <param name="parameters">A collection of parameters to pass</param> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>A shell SQL find is built and saved in the class map. ''' <para>This SQL shell is then processed and parameter placeholders and values are substituted into the AtomsSqlStatement..</para> ''' </remarks> @@ -2233,7 +2233,7 @@ ''' <summary> ''' A reference to the first Join object in a Join Set. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>This is used for internal purposes only. ''' </remarks> ''' <history> @@ -2250,7 +2250,7 @@ ''' <summary> ''' Creates an instance of the class mapped by the ClassMap object. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -2266,7 +2266,7 @@ ''' Creates an instance of the class mapped by the ClassMap object ''' </summary> ''' <param name="setStrongReference">Wether a strong reference to the object should be created.</param> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>The strong reference was to be used for better control of non-inherited objects during persistence however this functionality ''' was cancelled. The method remains for now. ''' </remarks> Index: CResultset.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CResultset.vb,v retrieving revision 1.7 retrieving revision 1.8 diff -u -d -r1.7 -r1.8 --- CResultset.vb 24 May 2005 07:43:44 -0000 1.7 +++ CResultset.vb 25 May 2005 01:26:12 -0000 1.8 @@ -76,6 +76,17 @@ End Sub Private m_disposed As Boolean + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Disposes the object + ''' </summary> + ''' <param name="disposing"> </param> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Private Overloads Sub Dispose(ByVal disposing As Boolean) If Not m_disposed Then If disposing Then @@ -89,6 +100,16 @@ End If End Sub + ''' ----------------------------------------------------------------------------- + ''' <summary> + ''' Disposes the object + ''' </summary> + ''' <remarks> + ''' </remarks> + ''' <history> + ''' [rbanks] 25/05/2005 Created + ''' </history> + ''' ----------------------------------------------------------------------------- Public Overloads Sub Dispose() Implements System.IDisposable.Dispose Me.Dispose(True) GC.SuppressFinalize(Me) Index: CRetrieveCriteria.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CRetrieveCriteria.vb,v retrieving revision 1.15 retrieving revision 1.16 diff -u -d -r1.15 -r1.16 --- CRetrieveCriteria.vb 24 May 2005 07:43:44 -0000 1.15 +++ CRetrieveCriteria.vb 25 May 2005 01:26:12 -0000 1.16 @@ -144,7 +144,7 @@ ''' <summary> ''' Returns a new CriteriaCondition. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>The current objects classmap, tables and associations are referenced in the returned CriteriaCondition object.</remarks> ''' <history> ''' [rbanks] 17/12/2003 Created @@ -163,7 +163,7 @@ ''' <summary> ''' Generates an SQL statement based on the properties of this object. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>The SQL statement returned will be a select statement for full objects ''' based on the criteria specified in this object.</remarks> ''' <history> @@ -179,7 +179,7 @@ ''' Generates an SQL statement based on the properties of this object. ''' </summary> ''' <param name="fullObjects">flag to return full objects or proxy objects.</param> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>The SQL statement returned will be a select statement based on the criteria ''' specified in this object. ''' <para>The data returned will contain all neccesary columns for instantiating Index: CCursor.vb =================================================================== RCS file: /cvsroot/jcframework/dotnet/CCursor.vb,v retrieving revision 1.20 retrieving revision 1.21 diff -u -d -r1.20 -r1.21 --- CCursor.vb 24 May 2005 07:43:42 -0000 1.20 +++ CCursor.vb 25 May 2005 01:26:11 -0000 1.21 @@ -160,7 +160,7 @@ ''' <summary> ''' ReadOnly. The number of datarows contained in the Cursors ResultSet. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks> ''' </remarks> ''' <history> @@ -199,7 +199,7 @@ ''' <summary> ''' The PersistentCriteria that was used to create this cursor. ''' </summary> - ''' <returns></returns> + ''' <returns> </returns> ''' <remarks>If the cursor is created by using ProcessDirectSQL then this property ''' will return Nothing. ''' </remarks> @@ -216,6 +216,24 @@ End Set End Property + '''----------------------------------------------------------------------------- + ''' <summary> + ''' Populates an object based on the data at the current cursor position. + ''' </summary> + ''' <param name="obj">The object to populate. Must already be instantiated.</param> + ''' <remarks>This method will fully populate an object regardless of the wether + ''' the ResultCursor references only proxy data or not. If the ResultCursor contains + ''' proxy only data, then the proxy version of the object is populated. The full object is then + ''' retrieved using the normal retrieve method for CPersistentObjects. + ''' <para>If the resultset contains complete object information then the method will + ''' populate all of the mapped attributes for the object and no further database + ''' interaction will occur.</para> + ''' <para>Note: Objects retrieved in this manner will not be added to the cache. Also, + ''' object associations will not be traversed, including those marked as automatic retrieve.</para></remarks> + ''' <history> + ''' [rbanks] 4/12/2003 Created + ''' </history> + '''----------------------------------------------------------------------------- Public Sub LoadObject(ByRef obj As Object) If obj.GetType.IsSubclassOf(GetType(PersistentObject)) Then LoadPersistentObject(obj) @@ -252,6 +270,25 @@ End If End Sub + '''----------------------------------------------------------------------------- + ''' <summary> + ''' Populates an object based on the data at the current cursor position. + ''' </summary> + ''' <param name="obj">The object to populate. Must already be instantiated.</param> + ''' <param name="offset">The index of the object to use as a data source. Only used in MultiRetrieveCriteria.</param> + ''' <remarks>This method will fully populate an object regardless of the wether + ''' the ResultCursor references only proxy data or not. If the ResultCursor contains + ''' proxy only data, then the proxy version of the object is populated. The full object is then + ''' retrieved using the normal retrieve method for CPersistentObjects. + ''' <para>If the resultset contains complete object information then the method will + ''' populate all of the mapped attributes for the object and no further database + ''' interaction will occur.</para> + ''' <para>Note: Objects retrieved in this manner will not be added to the cache. Also, + ''' object associations will not be traversed, including those marked as automatic retrieve.</para></remarks> + ''' <history> + ''' [rbanks] 4/12/2003 Created + ''' </history> + '''----------------------------------------------------------------------------- Public Sub LoadObject(ByRef obj As InjectedObject, ByVal offset As Integer) Dim _alias As String = "" Dim mr As MultiRetrieveCriteria @@ -302,6 +339,28 @@ End If End Sub + '''----------------------------------------------------------------------------- + ''' <summary> + ''' Populates an object based on the data at the current cursor position. + ''' </summary> + ''' <param name="obj">The object to populate. Must already be instantiated.</param> + ''' <remarks>This method will fully populate an object regardless of the wether + ''' the ResultCursor references only proxy data or not. If the ResultCursor contains + ''' proxy only data, then the proxy version of the object is populated. The full object is then + ''' retrieved using the normal retrieve method for CPersistentObjects. + ''' <para>If the resultset contains complete object information then the method will + ''' populate all of the mapped attributes for the object and no further database + ''' interaction will occur.</para> + ''' <para>Note: Objects retrieved in this manner will not be added to the cache. Also, + ''' object associations will not be traversed, including those marked as automatic retrieve.</para> + ''' <para>The offset allows for the retrieval of the nth instance of an object and + ''' is useful when there is are multiple instances of the same class in a single cursor + ''' data row (ie when there are circular references in the retrieve criteria).</para> + ''' </remarks> + ''' <history> + ''' [rbanks] 4/12/2003 Created + ''' </history> + '''----------------------------------------------------------------------------- Public Sub LoadPersistentObject(ByRef obj As PersistentObject) LoadPersistentObject(obj, 0) End Sub @@ -395,6 +454,28 @@ LoadObject(obj, broker, 0) End Sub + '''----------------------------------------------------------------------------- + ''' <summary> + ''' Populates an object based on the data at the current cursor position. + ''' </summary> + ''' <param name="obj">The object to populate. Must already be instantiated.</param> + ''' <param name="broker">A reference to the persistence broker.</param> + ''' <param name="offset">The offset for the object to load. Used in MultiRetrieveCriteria when the same class is referenced mutliple times.</param> + ''' <remarks>This method will fully populate an object regardless of the wether + ''' the ResultCursor references only proxy data or not. If the ResultCursor contains + ''' proxy only data, then the proxy version of the object is populated. The full object is then + ''' retrieved using the normal retrieve method for CPersistentObjects. + ''' <para>If the resultset contains complete object information then the method will + ''' populate all of the mapped attributes for the object and no further database + ''' interaction will occur.</para> + ''' <para>Note: Since we have a reference to the persistence broker retrieved objects will be + ''' added to the cache. Further to this, all object associations will also be processed as per + ''' a normal retrieve operation.</para> + ''' </remarks> + ''' <history> + ''' [rbanks] 4/12/2003 Created + ''' </history> + '''----------------------------------------------------------------------------- Public Sub LoadObject(ByRef obj As PersistentObject, ByRef broker As PersistenceBroker, ByVal offset As Integer) Dim _alias As String = "" @@ -458,6 +539,18 @@ LoadProxy(injobj) End If End Sub + + '''----------------------------------------------------------------------------- + ''' <summary> + ''' Loads a proxy version of the object based on the data at the current cursor position. + ''' </summary> + ''' <param name="obj">The object to populate. Must already be instantiated.</param> + ''' <remarks>Populates the attributes in the object that are marked as proxy="True" + ''' in the XML mapping.</remarks> + ''' <history> + ''' [rbanks] 4/12/2003 Created + ''' </history> + '''----------------------------------------------------------------------------- Public Sub LoadProxy(ByRef obj As IPersistableObject) If Not obj.IsIPersistentObject Then LoadProxy(obj, 0) @@ -465,6 +558,19 @@ LoadPersistentProxy(obj, 0) End If End Sub + + '''----------------------------------------------------------------------------- + ''' <summary> + ''' Loads a proxy version of the object based on the data at the current cursor position. + ''' </summary> + ''' <param name="obj">The object to populate. Must already be instantiated.</param> + ''' <param name="offset">The index of the source data. Used when the same class is used in a MultiRetrieveCriteria multiple times.</param> + ''' <remarks>Populates the attributes in the object that are marked as proxy="True" + ''' in the XML mapping.</remarks> + ''' <history> + ''' [rbanks] 4/12/2003 Created + ''' </history> + '''----------------------------------------------------------------------------- Public Sub LoadProxy(ByRef obj As InjectedObject, ByVal offset As Integer) Dim _alias As String = "" Dim cm As MultiRetrieveCriteria @@ -486,6 +592,18 @@ End Sub + '''----------------------------------------------------------------------------- + ''' <summary> + ''' Loads a proxy version of the object based on the data at the current cursor position. + ''' </summary> + ''' <param name="obj">The object to populate. Must already be instantiated.</param> + ''' <param name="offset">The index of the source data. Used when the same class is used in a MultiRetrieveCri... [truncated message content] |
