You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1106 lines
65 KiB
1106 lines
65 KiB
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>GBase</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:GBase.Attributes.GBaseColumnAttribute">
|
|
<summary>
|
|
Tags a property as an <see cref="T:GBase.Interfaces.IGBaseColumn"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.Attributes.GBaseTableAttribute">
|
|
<summary>
|
|
Tags a class as a <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.DataHandling.Cache.Factories.IXmlDataHandlerCacheEntryFactory">
|
|
<summary>
|
|
Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.Cache.Factories.IXmlDataHandlerCacheEntryFactory.Create(System.Type,System.String,System.Object)">
|
|
<summary>
|
|
Create an <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/>
|
|
</summary>
|
|
<param name="type">The <see cref="T:System.Type"/> that implements the property</param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value of the property</param>
|
|
<returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/></returns>
|
|
</member>
|
|
<member name="T:GBase.DataHandling.Cache.Factories.IXmlDataHandlerCacheFactory">
|
|
<summary>
|
|
Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.Cache.Factories.IXmlDataHandlerCacheFactory.Create(GBase.Interfaces.DataHandling.Xml.IXmlDataReader)">
|
|
<summary>
|
|
Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/>
|
|
</summary>
|
|
<param name="xmlDataReader">The <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/></param>
|
|
<returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/></returns>
|
|
</member>
|
|
<member name="T:GBase.DataHandling.Cache.Factories.IXmlDataHandlerCachePropertyEntryFactory">
|
|
<summary>
|
|
Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCachePropertyEntry"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.Cache.Factories.IXmlDataHandlerCachePropertyEntryFactory.Create(System.String,System.Object)">
|
|
<summary>
|
|
Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCachePropertyEntry"/>
|
|
</summary>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value of the property</param>
|
|
<returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCachePropertyEntry"/></returns>
|
|
</member>
|
|
<member name="T:GBase.DataHandling.Cache.XmlDataHandlerCache">
|
|
<summary>
|
|
An interface for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.Cache.XmlDataHandlerCache.#ctor(GBase.Interfaces.DataHandling.Xml.IXmlDataReader,GBase.DataHandling.Cache.Factories.IXmlDataHandlerCacheEntryFactory,GBase.DataHandling.Cache.Factories.IXmlDataHandlerCachePropertyEntryFactory)">
|
|
<summary>
|
|
An interface for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/>
|
|
</summary>
|
|
<param name="xmlDataReader">The <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/></param>
|
|
<param name="xmlDataHandlerCacheEntryFactory">A factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/></param>
|
|
<param name="xmlDataHandlerCachePropertyEntryFactory">A factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCachePropertyEntry"/></param>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.Cache.XmlDataHandlerCache.SetValue``2(System.String,``1,System.Boolean)">
|
|
<summary>
|
|
Set the value for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value to set</param>
|
|
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.Cache.XmlDataHandlerCache.TryRemoveValue``2(System.String,``1)">
|
|
<summary>
|
|
Remove the value for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value to set</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.Cache.XmlDataHandlerCache.TryGetValues``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Try to get values from the cache for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns>
|
|
</member>
|
|
<member name="T:GBase.DataHandling.Cache.XmlDataHandlerCacheEntry">
|
|
<summary>
|
|
Entry for the <see cref="T:GBase.Interfaces.DataHandling.Cache.IDataHandlerCache"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.Cache.XmlDataHandlerCacheEntry.#ctor(System.Type,System.String,System.Object,GBase.DataHandling.Cache.Factories.IXmlDataHandlerCachePropertyEntryFactory)">
|
|
<summary>
|
|
Entry for the <see cref="T:GBase.Interfaces.DataHandling.Cache.IDataHandlerCache"/>
|
|
</summary>
|
|
<param name="type">The <see cref="P:GBase.DataHandling.Cache.XmlDataHandlerCacheEntry.Type"/> that implements the property</param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value of the property</param>
|
|
<param name="xmlDataHandlerCachePropertyEntryFactory">Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCachePropertyEntry"/></param>
|
|
</member>
|
|
<member name="P:GBase.DataHandling.Cache.XmlDataHandlerCacheEntry.Type">
|
|
<summary>
|
|
The <see cref="P:GBase.DataHandling.Cache.XmlDataHandlerCacheEntry.Type"/> of the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.DataHandling.Cache.XmlDataHandlerCacheEntry.Properties">
|
|
<summary>
|
|
The properties of the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.DataHandling.Cache.XmlDataHandlerCachePropertyEntry">
|
|
<summary>
|
|
A property entry for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.Cache.XmlDataHandlerCachePropertyEntry.#ctor(System.String,System.Object)">
|
|
<summary>
|
|
A property entry for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/>
|
|
</summary>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value of the property</param>
|
|
</member>
|
|
<member name="P:GBase.DataHandling.Cache.XmlDataHandlerCachePropertyEntry.PropertyName">
|
|
<summary>
|
|
The name of the property
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.DataHandling.Cache.XmlDataHandlerCachePropertyEntry.IsInitialized">
|
|
<summary>
|
|
This property is initialized in the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.DataHandling.Cache.XmlDataHandlerCachePropertyEntry.Values">
|
|
<summary>
|
|
The values of the property
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.DataHandling.Factories.IXmlDataHandlerFactory">
|
|
<summary>
|
|
Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataHandler"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.Factories.IXmlDataHandlerFactory.Create">
|
|
<summary>
|
|
Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataHandler"/>
|
|
</summary>
|
|
<returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataHandler"/></returns>
|
|
</member>
|
|
<member name="T:GBase.DataHandling.Factories.IXmlDataReaderFactory">
|
|
<summary>
|
|
Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.Factories.IXmlDataReaderFactory.Create">
|
|
<summary>
|
|
Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/>
|
|
</summary>
|
|
<returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/></returns>
|
|
</member>
|
|
<member name="T:GBase.DataHandling.Factories.IXmlDataWriterFactory">
|
|
<summary>
|
|
Factory for the <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.Factories.IXmlDataWriterFactory.Create">
|
|
<summary>
|
|
Creates an <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/>
|
|
</summary>
|
|
<returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/></returns>
|
|
</member>
|
|
<member name="T:GBase.DataHandling.XmlDataHandler">
|
|
<summary>
|
|
A <see cref="T:GBase.Interfaces.DataHandling.IDataHandler"/> that handles its data in an xml file
|
|
</summary>
|
|
</member>
|
|
<member name="F:GBase.DataHandling.XmlDataHandler.VALUE_ELEMENT_NAME">
|
|
<summary>
|
|
The element name of the value element
|
|
</summary>
|
|
</member>
|
|
<member name="F:GBase.DataHandling.XmlDataHandler.VALUE_TYPE_ATTRIBUTE_NAME">
|
|
<summary>
|
|
The attribute name of the value <see cref="T:System.Type"/> attribute
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.XmlDataHandler.#ctor(GBase.DataHandling.Factories.IXmlDataReaderFactory,GBase.DataHandling.Factories.IXmlDataWriterFactory,GBase.DataHandling.Cache.Factories.IXmlDataHandlerCacheFactory)">
|
|
<summary>
|
|
A <see cref="T:GBase.Interfaces.DataHandling.IDataHandler"/> that handles its data in an xml file
|
|
</summary>
|
|
<param name="path">The path to the xml file</param>
|
|
<param name="xmlDataReaderFactory">The <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader"/> factory</param>
|
|
<param name="xmlDataWriterFactory">The <see cref="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter"/> factory</param>
|
|
<param name="xmlDataHandlerCacheFactory">The <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/> factory</param>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.XmlDataHandler.Init(System.Boolean)">
|
|
<summary>
|
|
Initialize the <see cref="T:GBase.DataHandling.XmlDataHandler"/>
|
|
</summary>
|
|
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
|
|
<returns>Returns true if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.XmlDataHandler.SetValue``2(System.IO.FileStream,System.String,``1,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Set the value for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="entryFile"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value to set</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.XmlDataHandler.RemoveValue``2(System.IO.FileStream,System.String,``1,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Remove the value for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="entryFile"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value to set</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.XmlDataHandler.GetValue``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Get the value for the given property, if multiple values are set the first is returned
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>The value for the given property</returns>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.XmlDataHandler.GetValues``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Get all the values that are set for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns>
|
|
</member>
|
|
<member name="T:GBase.DataHandling.XmlDataReader">
|
|
<summary>
|
|
A <see cref="T:GBase.Interfaces.DataHandling.IDataReader"/> that reads from a xml file
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.XmlDataReader.Read``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Read the data of a property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/></typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>The data of the given property, null if no data found</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="propertyName"/></exception>
|
|
<exception cref="T:System.InvalidOperationException">Invalid <see cref="T:System.Type"/> found for the read object</exception>
|
|
</member>
|
|
<member name="T:GBase.DataHandling.XmlDataWriter">
|
|
<summary>
|
|
A <see cref="T:GBase.Interfaces.DataHandling.IDataWriter"/> that writes to a xml file
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.XmlDataWriter.InitFile(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Initialize the <see cref="T:GBase.DataHandling.XmlDataWriter"/>
|
|
</summary>
|
|
<param name="file"></param>
|
|
<param name="rootElementName"></param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the async operation</param>
|
|
<returns>Returns true if successful, false if not</returns>
|
|
<exception cref="T:System.Exception">No root element found</exception>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.XmlDataWriter.Write``2(System.IO.FileStream,System.String,System.String,System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Write the data of a property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/></typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value of the property</param>
|
|
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.XmlDataWriter.Write``1(System.IO.FileStream,System.String,System.String,System.Type,System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Write the data of a property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value of the property</param>
|
|
<param name="propertyType"></param>
|
|
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="propertyName"/></exception>
|
|
<exception cref="T:GBase.DataHandling.Exceptions.InvalidXmlFileException">No root element is set</exception>
|
|
</member>
|
|
<member name="M:GBase.DataHandling.XmlDataWriter.Remove``2(System.IO.FileStream,System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Remove the value for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value to set</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="propertyName"/></exception>
|
|
<exception cref="T:GBase.DataHandling.Exceptions.InvalidXmlFileException">No root element is set</exception>
|
|
</member>
|
|
<member name="T:GBase.Exceptions.GenericMethodNotFoundException">
|
|
<summary>
|
|
Could not find generic method
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Exceptions.GenericMethodNotFoundException.#ctor(System.String)">
|
|
<summary>
|
|
Could not find generic method
|
|
</summary>
|
|
<param name="functionName">The name of the generic method</param>
|
|
</member>
|
|
<member name="T:GBase.Exceptions.InterfaceEnumerablePassedException">
|
|
<summary>
|
|
<see cref="T:System.Exception"/> that an interface was passed as the generic type of an <see cref="T:System.Collections.Generic.IEnumerable`1"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Exceptions.InterfaceEnumerablePassedException.#ctor(System.Type)">
|
|
<summary>
|
|
<see cref="T:System.Exception"/> that an interface was passed as the generic type of an <see cref="T:System.Collections.Generic.IEnumerable`1"/>
|
|
</summary>
|
|
<param name="interfaceType"></param>
|
|
</member>
|
|
<member name="P:GBase.Exceptions.InterfaceEnumerablePassedException.InterfaceType">
|
|
<summary>
|
|
The <see cref="T:System.Type"/> of the passed interface
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.Exceptions.InvalidTableTypeException">
|
|
<summary>
|
|
<see cref="T:System.Exception"/> that the passed table type doesn't implement <see cref="T:GBase.Api.INotifyGBaseEntryChanged"/>"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Exceptions.InvalidTableTypeException.#ctor(System.Type)">
|
|
<summary>
|
|
<see cref="T:System.Exception"/> that the passed table type doesn't implement <see cref="T:GBase.Api.INotifyGBaseEntryChanged"/>"/>
|
|
</summary>
|
|
<param name="type">The table type</param>
|
|
</member>
|
|
<member name="T:GBase.Exceptions.MissingTableException`1">
|
|
<summary>
|
|
<see cref="T:System.Exception"/> that the table for the given <see cref="T:System.Type"/> is missing
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Exceptions.MissingTableException`1.#ctor">
|
|
<summary>
|
|
<see cref="T:System.Exception"/> that the table for the given <see cref="T:System.Type"/> is missing
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.Factories.GBaseTableFactory">
|
|
<summary>
|
|
Factory for the <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Factories.GBaseTableFactory.#ctor(GBase.FileHandling.Factories.IFileHandlerFactory,GBase.Interfaces.DataHandling.Pool.IDataHandlerPool,GBase.Factories.IGBaseColumnFactory)">
|
|
<summary>
|
|
Factory for the <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
<param name="fileHandlerFactory">Factory for the <see cref="T:GBase.Interfaces.FileHandling.IFileHandler"/></param>
|
|
<param name="dataHandlerPool"></param>
|
|
<param name="gBaseColumnFactory">Factory for the <see cref="T:GBase.Interfaces.IGBaseColumn"/></param>
|
|
</member>
|
|
<member name="M:GBase.Factories.GBaseTableFactory.Create(System.Type)">
|
|
<summary>
|
|
Creates an <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
<returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.IGBaseTable"/></returns>
|
|
</member>
|
|
<member name="T:GBase.Factories.IGBaseColumnFactory">
|
|
<summary>
|
|
Factory for the <see cref="T:GBase.Interfaces.IGBaseColumn"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Factories.IGBaseColumnFactory.Create(System.String,System.Type)">
|
|
<summary>
|
|
Creates an <see cref="T:GBase.Interfaces.IGBaseColumn"/>
|
|
</summary>
|
|
<returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.IGBaseColumn"/></returns>
|
|
</member>
|
|
<member name="T:GBase.Factories.IGBaseFactory">
|
|
<summary>
|
|
Factory for the <see cref="T:GBase.Interfaces.IGBase"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Factories.IGBaseFactory.Create(GBase.Interfaces.Settings.IGBaseSettings)">
|
|
<summary>
|
|
Creates an <see cref="T:GBase.Interfaces.IGBase"/>
|
|
</summary>
|
|
<param name="settings">The <see cref="T:GBase.Interfaces.Settings.IGBaseSettings"/> for this <see cref="T:GBase.Interfaces.IGBase"/></param>
|
|
<returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.IGBase"/></returns>
|
|
</member>
|
|
<member name="T:GBase.Factories.IGBaseTableFactory">
|
|
<summary>
|
|
Factory for the <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Factories.IGBaseTableFactory.Create(System.Type)">
|
|
<summary>
|
|
Creates an <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
<returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.IGBaseTable"/></returns>
|
|
</member>
|
|
<member name="T:GBase.FileHandling.Factories.IFileHandlerFactory">
|
|
<summary>
|
|
Factory for the <see cref="T:GBase.Interfaces.FileHandling.IFileHandler"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.FileHandling.Factories.IFileHandlerFactory.Create">
|
|
<summary>
|
|
Creates an <see cref="T:GBase.Interfaces.FileHandling.IFileHandler"/>
|
|
</summary>
|
|
<returns>A newly created instance of the implementation for <see cref="T:GBase.Interfaces.FileHandling.IFileHandler"/></returns>
|
|
</member>
|
|
<member name="T:GBase.FileHandling.FileHandler">
|
|
<summary>
|
|
Internal file handler
|
|
</summary>
|
|
</member>
|
|
<member name="F:GBase.FileHandling.FileHandler.GBASE_TABLE_FILE_EXTENSION">
|
|
<summary>
|
|
The file extension for all GBase tables
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.FileHandling.FileHandler.#ctor">
|
|
<summary>
|
|
Internal file handler
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.FileHandling.FileHandler.Init(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Initialize this <see cref="T:GBase.Interfaces.FileHandling.IFileHandler"/>
|
|
</summary>
|
|
<param name="path">The path of the database</param>
|
|
<param name="folderName"></param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the asynchronous operation</param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.FileHandling.FileHandler.DisposeAsync">
|
|
<summary>
|
|
Dispose used resources asynchronously
|
|
</summary>
|
|
<returns>A <see cref="T:System.Threading.Tasks.ValueTask"/> to await</returns>
|
|
</member>
|
|
<member name="T:GBase.GBase">
|
|
<summary>
|
|
The base class of the GBase database
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.GBase.#ctor(GBase.Interfaces.Settings.IGBaseSettings,GBase.Factories.IGBaseTableFactory)">
|
|
<summary>
|
|
The base class of the GBase database
|
|
</summary>
|
|
<param name="settings">The <see cref="T:GBase.Interfaces.Settings.IGBaseSettings"/> for this <see cref="T:GBase.GBase"/></param>
|
|
<param name="gBaseTableFactory">Factory for the <see cref="T:GBase.Interfaces.IGBaseTable"/></param>
|
|
</member>
|
|
<member name="P:GBase.GBase.Name">
|
|
<summary>
|
|
The name of this <see cref="T:GBase.GBase"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.GBase.Settings">
|
|
<summary>
|
|
The settings of this <see cref="T:GBase.GBase"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.GBase.Tables">
|
|
<summary>
|
|
The <see cref="T:GBase.Interfaces.IGBaseTable"/>s of this <see cref="T:GBase.GBase"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.GBase.Init(System.String,System.Reflection.Assembly,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Initialize this <see cref="T:GBase.GBase"/>
|
|
</summary>
|
|
<param name="name">The name of this <see cref="T:GBase.GBase"/></param>
|
|
<param name="databaseAssembly">The <see cref="T:System.Reflection.Assembly"/> of the database</param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the asynchronous operation</param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.GBase.AddTable(GBase.Interfaces.IGBaseTable)">
|
|
<summary>
|
|
Add a given <see cref="T:GBase.Interfaces.IGBaseTable"/> to this <see cref="T:GBase.GBase"/>
|
|
</summary>
|
|
<param name="table">The given <see cref="T:GBase.Interfaces.IGBaseTable"/></param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.GBase.RemoveTable(GBase.Interfaces.IGBaseTable)">
|
|
<summary>
|
|
Removes a given <see cref="T:GBase.Interfaces.IGBaseTable"/> from this <see cref="T:GBase.GBase"/>
|
|
</summary>
|
|
<param name="table">The given <see cref="T:GBase.Interfaces.IGBaseTable"/></param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.GBase.DisposeAsync">
|
|
<summary>
|
|
Dispose used resources asynchronously
|
|
</summary>
|
|
<returns>A <see cref="T:System.Threading.Tasks.ValueTask"/> to await</returns>
|
|
</member>
|
|
<member name="T:GBase.GBaseColumn">
|
|
<summary>
|
|
A column of a <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.GBaseColumn.#ctor(System.String,System.Type)">
|
|
<summary>
|
|
A column of a <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.GBaseColumn.DisposeAsync">
|
|
<summary>
|
|
The <see cref="M:System.IAsyncDisposable.DisposeAsync"/> method
|
|
</summary>
|
|
<returns>A <see cref="T:System.Threading.Tasks.ValueTask"/> to await</returns>
|
|
</member>
|
|
<member name="T:GBase.GBaseObject`1">
|
|
<summary>
|
|
GBase object that supplies inheriting classes with methods to get data from a <see cref="T:GBase.Interfaces.IGBase"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.GBaseObject`1.#ctor(GBase.Interfaces.IGBase)">
|
|
<summary>
|
|
GBase object that allows conversion from <see cref="T:System.String"/>
|
|
</summary>
|
|
<exception cref="T:GBase.Exceptions.MissingTableException`1">No table for <typeparamref name="T"/> is existing</exception>
|
|
</member>
|
|
<member name="M:GBase.GBaseObject`1.InitializeFromString(System.String)">
|
|
<summary>
|
|
Initialize this <see cref="T:GBase.GBaseObject`1"/> from a given <see cref="T:System.String"/>
|
|
</summary>
|
|
<param name="string">The given <see cref="T:System.String"/></param>
|
|
</member>
|
|
<member name="T:GBase.GBaseTable`1">
|
|
<summary>
|
|
A <see cref="T:GBase.Interfaces.IGBase"/> table
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.GBaseTable`1.#ctor(GBase.FileHandling.Factories.IFileHandlerFactory,GBase.Interfaces.DataHandling.Pool.IDataHandlerPool,GBase.Factories.IGBaseColumnFactory)">
|
|
<summary>
|
|
A <see cref="T:GBase.Interfaces.IGBase"/> table
|
|
</summary>
|
|
<param name="fileHandlerFactory"></param>
|
|
<param name="dataHandlerPool">The <see cref="T:GBase.Interfaces.DataHandling.Pool.IDataHandlerPool"/></param>
|
|
<param name="gBaseColumnFactory"></param>
|
|
</member>
|
|
<member name="P:GBase.GBaseTable`1.Type">
|
|
<summary>
|
|
The <see cref="T:System.Type"/> of the class that this <see cref="T:GBase.Interfaces.IGBaseTable"/> represents
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.GBaseTable`1.FolderName">
|
|
<summary>
|
|
The name of this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.GBaseTable`1.Columns">
|
|
<summary>
|
|
The <see cref="T:GBase.Interfaces.IGBaseColumn"/>s of this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.GBaseTable`1.Entries">
|
|
<summary>
|
|
The entries of this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.GBaseTable`1.Init(System.Type,System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Initialize this <see cref="T:GBase.Interfaces.IGBase"/>
|
|
</summary>
|
|
<param name="type">The <see cref="T:System.Type"/> of the class that this <see cref="T:GBase.Interfaces.IGBaseTable"/> represents</param>
|
|
<param name="databasePath">The path to the database files</param>
|
|
<param name="folderName"></param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the asynchronous operation</param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.GBaseTable`1.AddColumn(GBase.Interfaces.IGBaseColumn)">
|
|
<summary>
|
|
Add a given <see cref="T:GBase.Interfaces.IGBaseColumn"/> to this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
<param name="column">The given <see cref="T:GBase.Interfaces.IGBaseColumn"/></param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.GBaseTable`1.RemoveColumn(GBase.Interfaces.IGBaseColumn)">
|
|
<summary>
|
|
Remove a given <see cref="T:GBase.Interfaces.IGBaseColumn"/> from this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
<param name="column">The given <see cref="T:GBase.Interfaces.IGBaseColumn"/></param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.GBaseTable`1.AddEntry(`0,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Add an entry that implements <see cref="T:GBase.Api.INotifyGBaseEntryChanged"/> to this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
<param name="entry">The entry implementing <see cref="T:GBase.Api.INotifyGBaseEntryChanged"/></param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.GBaseTable`1.RemoveEntry(`0)">
|
|
<summary>
|
|
Remove an entry that implements <see cref="T:GBase.Api.INotifyGBaseEntryChanged"/> from this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
<param name="entry">The entry implementing <see cref="T:GBase.Api.INotifyGBaseEntryChanged"/></param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.GBaseTable`1.DisposeAsync">
|
|
<summary>
|
|
The <see cref="M:System.IAsyncDisposable.DisposeAsync"/> method
|
|
</summary>
|
|
<returns>A <see cref="T:System.Threading.Tasks.ValueTask"/> to await</returns>
|
|
</member>
|
|
<member name="M:GBase.Helpers.Enumerables.ToGBaseString(System.Collections.IEnumerable)">
|
|
<summary>
|
|
Convert an <see cref="T:System.Collections.IEnumerable"/> to a GBase <see cref="T:System.String"/>
|
|
</summary>
|
|
<param name="enumerable">The <see cref="T:System.Collections.IEnumerable"/></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:GBase.Helpers.Enumerables.ConvertToGBaseEnumerable``1(System.String)">
|
|
<summary>
|
|
Convert a given <see cref="T:System.String"/> to an <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:System.Type"/> <typeparamref name="TEnumerable"/>
|
|
</summary>
|
|
<typeparam name="TEnumerable">The <see cref="T:System.Collections.Generic.IEnumerable`1"/> <see cref="T:System.Type"/></typeparam>
|
|
<param name="string">The given <see cref="T:System.String"/></param>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:System.Type"/> <typeparamref name="TEnumerable"/></returns>
|
|
<exception cref="T:GBase.Exceptions.InterfaceEnumerablePassedException">Interface was passed to an <see cref="T:System.Collections.Generic.IEnumerable`1"/></exception>
|
|
</member>
|
|
<member name="M:GBase.Helpers.GenericMethodCaller.Call(System.Object,System.String,System.Reflection.BindingFlags,System.Type,System.Object[])">
|
|
<summary>
|
|
Call a generic method without generic type parameters
|
|
</summary>
|
|
<param name="caller">The caller of the method</param>
|
|
<param name="functionName">The name of the method to call</param>
|
|
<param name="bindingFlags">The <see cref="T:System.Reflection.BindingFlags"/> to find the method</param>
|
|
<param name="genericParameter">The generic parameter as <see cref="T:System.Type"/> parameter</param>
|
|
<param name="parameters">The parameters of the method</param>
|
|
<returns>The result of invoking the method</returns>
|
|
<exception cref="T:GBase.Exceptions.GenericMethodNotFoundException">Could not find the generic method</exception>
|
|
<exception cref="T:System.Exception">Any <see cref="T:System.Exception"/> thrown after invoking the generic method</exception>
|
|
</member>
|
|
<member name="M:GBase.Helpers.GenericMethodCaller.Call(System.Object,System.String,System.Reflection.BindingFlags,System.Type,System.Type,System.Object[])">
|
|
<summary>
|
|
Call a generic method without generic type parameters
|
|
</summary>
|
|
<param name="caller">The caller of the method</param>
|
|
<param name="functionName">The name of the method to call</param>
|
|
<param name="bindingFlags">The <see cref="T:System.Reflection.BindingFlags"/> to find the method</param>
|
|
<param name="genericParameter">The generic parameter as <see cref="T:System.Type"/> parameter</param>
|
|
<param name="secondGenericParameter"></param>
|
|
<param name="parameters">The parameters of the method</param>
|
|
<returns>The result of invoking the method</returns>
|
|
<exception cref="T:GBase.Exceptions.GenericMethodNotFoundException">Could not find the generic method</exception>
|
|
<exception cref="T:System.Exception">Any <see cref="T:System.Exception"/> thrown after invoking the generic method</exception>
|
|
</member>
|
|
<member name="M:GBase.Helpers.GenericMethodCaller.CallAsync(System.Object,System.String,System.Reflection.BindingFlags,System.Type,System.Object[])">
|
|
<summary>
|
|
Call a generic method asynchronously without generic type parameters
|
|
</summary>
|
|
<param name="caller">The caller of the method</param>
|
|
<param name="functionName">The name of the method to call</param>
|
|
<param name="bindingFlags">The <see cref="T:System.Reflection.BindingFlags"/> to find the method</param>
|
|
<param name="genericParameter">The generic parameter as <see cref="T:System.Type"/> parameter</param>
|
|
<param name="parameters">The parameters of the method</param>
|
|
<returns>The result of invoking the method</returns>
|
|
<exception cref="T:GBase.Exceptions.GenericMethodNotFoundException">Could not find the generic method</exception>
|
|
<exception cref="T:System.Exception">Any <see cref="T:System.Exception"/> thrown after invoking the generic method</exception>
|
|
</member>
|
|
<member name="M:GBase.Helpers.GenericMethodCaller.CallAsync(System.Object,System.String,System.Reflection.BindingFlags,System.Type,System.Type,System.Object[])">
|
|
<summary>
|
|
Call a generic method asynchronously without generic type parameters
|
|
</summary>
|
|
<param name="caller">The caller of the method</param>
|
|
<param name="functionName">The name of the method to call</param>
|
|
<param name="bindingFlags">The <see cref="T:System.Reflection.BindingFlags"/> to find the method</param>
|
|
<param name="genericParameter">The generic parameter as <see cref="T:System.Type"/> parameter</param>
|
|
<param name="secondGenericParameter"></param>
|
|
<param name="parameters">The parameters of the method</param>
|
|
<returns>The result of invoking the method</returns>
|
|
<exception cref="T:GBase.Exceptions.GenericMethodNotFoundException">Could not find the generic method</exception>
|
|
<exception cref="T:System.Exception">Any <see cref="T:System.Exception"/> thrown after invoking the generic method</exception>
|
|
</member>
|
|
<member name="T:GBase.Installers.DataHandlingInstaller">
|
|
<summary>
|
|
<see cref="T:LightweightIocContainer.Interfaces.Installers.IIocInstaller"/> for the data handling
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Installers.DataHandlingInstaller.Install(LightweightIocContainer.Interfaces.IIocContainer)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:GBase.Installers.FileHandlingInstaller">
|
|
<summary>
|
|
<see cref="T:LightweightIocContainer.Interfaces.Installers.IIocInstaller"/> for the file handling
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Installers.FileHandlingInstaller.Install(LightweightIocContainer.Interfaces.IIocContainer)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:GBase.Installers.GBaseInstaller">
|
|
<summary>
|
|
<see cref="T:LightweightIocContainer.Interfaces.Installers.IIocInstaller"/> for the GBase
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Installers.GBaseInstaller.Install(LightweightIocContainer.Interfaces.IIocContainer)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:GBase.Interfaces.DataHandling.Cache.IDataHandlerCache">
|
|
<summary>
|
|
An interface for the <see cref="T:GBase.Interfaces.DataHandling.Cache.IDataHandlerCache"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.DataHandling.Cache.IDataHandlerCache.SetValue``2(System.String,``1,System.Boolean)">
|
|
<summary>
|
|
Set the value for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value to set</param>
|
|
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.DataHandling.Cache.IDataHandlerCache.TryRemoveValue``2(System.String,``1)">
|
|
<summary>
|
|
Remove the value for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value to set</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.DataHandling.Cache.IDataHandlerCache.TryGetValues``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Try to get values from the cache for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> that implements the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.DataHandling.Cache.IDataHandlerCacheEntry">
|
|
<summary>
|
|
Entry for the <see cref="T:GBase.Interfaces.DataHandling.Cache.IDataHandlerCache"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.Interfaces.DataHandling.Cache.IDataHandlerCacheEntry.Type">
|
|
<summary>
|
|
The <see cref="P:GBase.Interfaces.DataHandling.Cache.IDataHandlerCacheEntry.Type"/> of the <see cref="T:GBase.Interfaces.DataHandling.Cache.IDataHandlerCacheEntry"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.Interfaces.DataHandling.Cache.IDataHandlerCacheEntry.Properties">
|
|
<summary>
|
|
The properties of the <see cref="T:GBase.Interfaces.DataHandling.Cache.IDataHandlerCacheEntry"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.DataHandling.Cache.IDataHandlerCachePropertyEntry">
|
|
<summary>
|
|
A property entry for the <see cref="T:GBase.Interfaces.DataHandling.Cache.IDataHandlerCacheEntry"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.Interfaces.DataHandling.Cache.IDataHandlerCachePropertyEntry.PropertyName">
|
|
<summary>
|
|
The name of the property
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.Interfaces.DataHandling.Cache.IDataHandlerCachePropertyEntry.IsInitialized">
|
|
<summary>
|
|
This property is initialized in the <see cref="T:GBase.Interfaces.DataHandling.Cache.IDataHandlerCache"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.Interfaces.DataHandling.Cache.IDataHandlerCachePropertyEntry.Values">
|
|
<summary>
|
|
The values of the property
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.DataHandling.IDataHandler">
|
|
<summary>
|
|
Interface for data handlers to implement
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.DataHandling.IDataHandler.Init(System.Boolean)">
|
|
<summary>
|
|
Initialize the <see cref="T:GBase.Interfaces.DataHandling.IDataHandler"/>
|
|
</summary>
|
|
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
|
|
<returns>Returns true if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.DataHandling.IDataHandler.SetValue``2(System.IO.FileStream,System.String,``1,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Set the value for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="entryFile"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value to set</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.DataHandling.IDataHandler.RemoveValue``2(System.IO.FileStream,System.String,``1,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Remove the value for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="entryFile"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value to set</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.DataHandling.IDataHandler.GetValue``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Get the value for the given property, if multiple values are set the first is returned
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>The value for the given property</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.DataHandling.IDataHandler.GetValues``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Get all the values that are set for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> with all the values for the property</returns>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.DataHandling.IDataReader">
|
|
<summary>
|
|
Interface for data readers to implement
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.DataHandling.IDataReader.Read``2(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Read the data of a property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/></typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>The data of the given property, null if no data found</returns>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.DataHandling.IDataWriter">
|
|
<summary>
|
|
Interface for data writers to implement
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.DataHandling.IDataWriter.InitFile(System.IO.FileStream,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Initialize the <see cref="T:GBase.Interfaces.DataHandling.IDataWriter"/>
|
|
</summary>
|
|
<param name="file"></param>
|
|
<param name="rootElementName"></param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the async operation</param>
|
|
<returns>Returns true if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.DataHandling.IDataWriter.Write``2(System.IO.FileStream,System.String,System.String,System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Write the data of a property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/></typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value of the property</param>
|
|
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.DataHandling.IDataWriter.Write``1(System.IO.FileStream,System.String,System.String,System.Type,System.Boolean,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Write the data of a property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/></typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value of the property</param>
|
|
<param name="propertyType"></param>
|
|
<param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.DataHandling.IDataWriter.Remove``2(System.IO.FileStream,System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Remove the value for the given property
|
|
</summary>
|
|
<typeparam name="T">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<typeparam name="TProperty">The <see cref="T:System.Type"/> of the property</typeparam>
|
|
<param name="file"></param>
|
|
<param name="propertyName">The name of the property</param>
|
|
<param name="value">The value to set</param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task"/> to await</returns>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache">
|
|
<summary>
|
|
An interface for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry">
|
|
<summary>
|
|
Entry for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCache"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCachePropertyEntry">
|
|
<summary>
|
|
A property entry for the <see cref="T:GBase.Interfaces.DataHandling.Xml.Cache.IXmlDataHandlerCacheEntry"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.DataHandling.Xml.IXmlDataHandler">
|
|
<summary>
|
|
A <see cref="T:GBase.Interfaces.DataHandling.IDataHandler"/> that handles its data in an xml file
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.DataHandling.Xml.IXmlDataReader">
|
|
<summary>
|
|
A <see cref="T:GBase.Interfaces.DataHandling.IDataReader"/> that writes to an xml file
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.DataHandling.Xml.IXmlDataWriter">
|
|
<summary>
|
|
An <see cref="T:GBase.Interfaces.DataHandling.IDataWriter"/> that writes to a xml file
|
|
</summary>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.FileHandling.IFileHandler">
|
|
<summary>
|
|
Internal file handler
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.FileHandling.IFileHandler.Init(System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Initialize this <see cref="T:GBase.Interfaces.FileHandling.IFileHandler"/>
|
|
</summary>
|
|
<param name="path">The path of the database</param>
|
|
<param name="folderName"></param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the asynchronous operation</param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.IGBase">
|
|
<summary>
|
|
The base class of the GBase database
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.Interfaces.IGBase.Name">
|
|
<summary>
|
|
The name of this <see cref="T:GBase.Interfaces.IGBase"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.Interfaces.IGBase.Settings">
|
|
<summary>
|
|
The settings of this <see cref="T:GBase.Interfaces.IGBase"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.Interfaces.IGBase.Tables">
|
|
<summary>
|
|
The <see cref="T:GBase.Interfaces.IGBaseTable"/>s of this <see cref="T:GBase.Interfaces.IGBase"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.IGBase.Init(System.String,System.Reflection.Assembly,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Initialize this <see cref="T:GBase.Interfaces.IGBase"/>
|
|
</summary>
|
|
<param name="name">The name of this <see cref="T:GBase.Interfaces.IGBase"/></param>
|
|
<param name="databaseAssembly">The <see cref="T:System.Reflection.Assembly"/> of the database</param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the asynchronous operation</param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.IGBase.AddTable(GBase.Interfaces.IGBaseTable)">
|
|
<summary>
|
|
Add a given <see cref="T:GBase.Interfaces.IGBaseTable"/> to this <see cref="T:GBase.Interfaces.IGBase"/>
|
|
</summary>
|
|
<param name="table">The given <see cref="T:GBase.Interfaces.IGBaseTable"/></param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.IGBase.RemoveTable(GBase.Interfaces.IGBaseTable)">
|
|
<summary>
|
|
Removes a given <see cref="T:GBase.Interfaces.IGBaseTable"/> from this <see cref="T:GBase.Interfaces.IGBase"/>
|
|
</summary>
|
|
<param name="table">The given <see cref="T:GBase.Interfaces.IGBaseTable"/></param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.IGBaseColumn">
|
|
<summary>
|
|
A column of a <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.Interfaces.IGBaseTable`1.Entries">
|
|
<summary>
|
|
The entries of this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.IGBaseTable`1.AddEntry(`0,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Add an entry that implements <see cref="T:GBase.Api.INotifyGBaseEntryChanged"/> to this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
<param name="entry">The entry implementing <see cref="T:GBase.Api.INotifyGBaseEntryChanged"/></param>
|
|
<param name="cancellationToken"></param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.IGBaseTable`1.RemoveEntry(`0)">
|
|
<summary>
|
|
Remove an entry that implements <see cref="T:GBase.Api.INotifyGBaseEntryChanged"/> from this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
<param name="entry">The entry implementing <see cref="T:GBase.Api.INotifyGBaseEntryChanged"/></param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.IGBaseTable">
|
|
<summary>
|
|
A <see cref="T:GBase.Interfaces.IGBase"/> table
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.Interfaces.IGBaseTable.Type">
|
|
<summary>
|
|
The <see cref="T:System.Type"/> of the class that this <see cref="T:GBase.Interfaces.IGBaseTable"/> represents
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.Interfaces.IGBaseTable.FolderName">
|
|
<summary>
|
|
The name of this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.Interfaces.IGBaseTable.Columns">
|
|
<summary>
|
|
The <see cref="T:GBase.Interfaces.IGBaseColumn"/>s of this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.IGBaseTable.Init(System.Type,System.String,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Initialize this <see cref="T:GBase.Interfaces.IGBase"/>
|
|
</summary>
|
|
<param name="type">The <see cref="T:System.Type"/> of the class that this <see cref="T:GBase.Interfaces.IGBaseTable"/> represents</param>
|
|
<param name="databasePath">The path to the database files</param>
|
|
<param name="folderName"></param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to cancel the asynchronous operation</param>
|
|
///
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.IGBaseTable.AddColumn(GBase.Interfaces.IGBaseColumn)">
|
|
<summary>
|
|
Add a given <see cref="T:GBase.Interfaces.IGBaseColumn"/> to this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
<param name="column">The given <see cref="T:GBase.Interfaces.IGBaseColumn"/></param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="M:GBase.Interfaces.IGBaseTable.RemoveColumn(GBase.Interfaces.IGBaseColumn)">
|
|
<summary>
|
|
Remove a given <see cref="T:GBase.Interfaces.IGBaseColumn"/> from this <see cref="T:GBase.Interfaces.IGBaseTable"/>
|
|
</summary>
|
|
<param name="column">The given <see cref="T:GBase.Interfaces.IGBaseColumn"/></param>
|
|
<returns>True if successful, false if not</returns>
|
|
</member>
|
|
<member name="T:GBase.Interfaces.Settings.IGBaseSettings">
|
|
<summary>
|
|
Settings of a <see cref="T:GBase.Interfaces.IGBase"/> instance
|
|
</summary>
|
|
</member>
|
|
<member name="P:GBase.Interfaces.Settings.IGBaseSettings.DatabasePath">
|
|
<summary>
|
|
The path where the files of the GBase are located
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|
|
|