Qore DataProvider Module Reference  2.1.1
AbstractDataField.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
27 namespace DataProvider {
29 public struct DataFieldInfo {
31  string name;
32 
34  *string desc;
35 
38 
40  hash<DataTypeInfo> type;
41 };
42 
44 class AbstractDataField : public Serializable {
45 
46 public:
47 protected:
50 
51 public:
52 
55 
56 
58  bool isAssignableFrom(Type t);
59 
60 
62  bool isList();
63 
64 
66  bool isMandatory();
67 
68 
70  auto getOptionValue(string opt);
71 
72 
74  *hash<auto> getOptions();
75 
76 
78  *hash<string, hash<DataProviderTypeOptionInfo>> getSupportedOptions();
79 
80 
82 
87  setOption(string opt, auto value);
88 
89 
91 
95  setOptions(hash<auto> options);
96 
97 
99  string getTypeName();
100 
101 
104 
105 
108 
109 
111  bool hasType();
112 
113 
115 
119  auto acceptsValue(auto value);
120 
121 
123 
125  hash<DataFieldInfo> getInputInfo();
126 
127 
129  hash<DataFieldInfo> getInfo();
130 
131 
133 
139 
140 
142 
148 
149 
151  abstract string getName();
152 
154  abstract *string getDescription();
155 
158 };
159 };
describes a data type based on a hashdecl
Definition: AbstractDataField.qc.dox.h:44
AbstractDataField getOrNothingType()
returns a field with an "or nothing" type equivalent to the current type
auto getOptionValue(string opt)
returns the value of the given option on the field's type
auto getDefaultValue()
get default value, if any
string getTypeName()
returns the type name
*hash< auto > getOptions()
returns options set on the field's type
auto default_value
the default value for the field, if any
Definition: AbstractDataField.qc.dox.h:49
bool isMandatory()
returns True if the field's type must have a value
bool isAssignableFrom(AbstractDataProviderType t)
returns True if this field's type can be assigned from values of the argument type
abstract *string getDescription()
returns the description, if any
abstract string getName()
returns the name of the field
bool isList()
returns True if this field's type is a list
setOptions(hash< auto > options)
sets the given options on the field's type
AbstractDataField getSoftType()
returns a field with a "soft" type equivalent to the current type
auto acceptsValue(auto value)
returns the value if the value can be assigned to the type
*hash< string, hash< DataProviderTypeOptionInfo > > getSupportedOptions()
returns supported options on the field's type
hash< DataFieldInfo > getInputInfo()
returns information about the field as an input field
bool isAssignableFrom(Type t)
returns True if this field's type can be assigned from values of the argument type
bool hasType()
returns True if the field's type is not a wildcard type
setDefaultValue(auto default_value)
sets the default value for the field
abstract AbstractDataProviderType getType()
returns the type of the field
hash< DataFieldInfo > getInfo()
returns information about the field
setOption(string opt, auto value)
sets the given option on the field's type
describes a data type
Definition: AbstractDataProviderType.qc.dox.h:105
Qore AbstractDataField class definition.
Definition: AbstractDataField.qc.dox.h:27
describes a data type
Definition: AbstractDataField.qc.dox.h:29
string name
the name of the field
Definition: AbstractDataField.qc.dox.h:31
auto default_value
the default value for the field
Definition: AbstractDataField.qc.dox.h:37
hash< DataTypeInfo > type
type info
Definition: AbstractDataField.qc.dox.h:40
*string desc
the description of the field, if available
Definition: AbstractDataField.qc.dox.h:34