| Qore DataProvider Module Reference 1.0.3

AbstractDataField.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3
25 // assume local scope for variables, do not use "$" signs
26 // require type definitions everywhere
28 // enable all warnings
29
30
32 namespace DataProvider {
34 public struct DataFieldInfo {
36 string name;
37
39 *string desc;
40
42 auto default_value;
43
45 hash<DataTypeInfo> type;
46 };
47
49 class AbstractDataField : public Serializable {
50
51 public:
52 protected:
54 auto default_value;
55
56 public:
57
59 bool isAssignableFrom(AbstractDataProviderType t);
60
61
63 bool isAssignableFrom(Type t);
64
65
67 bool isList();
68
69
71 bool isMandatory();
72
73
75 auto getOptionValue(string opt);
76
77
79 *hash<auto> getOptions();
80
81
83 *hash<string, hash<DataProviderTypeOptionInfo>> getSupportedOptions();
84
85
87
92 setOption(string opt, auto value);
93
94
96
100 setOptions(hash<auto> options);
101
102
104 string getTypeName();
105
106
108 setDefaultValue(auto default_value);
109
110
112 auto getDefaultValue();
113
114
116 bool hasType();
117
118
120
124 auto acceptsValue(auto value);
125
126
128
130 hash<DataFieldInfo> getInputInfo();
131
132
134 hash<DataFieldInfo> getInfo();
135
136
138
143 AbstractDataField getSoftType();
144
145
147
152 AbstractDataField getOrNothingType();
153
154
156 abstract string getName();
157
159 abstract *string getDescription();
160
162 abstract AbstractDataProviderType getType();
163 };
164 };
DataProvider::AbstractDataField::isAssignableFrom
bool isAssignableFrom(Type t)
returns True if this field's type can be assigned from values of the argument type
DataProvider::AbstractDataField::setOption
setOption(string opt, auto value)
sets the given option on the field's type
DataProvider::AbstractDataProviderType
describes a data type
Definition: AbstractDataProviderType.qc.dox.h:93
DataProvider::AbstractDataField::hasType
bool hasType()
returns True if the field's type is not a wildcard type
DataProvider::AbstractDataField::setDefaultValue
setDefaultValue(auto default_value)
sets the default value for the field
DataProvider::AbstractDataField::getDefaultValue
auto getDefaultValue()
get default value, if any
DataProvider::AbstractDataField
describes a data type based on a hashdecl
Definition: AbstractDataField.qc.dox.h:49
DataProvider::AbstractDataField::getOptionValue
auto getOptionValue(string opt)
returns the value of the given option on the field's type
DataProvider::AbstractDataField::isAssignableFrom
bool isAssignableFrom(AbstractDataProviderType t)
returns True if this field's type can be assigned from values of the argument type
DataProvider::AbstractDataField::getSoftType
AbstractDataField getSoftType()
returns a field with a "soft" type equivalent to the current type
DataProvider::AbstractDataField::acceptsValue
auto acceptsValue(auto value)
returns the value if the value can be assigned to the type
DataProvider
Qore AbstractDataField class definition.
Definition: AbstractDataField.qc.dox.h:32
DataProvider::DataFieldInfo::desc
*string desc
the description of the field, if available
Definition: AbstractDataField.qc.dox.h:39
DataProvider::AbstractDataField::getInfo
hash< DataFieldInfo > getInfo()
returns information about the field
DataProvider::AbstractDataField::isMandatory
bool isMandatory()
returns True if the field's type must have a value
DataProvider::AbstractDataField::isList
bool isList()
returns True if this field's type is a list
DataProvider::AbstractDataField::getDescription
abstract *string getDescription()
returns the description, if any
DataProvider::AbstractDataField::getSupportedOptions
*hash< string, hash< DataProviderTypeOptionInfo > > getSupportedOptions()
returns supported options on the field's type
DataProvider::DataFieldInfo::default_value
auto default_value
the default value for the field
Definition: AbstractDataField.qc.dox.h:42
DataProvider::AbstractDataField::getInputInfo
hash< DataFieldInfo > getInputInfo()
returns information about the field as an input field
DataProvider::DataFieldInfo
describes a data type
Definition: AbstractDataField.qc.dox.h:34
DataProvider::AbstractDataField::getTypeName
string getTypeName()
returns the type name
DataProvider::DataFieldInfo::name
string name
the name of the field
Definition: AbstractDataField.qc.dox.h:36
DataProvider::DataFieldInfo::type
hash< DataTypeInfo > type
type info
Definition: AbstractDataField.qc.dox.h:45
DataProvider::AbstractDataField::setOptions
setOptions(hash< auto > options)
sets the given options on the field's type
DataProvider::AbstractDataField::getOrNothingType
AbstractDataField getOrNothingType()
returns a field with an "or nothing" type equivalent to the current type
DataProvider::AbstractDataField::default_value
auto default_value
the default value for the field, if any
Definition: AbstractDataField.qc.dox.h:54
DataProvider::AbstractDataField::getType
abstract AbstractDataProviderType getType()
returns the type of the field
DataProvider::AbstractDataField::getOptions
*hash< auto > getOptions()
returns options set on the field's type
DataProvider::AbstractDataField::getName
abstract string getName()
returns the name of the field