Qore DataProvider Module Reference 2.7.1
Loading...
Searching...
No Matches
AbstractDataProviderFactory.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
26namespace DataProvider {
32
34const DPSP_REST = "rest";
35
38const DPSP_SOAP = "soap";
40
44 string name;
46 string desc;
48 bool api_management = False;
58 *softlist<string> api_profiles;
60 hash<DataProviderInfo> provider_info;
61};
62
65
66public:
67
68
70 AbstractDataProvider create(*hash<auto> options);
71
72
74 AbstractDataProvider createWithTemplate(*hash<auto> template_options, *hash<auto> options);
75
76
78 string getName();
79
80
82 Class getClass();
83
84
86
89 hash<DataProviderFactoryInfo> getInfo();
90
91
93
98 hash<auto> getInfoAsData(*bool with_type_info);
99
100
102
104 hash<DataProviderInfo> getProviderInfo();
105
106
108
121 AbstractDataProvider getProviderFromExample(data example, *hash<auto> constructor_options);
122
123
125
138 AbstractDataProvider getProviderFromExample(InputStream example, *hash<auto> constructor_options);
139
140
142
152 list<hash<auto>> getExampleProviderRecordOutput(data example, *hash<auto> constructor_options);
153
154
156
166 list<hash<auto>> getExampleProviderRecordOutput(InputStream example, *hash<auto> constructor_options);
167
168
170protected:
171 error(string err, string fmt);
172public:
173
174
176
192protected:
193 AbstractDataProvider getProviderFromExampleImpl(InputStream example, *hash<auto> constructor_options);
194public:
195
196
198
211protected:
212 list<hash<auto>> getExampleProviderRecordOutputImpl(InputStream example, *hash<auto> constructor_options);
213public:
214
215
217protected:
218 string getNameImpl();
219public:
220
221
223
225protected:
226 abstract hash<DataProviderFactoryInfo> getInfoImpl();
227public:
228
230protected:
231 abstract Class getClassImpl();
232public:
233
235
237protected:
238 abstract hash<DataProviderInfo> getProviderInfoImpl();
239public:
240};
241};
Data provider factory class.
Definition: AbstractDataProviderFactory.qc.dox.h:64
AbstractDataProvider createWithTemplate(*hash< auto > template_options, *hash< auto > options)
Creates an object from the given constructor options.
list< hash< auto > > getExampleProviderRecordOutputImpl(InputStream example, *hash< auto > constructor_options)
Returns information about a data provider constructor given the example data as an argument.
hash< auto > getInfoAsData(*bool with_type_info)
Returns static provider information as data; no objects are returned.
AbstractDataProvider getProviderFromExample(data example, *hash< auto > constructor_options)
Returns a data provider given the example data and constructor options as arguments.
abstract hash< DataProviderInfo > getProviderInfoImpl()
Returns static provider information.
AbstractDataProvider create(*hash< auto > options)
Creates an object from the given constructor options.
list< hash< auto > > getExampleProviderRecordOutput(InputStream example, *hash< auto > constructor_options)
Returns information about a data provider constructor given the example data as an argument.
string getNameImpl()
Returns the name of the data provider factory.
abstract Class getClassImpl()
Returns the class for the data provider object.
Class getClass()
Returns the class for the data provider object.
hash< DataProviderFactoryInfo > getInfo()
Returns static factory information.
abstract hash< DataProviderFactoryInfo > getInfoImpl()
Returns static factory information without provider_info.
string getName()
Returns the name of the data provider factory.
list< hash< auto > > getExampleProviderRecordOutput(data example, *hash< auto > constructor_options)
Returns information about a data provider constructor given the example data as an argument.
hash< DataProviderInfo > getProviderInfo()
Returns static provider information.
AbstractDataProvider getProviderFromExampleImpl(InputStream example, *hash< auto > constructor_options)
Returns a data provider given the example data and constructor options as arguments.
AbstractDataProvider getProviderFromExample(InputStream example, *hash< auto > constructor_options)
Returns a data provider given the example data and constructor options as arguments.
error(string err, string fmt)
thrown an exception
The AbstractDataProvider class.
Definition: AbstractDataProvider.qc.dox.h:732
const DPSP_SOAP
Definition: AbstractDataProviderFactory.qc.dox.h:38
const DPSP_REST
Definition: AbstractDataProviderFactory.qc.dox.h:34
Qore AbstractDataField class definition.
Definition: AbstractDataField.qc.dox.h:27
Data provider factory info.
Definition: AbstractDataProviderFactory.qc.dox.h:42
bool children_can_support_observers
Can any child data providers support the observer pattern / event API?
Definition: AbstractDataProviderFactory.qc.dox.h:54
bool children_can_support_messages
Can any child data providers support messages?
Definition: AbstractDataProviderFactory.qc.dox.h:56
string name
The factory name.
Definition: AbstractDataProviderFactory.qc.dox.h:44
bool children_can_support_records
Can any child data providers offer record-based providers?
Definition: AbstractDataProviderFactory.qc.dox.h:52
*softlist< string > api_profiles
Which server profiles are supported for API management (if any)?
Definition: AbstractDataProviderFactory.qc.dox.h:58
hash< DataProviderInfo > provider_info
Info about providers created from this factory (without the name and children attributes)
Definition: AbstractDataProviderFactory.qc.dox.h:60
bool children_can_support_apis
Can any child data providers offer API services (request - response data providers)?
Definition: AbstractDataProviderFactory.qc.dox.h:50
string desc
The factory description.
Definition: AbstractDataProviderFactory.qc.dox.h:46
bool api_management
Does this factory create a data provider suitable for server-side API management.
Definition: AbstractDataProviderFactory.qc.dox.h:48