opf.xml

o-r mapping 实现以面向对象的方式建立对关系型数据库的映射。

        <member name="M:OPF.IDGenerator.GetNewID">
            <summary>
            Virtual function that returns an new unique ID
            If length is set to 0 returns a GUID (eg 5a06fc16-db9a-4bae-88c5-66ef9df320b7).
            If lenght has been specified in the constructor gives back a random ID of that lenght.
            </summary>
        </member>
        <member name="M:OPF.IDGenerator.RemoveChars(System.String)">
            <summary>
            Internal function that removes all chars in a string. Returns a string without chars, only numbers.
            </summary>
            <param name="MixedString">A mixed string, which contains chars and numbers.</param>
        </member>
        <member name="T:OPF.ID">
            <summary>
            The ID class for all OPF.BaseObjects. Holds the basic ID functions.
            </summary>
        </member>
        <member name="M:OPF.ID.#ctor">
            <summary>
            Basic constructor. Sets the ID to NullID.
            </summary>
        </member>
        <member name="M:OPF.ID.#ctor(System.String)">
            <summary>
            Constructor. Let's you set the ID when creating the new ID.
            </summary>
            <param name="ID">The ID you want set.</param>
        </member>
        <member name="M:OPF.ID.ClearID">
            <summary>
            Sets the ID back to NullID.
            </summary>
        </member>
        <member name="M:OPF.ID.SetNewID(System.String)">
            <summary>
            Sets a new ID. If the ID is the same as the NullID, then an exception is thrown.
            </summary>
            <param name="NewID">The ID you want set as string.</param>
        </member>
        <member name="M:OPF.ID.SetNewID(OPF.ID)">
            <summary>
            Sets a new ID. If the ID is NullID, then an excpetion is thrown.
            </summary>
            <param name="NewID">The ID to set.</param>
        </member>
        <member name="M:OPF.ID.Equals(OPF.ID)">
            <summary>
            Basic equals method. Returns true if the ID and OtherID are equal
            </summary>
            <param name="OtherID">The Other ID you want compare with this one.</param>
        </member>
        <member name="M:OPF.ID.IsNull">
            <summary>
            Returns true if the current ID is NullID.
            An ID that holds an empty string is considered a NullID.
            </summary>
        </member>
        <member name="M:OPF.ID.Rollback">
            <summary>
            Reverts the ID to its previous value. Used by the OPF in transactions to revert object in memory
            on a rollback.
            </summary>
        </member>
        <member name="M:OPF.ID.Assign(OPF.ID)">
            <summary>
            Assigns another ID to the current ID.
            </summary>
            <param name="OtherID">The ID you want assign.</param>
        </member>
        <member name="M:OPF.ID.CompareTo(System.Object)">
            <summary>
            Compares the actual ID with the other ID given. CompareTo is used to sort collections of
            objects. For different sorting behavior override this method.
            </summary>
            <param name="OtherID">The other ID you want to be compared.</param>
        </member>
        <member name="M:OPF.ID.Clone">
            <summary>
            Clones the actual object and returns the cloned one.
            </summary>
        </member>
        <member name="M:OPF.ID.GenerateNewID">
            <summary>
            Creates a new ID with the IDGenerator specified in the OPF.Main Class.
            </summary>
        </member>
        <member name="M:OPF.ID.op_Equality(OPF.ID,OPF.ID)">
            <summary>
            Operator overloading. Checks the ID values and returns true, if both
            IDs have the same value.
            </summary>
            <param name="FirstID">First ID to check.</param>
            <param name="SecondID">Second ID to check.</param>
        </member>
        <member name="M:OPF.ID.op_Inequality(OPF.ID,OPF.ID)">
            <summary>
            Operator overloading. Checks the ID values and returns true, if both
            IDs have different values.
            </summary>
            <param name="FirstID">First ID to check.</param>
            <param name="SecondID">Second ID to check.</param>
        </member>
        <member name="M:OPF.ID.Equals(System.Object)">
            <summary>
            Returns true if the ID given matches the current ID.
            </summary>
            <param name="ID">ID given to compare with the current one.</param>
        </member>
        <member name="M:OPF.ID.GetHashCode">
            <summary>
            Returns the hashvalue of the current ID.
            </summary>
            <returns></returns>
        </member>
        <member name="M:OPF.ID.op_Implicit(OPF.ID)~System.String">
            <summary>
            Allows to cast a ID to a string and returns it.
            </summary>
            <param name="ID">ID that should be casted.</param>
        </member>
        <member name="M:OPF.ID.ToString">
            <summary>
            Returns the value of the ID.
            </summary>
        </member>
        <member name="P:OPF.ID.NullIDValue">
            <summary>
            Sets and returns the NullID value.
            </summary>
        </member>
        <member name="P:OPF.ID.Value">
            <summary>
            Returns the actual ID or sets a new ID.
            Setting a new ID works exactly in the same way as SetNewID.
            </summary>
        </member>
        <member name="T:OPF.Blob">
            <summary>
            The Blob class for all OPF.Net Blobs. Holds the basic Blob functions.
            </summary>
        </member>
        <member name="M:OPF.Blob.#ctor">
            <summary>
            Constructor.
            </summary>
        </member>
        <member name="M:OPF.Blob.#ctor(System.Byte[])">
            <summary>
            Constructor. Allows to set the byte array.
            </summary>
            <param name="Bytes">Byte array managed by this Blob.</param>
        </member>
        <member name="M:OPF.Blob.GetStreamWriter">
            <summary>
            Returns the stream writer for the blob. The blob can be saved to a file using the returned stream writer.
            </summary>
        </member>
        <member name="M:OPF.Blob.AssignBlob(System.IO.StreamReader)">
            <summary>
            Assigns all bytes of the reader to the blob.
            </summary>
            <param name="Reader">Reader that contains the blob.</param>
        </member>
        <member name="M:OPF.Blob.CompareTo(System.Object)">
            <summary>
            Compares the actual Blob with the other Blob given byte by byte.
            </summary>
            <param name="OtherBlob">The other Blob you want to be compared.</param>
        </member>
        <member name="M:OPF.Blob.Assign(OPF.Blob)">
            <summary>
            Assigns the data of another Blob to the actual Blob.
            </summary>
            <param name="OtherBlob">Other Blob to assign with the actual Blob.</param>
        </member>
        <member name="M:OPF.Blob.Equals(OPF.Blob)">
            <summary>
            Returns true if the data of the actual Blob matches with the Blob given.
            </summary>
            <param name="OtherBlob">Other Blob to compare with this one.</param>
        </member>
        <member name="M:OPF.Blob.SetNotChanged">
            <summary>
            Sets the Blob to not changed - Used internally by the DataManager - Do NOT use it!
            </summary>
        </member>
        <member name="M:OPF.Blob.Clone">
            <summary>
            Clones the actual object and returns the cloned one.
            </summary>
        </member>
        <member name="M:OPF.Blob.ToString">
            <summary>
            Returns the actual content of the Blob as string.
            </summary>
        </member>
        <member name="P:OPF.Blob.Bytes">
            <summary>
            Sets and returns the bytes contained by the Blob.
            </summary>
        </member>
        <member name="P:OPF.Blob.MemoryStream">
            <summary>
            Returns and sets the memorystream for this blob.
            </summary>
        </member>
        <member name="P:OPF.Blob.Changed">
            <summary>
            Returns true if the Blob has been changed since the last load from storage.
            </summary>
        </member>
        <member name="P:OPF.Blob.Length">
            <summary>
            Returns the length of the blob.
            </summary>
        </member>
        <member name="T:OPF.PersistentFlags">
            <summary>
            Flags to change the behaviour of the persistent class. If the flag eg. NotLoadable is set then it
            is not possible to use the load method in that instance of the persistent class. In that case the 
            persistent class will throw an exception if someone tries to call the load function.
            </summary>
        </member>
        <member name="F:OPF.PersistentFlags.NotLoadable">
            <summary>If this flags is set load is not supported by the persistent.</summary>
        </member>
        <member name="F:OPF.PersistentFlags.NotSaveable">
            <summary>If this flags is set save is not supported by the persistent.</summary>
        </member>
        <member name="F:OPF.PersistentFlags.NotDeletable">
            <summary>If this flags is set delete is not supported by the persistent.</summary>
        </member>
        <member name="F:OPF.PersistentFlags.AllowAll">
            <summary>If this flags is set all operations are supported by the persistent.</summary>
        </member>
        <member name="T:OPF.RelationDirection">
            <summary>
            Contains the direction of the relation between the nested object and its owner.
            </summary>
        </member>
        <member name="F:OPF.RelationDirection.FromNested">
            <summary>Direction from nested to the owner. Means that the nested object holds a foreign key to the owner object</summary>
        </member>
        <member name="F:OPF.RelationDirection.ToNested">
            <summary>Direction to the nested. Means the owner object holds a foreign key to the nested object</summary>
        </member>
        <member name="T:OPF.Persistent">
            <summary>
            Base class for persistent objects. A persistent normally holds one tupel of the storage (e.g. one database table).
            However by overriding specific methods a persistent class can map to any storage object
            </summary>
        </member>
        <member name="M:OPF.Persistent.#ctor">
            <summary>
            Base Constructor.
            </summary>
        </member>
        <member name="M:OPF.Persistent.#ctor(OPF.PersistentFlags)">
            <summary>
            Constructor. Calls the base constructor and sets the persistent flags.