perst.xml

Perst开源实时数据库

            <param name="till">Inclusive high boundary. If <code>null</code> then high boundary is not specified.</param>
            <param name="order"><code>IterationOrder.AscentOrder</code> or <code>IterationOrder.DescentOrder</code></param>
            <returns>enumerable collection</returns>
            
        </member>
        <member name="M:Perst.GenericIndex.Range(System.Object,System.Object)">
            <summary>
            Get enumerable ascent ordered collection of objects in the index with key belonging to the specified range. 
            You should not update/remove or add members to the index during iteration
            </summary>
            <param name="from">Inclusive low boundary. If <code>null</code> then low boundary is not specified.</param>
            <param name="till">Inclusive high boundary. If <code>null</code> then high boundary is not specified.</param>
            <returns>enumerable collection</returns>
            
        </member>
        <member name="M:Perst.GenericIndex.GetAt(System.Int32)">
            <summmary>
            Get element at specified position. This methid is efficient only for random access indices
            </summmary>
            <param name="i">position of element in the index</param>
            <returns>object at sepcified position</returns>
            <exception cref="T:System.IndexOutOfRangeException">System.IndexOutOfRangeException if position is less than 0 or greater or equal than index size</exception> 
        </member>
        <member name="M:Perst.GenericIndex.GetDictionaryEnumerator(System.Int32,Perst.IterationOrder)">
            <summary>
            Get dictionary enumerator of objects in the index starting with specified position.
            This methid is efficient only for random access indices
            You should not update/remove or add members to the index during iteration
            </summary>
            <param name="start">Start position in the index. First <code>pos</code> elements will be skipped.</param>
            <param name="order"><code>IterationOrder.AscentOrder</code> or <code>IterationOrder.DescentOrder</code></param>
            <returns>dictionary enumerator</returns>
            
        </member>
        <member name="P:Perst.GenericIndex.KeyType">
            <summary>
            Get type of index key
            </summary>
            <returns>type of index key</returns>
        </member>
        <member name="P:Perst.GenericIndex.Item(System.Object)">
            <summary> Access element by key
            </summary>
        </member>
        <member name="P:Perst.GenericIndex.Item(System.Object,System.Object)">
            <summary> Get objects which key value belongs to the specified range.
            </summary>
        </member>
        <member name="M:Perst.Index.Put(Perst.Key,Perst.IPersistent)">
            <summary> Put new object in the index. 
            </summary>
            <param name="key">object key wrapper
            </param>
            <param name="obj">object associated with this key. Object can be not yet peristent, in this case
            its forced to become persistent by assigning OID to it.
            </param>
            <returns><code>true</code> if object is successfully inserted in the index, 
            <code>false</code> if index was declared as unique and there is already object with such value
            of the key in the index. 
            </returns>
        </member>
        <member name="M:Perst.Index.Put(System.Object,Perst.IPersistent)">
            <summary> Put new object in the index. 
            </summary>
            <param name="key">object key value
            </param>
            <param name="obj">object associated with this key. Object can be not yet peristent, in this case
            its forced to become persistent by assigning OID to it.
            </param>
            <returns><code>true</code> if object is successfully inserted in the index, 
            <code>false</code> if index was declared as unique and there is already object with such value
            of the key in the index. 
            
            </returns>
        </member>
        <member name="M:Perst.Index.Set(Perst.Key,Perst.IPersistent)">
            <summary> Associate new value with the key. If there is already object with such key in the index, 
            then it will be removed from the index and new value associated with this key.
            </summary>
            <param name="key">object key wrapper
            </param>
            <param name="obj">object associated with this key. Object can be not yet peristent, in this case
            its forced to become persistent by assigning OID to it.
            </param>
            <returns>object previously associated with this key, <code>null</code> if there was no such object
            </returns>
        </member>
        <member name="M:Perst.Index.Set(System.Object,Perst.IPersistent)">
            <summary> Associate new value with the key. If there is already object with such key in the index, 
            then it will be removed from the index and new value associated with this key.
            </summary>
            <param name="key">object key value
            </param>
            <param name="obj">object associated with this key. Object can be not yet peristent, in this case
            its forced to become persistent by assigning OID to it.
            </param>
            <returns>object previously associated with this key, <code>null</code> if there was no such object
            </returns>
        </member>
        <member name="M:Perst.Index.Remove(Perst.Key,Perst.IPersistent)">
            <summary> Remove object with specified key from the tree.
            </summary>
            <param name="key">wrapper of the value of the key of removed object
            </param>
            <param name="obj">object removed from the index
            </param>
            <exception cref="T:Perst.StorageError">StorageError(StorageError.ErrorCode.KEY_NOT_FOUND) exception if there is no such key in the index
            
            </exception>
        </member>
        <member name="M:Perst.Index.Remove(System.Object,Perst.IPersistent)">
            <summary> Remove object with specified key from the tree.
            </summary>
            <param name="key">value of the key of removed object
            </param>
            <param name="obj">object removed from the index
            </param>
            <exception cref="T:Perst.StorageError">StorageError(StorageError.ErrorCode.KEY_NOT_FOUND) exception if there is no such key in the index
            
            </exception>
        </member>
        <member name="M:Perst.Index.Remove(Perst.Key)">
            <summary> Remove key from the unique index.
            </summary>
            <param name="key">wrapper of removed key
            </param>
            <returns>removed object</returns>
            <exception cref="T:Perst.StorageError">StorageError(StorageError.ErrorCode.KEY_NOT_FOUND) exception if there is no such key in the index,
            or StorageError(StorageError.ErrorCode.KEY_NOT_UNIQUE) if index is not unique.
            
            </exception>
        </member>
        <member name="M:Perst.Index.Remove(System.Object)">
            <summary> Remove key from the unique index.
            </summary>
            <param name="key">value of removed key
            </param>
            <returns>removed object</returns>
            <exception cref="T:Perst.StorageError">StorageError(StorageError.ErrorCode.KEY_NOT_FOUND) exception if there is no such key in the index,
            or StorageError(StorageError.ErrorCode.KEY_NOV_UNIQUE) if index is not unique.
            
            </exception>
        </member>
        <member name="T:Perst.PersistentEnumerator">
            <summary>Interface implemented by all Perst enumerators allowing to get Oid of the current object
            </summary>
        </member>
        <member name="P:Perst.PersistentEnumerator.CurrentOid">
            <summary>Get OID of the current object</summary>
        </member>
        <member name="T:Perst.CompoundIndex">
            <summary> Interface of compound index. 
            </summary>
        </member>
        <member name="P:Perst.CompoundIndex.KeyTypes">
            <summary>
            Get types of compund key components
            </summary>
            <returns>array of types of compund key componentss</returns>
        </member>
        <member name="T:Perst.FieldIndex">
            <summary> Interface of indexed field. 
            Index is used to provide fast access to the object by the value of indexed field. 
            Objects in the index are stored ordered by the value of indexed field. 
            It is possible to select object using exact value of the key or 
            select set of objects which key belongs to the specified interval 
            (each boundary can be specified or unspecified and can be inclusive or exclusive)
            Key should be of scalar, String, DateTime or peristent object type.
            </summary>
        </member>
        <member name="M:Perst.FieldIndex.Contains(Perst.IPersistent)">
            <summary> 
            Check if index contains specified object
            </summary>
            <param name="obj">object to be searched in the index. Object should contain indexed field. 
            </param>
            <returns><code>true</code> if object is present in the index, <code>false</code> otherwise
            </returns>
        </member>
        <member name="M:Perst.FieldIndex.Put(Perst.IPersistent)">
            <summary> Put new object in the index. 
            </summary>
            <param name="obj">object to be inserted in index. Object should contain indexed field. 
            Object can be not yet persistent, in this case its forced to become persistent by assigning OID to it.
            </param>
            <returns><code>true</code> if object is successfully inserted in the index, 
            <code>false</code> if index was declared as unique and there is already object with such value
            of the key in the index. 
            
            </returns>
        </member>
        <member name="M:Perst.FieldIndex.Set(Perst.IPersistent)">
            <summary>
            Associate new object with the key specified by object field value. 
            If there is already object with such key in the index, 
            then it will be removed from the index and new value associated with this key.
            </summary>
            <param name="obj">object to be inserted in index. Object should contain indexed field. 
            Object can be not yet peristent, in this case
            its forced to become persistent by assigning OID to it.
            </param>
            <returns>object previously associated with this key, <code>null</code> if there was no such object
            </returns>
        </member>
        <member name="M:Perst.FieldIndex.Append(Perst.IPersistent)">
            <summary>
            Assign to the integer indexed field unique autoicremented value and 
            insert object in the index. 
            </summary>
            <param name="obj">object to be inserted in index. Object should contain indexed field
            of integer (<code>int</code> or <code>long</code>) type.
            This field is assigned unique value (which will not be reused while 
            this index exists) and object is marked as modified.
            Object can be not yet peristent, in this case
            its forced to become persistent by assigning OID to it.
            </param>
            <exception cref="T:Perst.StorageError"><code>StorageError(StorageError.ErrorCode.INCOMPATIBLE_KEY_TYPE)</code> 
            is thrown when indexed field has type other than <code>int</code> or <code>long</code></exception>
        </member>
        <member name="M:Perst.FieldIndex.Remove(Perst.IPersistent)">
            <summary> Remove object from the index
            </summary>
            <param name="obj">object removed from the index. Object should contain indexed field. 
            </param>
            <returns><code>true</code> if member was successfully removed or <code>false</code> if member is not found</returns>
        </member>
        <member name="M:Perst.FieldIndex.Remove(Perst.Key)">
            <summary> Remove object with specified key from the unique index.
            </summary>
            <param name="key">wrapper of removed key
            </param>
            <returns>removed object</returns>
            <exception cref="T:Perst.StorageError">StorageError(StorageError.ErrorCode.KEY_NOT_FOUND) exception if there is no such key in the index,
            or StorageError(StorageError.ErrorCode.KEY_NOT_UNIQUE) if index is not unique.
            
            </exception>
        </member>
        <member name="M:Perst.FieldIndex.Remove(System.Object)">
            <summary> Remove object with specified key from the unique index.
            </summary>
            <param name="key">value of removed key
            </param>
            <returns>removed object</returns>
            <exception cref="T:Perst.StorageError">StorageError(StorageError.ErrorCode.KEY_NOT_FOUND) exception if there is no such key in the index,
            or StorageError(StorageError.ErrorCode.KEY_NOT_UNIQUE) if index is not unique.
            
            </exception>
        </member>