perst.xml

Perst开源实时数据库

        </member>
        <member name="M:Perst.ITable.Select(System.Type,System.String)">
            <summary> Select members of the collection using search predicate
            </summary>
            <param name="cls">class of index members
            </param>
            <param name="predicate">JSQL condition
            </param>
            <returns> iterator through members of the collection matching search condition
            </returns>
        </member>
        <member name="T:Perst.Index">
            <summary> Interface of object index.
            Index is used to provide fast access to the object by key. 
            Object in the index are stored ordered by key value. 
            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, java.util.Date or peristent object type.
            </summary>
        </member>
        <member name="T:Perst.GenericIndex">
            <summary> Interface of object index.
            Index is used to provide fast access to the object by key. 
            Object in the index are stored ordered by key value. 
            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.GenericIndex.Get(Perst.Key)">
            <summary> Get object by key (exact match)     
            </summary>
            <param name="key">wrapper of the specified key. It should match with type of the index and should be inclusive.
            </param>
            <returns>object with this value of the key or <code>null</code> if key nmot found
            </returns>
            <exception cref="T:Perst.StorageError">StorageError(StorageError.ErrorCode.KEY_NOT_UNIQUE) exception if there are more than 
            one objects in the index with specified value of the key.
            
            </exception>
        </member>
        <member name="M:Perst.GenericIndex.Get(Perst.Key,Perst.Key)">
            <summary> Get objects which key value belongs to the specified range.
            Either from boundary, either till boundary either both of them can be <code>null</code>.
            In last case the method returns all objects from the index.
            </summary>
            <param name="from">low boundary. If <code>null</code> then low boundary is not specified.
            Low boundary can be inclusive or exclusive. 
            </param>
            <param name="till">high boundary. If <code>null</code> then high boundary is not specified.
            High boundary can be inclusive or exclusive. 
            </param>
            <returns>array of objects which keys belongs to the specified interval, ordered by key value
            
            </returns>
        </member>
        <member name="M:Perst.GenericIndex.GetPrefix(System.String)">
            <summary> Get objects which key starts with specifid prefix.
            </summary>
            <param name="prefix">String key prefix</param>
            <returns>array of objects which key starts with specifid prefix, ordered by key value 
            </returns>
        </member>
        <member name="M:Perst.GenericIndex.PrefixSearch(System.String)">
            <summary> 
            Locate all objects which key is prefix of specified word.
            </summary>
            <param name="word">string which prefixes are located in index</param>
            <returns>array of objects which key is prefix of specified word, ordered by key value
            </returns>
        </member>
        <member name="M:Perst.GenericIndex.Size">
            <summary> Get number of objects in the index
            </summary>
            <returns>number of objects in the index
            </returns>
        </member>
        <member name="M:Perst.GenericIndex.Clear">
            <summary> Remove all objects from the index
            </summary>
        </member>
        <member name="M:Perst.GenericIndex.ToArray">
            <summary> Get all objects in the index as array orderd by index key
            </summary>
            <returns>array of objects in the index ordered by key value
            </returns>
        </member>
        <member name="M:Perst.GenericIndex.ToArray(System.Type)">
            <summary> Get all objects in the index as array of specified type ordered by index key
            </summary>
            <param name="elemType">type of array element</param>
            <returns>array of objects in the index ordered by key value
            </returns>
        </member>
        <member name="M:Perst.GenericIndex.GetEnumerator(Perst.Key,Perst.Key)">
            <summary>
            Get enumerator for traversing objects in ascent order belonging to the specified range. 
            You should not update/remove or add members to the index during iteration
            </summary>
            <param name="from">Low boundary. If <code>null</code> then low boundary is not specified.
            Low boundary can be inclusive or exclusive.</param>
            <param name="till">High boundary. If <code>null</code> then high boundary is not specified.
            High boundary can be inclusive or exclusive.</param>
            <returns>selection enumerator</returns>
            
        </member>
        <member name="M:Perst.GenericIndex.GetEnumerator(Perst.Key,Perst.Key,Perst.IterationOrder)">
            <summary>
            Get enumerator for traversing 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">Low boundary. If <code>null</code> then low boundary is not specified.
            Low boundary can be inclusive or exclusive.</param>
            <param name="till">High boundary. If <code>null</code> then high boundary is not specified.
            High boundary can be inclusive or exclusive.</param>
            <param name="order"><code>IterationOrder.AscentOrder</code> or <code>IterationOrder.DescentOrder</code></param>
            <returns>selection enumerator</returns>
            
        </member>
        <member name="M:Perst.GenericIndex.GetEnumerator(System.String)">
            <summary>
            Get enumerator for traversing objects in ascent order which key starts with specified prefix. 
            You should not update/remove or add members to the index during iteration
            </summary>
            <param name="prefix">String key prefix</param>
            <returns>selection enumerator</returns>
            
        </member>
        <member name="M:Perst.GenericIndex.Range(Perst.Key,Perst.Key,Perst.IterationOrder)">
            <summary>
            Get enumerable 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">Low boundary. If <code>null</code> then low boundary is not specified.
            Low boundary can be inclusive or exclusive.</param>
            <param name="till">High boundary. If <code>null</code> then high boundary is not specified.
            High boundary can be inclusive or exclusive.</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(Perst.Key,Perst.Key)">
            <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">Low boundary. If <code>null</code> then low boundary is not specified.
            Low boundary can be inclusive or exclusive.</param>
            <param name="till">High boundary. If <code>null</code> then high boundary is not specified.
            High boundary can be inclusive or exclusive.</param>
            <returns>enumerable collection</returns>
            
        </member>
        <member name="M:Perst.GenericIndex.Reverse">
            <summary>
            Get enumerable collection of objects in descending order
            </summary>
            <returns>enumerable collection</returns>
            
        </member>
        <member name="M:Perst.GenericIndex.StartsWith(System.String)">
            <summary>
            Get enumerable ascent ordered collection of objects in the index which key starts with specified prefix. 
            You should not update/remove or add members to the index during iteration
            </summary>
            <param name="prefix">String key prefix</param>
            <returns>enumerable collection</returns>
            
        </member>
        <member name="M:Perst.GenericIndex.GetDictionaryEnumerator">
            <summary>
            Get enumerator for traversing all entries in the index 
            You should not update/remove or add members to the index during iteration
            </summary>
            <returns>entry enumerator</returns>
            
        </member>
        <member name="M:Perst.GenericIndex.GetDictionaryEnumerator(Perst.Key,Perst.Key,Perst.IterationOrder)">
            <summary>
            Get enumerator for traversing entries 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">Low boundary. If <code>null</code> then low boundary is not specified.
            Low boundary can be inclusive or exclusive.</param>
            <param name="till">High boundary. If <code>null</code> then high boundary is not specified.
            High boundary can be inclusive or exclusive.</param>
            <param name="order"><code>AscanrOrder</code> or <code>DescentOrder</code></param>
            <returns>selection enumerator</returns>
            
        </member>
        <member name="M:Perst.GenericIndex.Get(System.Object)">
            <summary> Get object by key (exact match)     
            </summary>
            <param name="key">specified key value. It should match with type of the index and should be inclusive.
            </param>
            <returns>object with this value of the key or <code>null</code> if key nmot found
            </returns>
            <exception cref="T:Perst.StorageError">StorageError(StorageError.ErrorCode.KEY_NOT_UNIQUE) exception if there are more than 
            one objects in the index with specified value of the key.
            
            </exception>
        </member>
        <member name="M:Perst.GenericIndex.Get(System.Object,System.Object)">
            <summary> Get objects which key value belongs to the specified inclusive range.
            Either from boundary, either till boundary either both of them can be <code>null</code>.
            In last case the method returns all objects from the index.
            </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>array of objects which keys belongs to the specified interval, ordered by key value
            
            </returns>
        </member>
        <member name="M:Perst.GenericIndex.GetEnumerator(System.Object,System.Object,Perst.IterationOrder)">
            <summary>
            Get enumerator for traversing 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">Low boundary. If <code>null</code> then low boundary is not specified.
            Low boundary can be inclusive or exclusive.</param>
            <param name="till">High boundary. If <code>null</code> then high boundary is not specified.
            High boundary can be inclusive or exclusive.</param>
            <param name="order"><code>IterationOrder.AscentOrder</code> or <code>IterationOrder.DescentOrder</code></param>
            <returns>selection enumerator</returns>
            
        </member>
        <member name="M:Perst.GenericIndex.GetEnumerator(System.Object,System.Object)">
            <summary>
            Get enumerator for traversing objects in ascent order belonging to the specified range. 
            You should not update/remove or add members to the index during iteration
            </summary>
            <param name="from">Low boundary. If <code>null</code> then low boundary is not specified.
            Low boundary can be inclusive or exclusive.</param>
            <param name="till">High boundary. If <code>null</code> then high boundary is not specified.
            High boundary can be inclusive or exclusive.</param>
            <returns>selection enumerator</returns>
            
        </member>
        <member name="M:Perst.GenericIndex.Range(System.Object,System.Object,Perst.IterationOrder)">
            <summary>
            Get enumerable 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>