opf.xml

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

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>OPF</name>
    </assembly>
    <members>
        <member name="T:OPF.Attributes.NotPersistent">
            <summary>
            Set this attribute to flag a property as not peristent, i.e. it will not 
            be loaded and/or saved to storage.
            </summary>
        </member>
        <member name="T:OPF.Attributes.Mandatory">
            <summary>
            Set this attribute if a property should be treated as mandatory. OPF will check for
            a valid value in the property upon saving. Also see the CheckConstraints method of the Persistent class.
            </summary>
        </member>
        <member name="T:OPF.Attributes.ReadOnly">
            <summary>
            Set this attribute if a property is to be treated as read only, i.e. 
            it gets read from the storage but never written.
            </summary>
        </member>
        <member name="T:OPF.Attributes.Encrypted">
            <summary>
            Set this attribute if a property should be encrypted before saving (using DES) and
            decrypted after loading.
            </summary>
        </member>
        <member name="T:OPF.Attributes.RijndaelEncrypted">
            <summary>
            Set this attribute if a property should be encrypted before saving (using Rijndael) and
            decrypted after loading.
            </summary>
        </member>
        <member name="T:OPF.Attributes.ZipCompressed">
            <summary>
            Set this attribute to ZIP compress the property content upon saving and unzip 
            it on load.
            </summary>
        </member>
        <member name="T:OPF.Attributes.MapField">
            <summary>
            Set this attribute to a property to connect the property with a 
            field in the storage. The field in the storage has to be set as
            constructor parameter.
            </summary>
        </member>
        <member name="M:OPF.Attributes.MapField.#ctor(System.String)">
            <summary>
            Constructor. Sets the name connected with the property.
            </summary>
            <param name="FieldName">Name of the field in the storage.</param>
        </member>
        <member name="P:OPF.Attributes.MapField.FieldName">
            <summary>
            Returns the name of the field in the storage connected
            with the property.
            </summary>
        </member>
        <member name="T:OPF.Collections.CollectionFlags">
            <summary>
            Flags to change the behaviour of the collection class. If the flag eg. NotLoadable is set, then it
            is not possible to use the load method on that instance of the collection class. In that case the 
            collection class will throw an exception if someone tries to call the load function.
            </summary>
        </member>
        <member name="F:OPF.Collections.CollectionFlags.NotLoadable">
            <summary>The collection can't be loaded from storage.</summary>
        </member>
        <member name="F:OPF.Collections.CollectionFlags.NotSaveable">
            <summary>The collection can't be saved to the storage.</summary>
        </member>
        <member name="F:OPF.Collections.CollectionFlags.NotDeletable">
            <summary>The collection can't be deleted from storage.</summary>
        </member>
        <member name="F:OPF.Collections.CollectionFlags.AllowAll">
            <summary>Standard. Any operation is allowed.</summary>
        </member>
        <member name="T:OPF.Collections.Collection">
            <summary>
            The OPF collection class. The collection holds a set of OPF.BaseObjects or 
            derived classes. A collection can hold different types of objects as long
            as they all inherit from OPF.BaseObject. OPF.BaseObject is a memory only
            object. If a collection contains at least one object directly derived from
            OPF.BaseObject (and not from OPF.Persistent) than all storage related operations
            on the collection cannot be executed.
            </summary>
        </member>
        <member name="T:OPF.BaseObject">
            <summary>
            Base class for all OPF.BaseObjects. Object cannot be saved to a storage but is for in memory operations only
            </summary>
        </member>
        <member name="M:OPF.BaseObject.#ctor">
            <summary>
            Constructor. Generates a new GUID for the object.
            </summary>
        </member>
        <member name="M:OPF.BaseObject.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
            <summary>
            Constructor required for deserialization.
            </summary>
            <param name="SerialInfo">Contains the data to serialize and deserialize the object.</param>
            <param name="StreamContext">Contains the information about the source or target of the 
            serialization process.</param>
        </member>
        <member name="M:OPF.BaseObject.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
            <summary>
            Serializes the current object.
            </summary>
            <param name="SerialInfo">Contains the data to serialize and deserialize the object.</param>
            <param name="StreamContext">Contains the information about the source or target of the 
            serialization process.</param>
        </member>
        <member name="M:OPF.BaseObject.ObjectCreated">
            <summary>
            Can be overriden if something should be set or done
            with an OPF.BaseObject (and derivated classes) after having created the object.
            </summary>
        </member>
        <member name="M:OPF.BaseObject.IsAssigned">
            <summary>
            Checks if the object is assigned.
            If the ID is NullID the object is not assigned (as nothing form the storage 
            is loaded into the object)
            </summary>
        </member>
        <member name="M:OPF.BaseObject.IsChanged">
            <summary>
            Checks if the object has been changed since the last saving or loading.
            </summary>
        </member>
        <member name="M:OPF.BaseObject.IsChanged(System.Int64@)">
            <summary>
            Checks if the object has been changed since the last saving or loading. Returns the new CRC out parameter.
            </summary>
            <param name="CalculatedCrc">Contains the new CRC after executing this function.</param>
        </member>
        <member name="M:OPF.BaseObject.EqualsByID(OPF.BaseObject)">
            <summary>
            Compares the current object with an other object. Only by ID (very fast).
            </summary>
            <param name="OtherObject">Other object to compare with.</param>
        </member>
        <member name="M:OPF.BaseObject.Equals(System.Object)">
            <summary>
            Compares the current object with an other object.
            Gives back true, if the two objects have the same type and the same properties.
            Methods with the IsPersistent attribute are also compared.
            </summary>
            <param name="OtherObject">Other object to compare with.</param>
        </member>
        <member name="M:OPF.BaseObject.Assign(OPF.BaseObject)">
            <summary>
            Assigns all fields of the current OPF.BaseObject to another object.
            </summary>
            <param name="OtherObject">Other object to be assigned to this object.</param>
        </member>
        <member name="M:OPF.BaseObject.GetHashCode">
            <summary>
            Returns the hashcode for the current object. 
            Must be overwritten, when overwriting Equals.
            </summary>
        </member>
        <member name="M:OPF.BaseObject.CalculateCrc">
            <summary>
            Returns the CRC32 for this object. Does not set the calculated CRC!
            </summary>
        </member>
        <member name="M:OPF.BaseObject.SetNewID(OPF.ID)">
            <summary>
            Sets a new ID for this object. 
            Use this function only if you know exactly what you are doing! Is should normally not be necessary to
            set the ID.
            </summary>
            <param name="OPFObjectID">The new ID for this object.</param>
        </member>
        <member name="M:OPF.BaseObject.CheckConstraints">
            <summary>
            Checks if all mandatory fields have been compiled. Uses the checkconstraints class to performs the checks.
            </summary>
        </member>
        <member name="M:OPF.BaseObject.CheckConstraint(System.String,System.String,System.Object)">
            <summary>
            Check one property for constraint violations.
            </summary>
            <param name="PropertyName">Name of the property to be checked.</param>
            <param name="PropertyType">Type of the property.</param>
            <param name="PropertyValue">Value of the property.</param>
        </member>
        <member name="M:OPF.BaseObject.RollbackCrc">
            <summary>
            Sets the CRC one step back (rollback). If there is no older version an exception is thrown.
            </summary>
        </member>
        <member name="M:OPF.BaseObject.Compare(OPF.BaseObject)">
            <summary>
            Compares two objects for sorting and searching purposes. Must be overwritten for own search mechanism.
            a) If the OtherObject is "greater" then the acutal object return: -1
            b) If equal return:                                                0
            c) If the current object is greater then the other one return:     1
            </summary>
            <param name="OtherObject">Object to compare</param>
        </member>
        <member name="M:OPF.BaseObject.Contains(System.String,System.Object)">
            <summary>
            Returns true if an object contains a certain property with a certain value.
            </summary>
            <param name="PropertyName">Name of the property.</param>
            <param name="Value">Value of the property.</param>
        </member>
        <member name="M:OPF.BaseObject.Clone">
            <summary>
            Clones the actual object and returns the cloned one. Clone returns an excact copy of the original
            object.
            </summary>
        </member>
        <member name="P:OPF.BaseObject.ID">
            <summary>
            Returns and sets the ID of the object. 
            Use this property only if you know exactly what you are doing! Is should normally not be necessary to
            set the ID.
            </summary>
        </member>
        <member name="P:OPF.BaseObject.NullIDValue">
            <summary>
            Returns the value of the NullID. It is also possible to set a new value for NullID.
            </summary>
        </member>
        <member name="P:OPF.BaseObject.Crc">
            <summary>
            Returns and sets the actual CRC for this object.
            </summary>
        </member>
        <member name="P:OPF.BaseObject.Constraints">
            <summary>
            Sets and gets the class used in the check constraints method.
            </summary>
        </member>
        <member name="M:OPF.Collections.Collection.#ctor">
            <summary>
            Constructor. Sets only the ID to a new GUID.
            </summary>
        </member>
        <member name="M:OPF.Collections.Collection.#ctor(OPF.Collections.CollectionFlags)">
            <summary>
            Constructor. Sets the ID to a new GUID and the CollectionFlags, which change the behaviour 
            of the class. See (enumeration)CollectionFlags for additional information.
            </summary>
            <param name="CollectionFlags">Set the CollectionFlags to change the behaviour of the collection.</param>
        </member>
        <member name="M:OPF.Collections.Collection.#ctor(OPF.Collections.CollectionFlags,OPF.BaseObject[])">
            <summary>
            Constructor. Sets the ID to a new GUID and the CollectionFlags, which change the behaviour 
            of the class. See (enumeration)CollectionFlags for additional information.
            It is also possible to specify an array of objects (or derivatives) that will be immidiately added
            to the collection.
            </summary>
            <param name="CollectionFlags">Set the CollectionFlags to change the  behaviour of the collection.</param>