summaryrefslogtreecommitdiffstats
path: root/tags/cpp-stable-20060304/sdo/runtime/core/src/commonj/sdo/PropertyImpl.h
blob: d40fa5869045221738eff3922e01210a2b454adf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
/*
 *
 *  Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

/* $Rev$ $Date: 2005/12/22 16:54:15 $ */

#ifndef _PROPERTYIMPL_H_
#define _PROPERTYIMPL_H_

#include "commonj/sdo/disable_warn.h"

#include <string>
using namespace std;

#include "commonj/sdo/DASProperty.h"
#include "commonj/sdo/SDODate.h"
#include "commonj/sdo/DataFactory.h"

namespace commonj{
namespace sdo{

class Type;
class TypeImpl;
class DataObject;

/**
 *  A substitution is a class which permits a property to be a substitute for
 * another one.
 * A substitution is a definition of a type which is allowed to be placed in the
 * data object in place of a property of another type.
 */


class Substitution
{
public:
    Substitution();
    Substitution(DataFactoryPtr mdg, const char* inname, 
                                     const Type& intype);
    Substitution(const Substitution& s);
    virtual ~Substitution();
    const Type* type;
    char* name;
};

/**  PropertyImpl implements the abstract class Property.
 *
 * A representation of a property in the type of a data object.
 */

class PropertyImpl :public DASProperty
{
    public:


    ///////////////////////////////////////////////////////////////////////////
    // Construction for the DAS 
    ///////////////////////////////////////////////////////////////////////////

    SDO_API PropertyImpl(    
                 const Type& cont,
                 const char* name,  
                 const TypeImpl& type, 
                 bool many = false, 
                   bool ro = false,
                 bool contain = false);



    virtual SDO_API ~PropertyImpl();

    /**
     * A Data access service may set the features of this property instead of
     * passing them as construction parameters.
     */

    virtual SDO_API void setMany(bool many );

    /**
     * A Data access service may set the features of this property instead of
     * passing them as construction parameters.
     */
    virtual SDO_API void setReadOnly(bool rdonly);

    /**
     * A Data access service may set the features of this property instead of
     * passing them as construction parameters.
     */
    virtual SDO_API void setContainment(bool contains);

    /**
     * A Data access service may set the features of this property instead of
     * passing them as construction parameters.
     */

    virtual SDO_API bool isDefaulted() const;
    
    /**
     * A Data access service sets the default value.
     */

    virtual SDO_API void setDefault(bool b );
    virtual SDO_API void setDefault(char c);
    virtual SDO_API void setDefault(wchar_t c);
    virtual SDO_API void setDefault(char* c);
    virtual SDO_API void setDefault(short s);
    virtual SDO_API void setDefault(long l);
    virtual SDO_API void setDefault(int64_t i);
    virtual SDO_API void setDefault(float f);
    virtual SDO_API void setDefault(long double d);
    virtual SDO_API void setDefault(const SDODate d);
    virtual SDO_API void setDefault(const wchar_t* c, unsigned int len);
    virtual SDO_API void setDefault(const char* c, unsigned int len);




    
    /**
     * Returns the name of the property.
     */

    virtual const SDO_API char* getName() const;
  
    /**  getAlias returns the n'th alias
     *
     * This method returns a const char* corresponding to the
     * alias at index n of the list of aliases. Use getAliasCount to 
     * discover the size of the list.
     */

    virtual const char* getAlias(unsigned int index = 0) const ;
    virtual unsigned int getAliasCount() const ;
    virtual void setAlias(const char* alias) ;

    /**
     *
     * SubstitutionGroup support.
     */

    virtual const Type* getSubstitutionType(const char* name) const ;
    virtual unsigned int getSubstitutionCount(void) const ;
    virtual const Type* getSubstitutionType(unsigned int index) const ;
    virtual const char* getSubstitutionName(unsigned int index) const ;
    virtual void setSubstitution(DataFactoryPtr mdg, const char* alias, 
                                  const Type& substype) ;


    /**  getType returns the type of this property
     *
     * This method returns the type, which may be a DataType or a
     * DataObjectType
     */

    virtual SDO_API const Type& getType() const;

    virtual SDO_API const Type::Types getTypeEnum() const;

    virtual SDO_API const TypeImpl* getTypeImpl() const;
  
    /**
    * Returns whether the property is many-valued.
    */
    virtual bool SDO_API isMany() const;
  
    /**
    * Returns whether the property is containment.
    */
    virtual bool SDO_API isContainment() const;

    /**
    * Returns whether the property is a reference.
    */
    virtual bool SDO_API isReference() const;
 
    /**
     * Returns the containing type of this property.
     */
    virtual SDO_API const Type& getContainingType() const;
  
    /**
     * returns the opposite property, or zero if there is none
     */
    virtual SDO_API const Property* getOpposite() const;

    virtual void setOpposite(const Property* opp);  


    /**
     *  setters for type primitive types and 'an object'
     */

    SDO_API void setDefaultCString(  const char* s);
    SDO_API void setDefaultString( const wchar_t* c , unsigned int len  );
    SDO_API void setDefaultBytes( const char* c , unsigned int len  );
    SDO_API void setDefaultBoolean( const bool b   );
    SDO_API void setDefaultByte(    const char c   );
    SDO_API void setDefaultCharacter(   const wchar_t c);
    SDO_API void setDefaultShort(   const short s  );
    SDO_API void setDefaultInteger( const long i    );
    SDO_API void setDefaultLong(const int64_t l);
    SDO_API void setDefaultFloat(   const float f  );
    SDO_API void setDefaultDouble(  const long double d );
    SDO_API void setDefaultDate(    const SDODate d );

    SDO_API const char*        getCStringDefault() const;
    SDO_API unsigned int     getStringDefault(wchar_t* val, unsigned int max) const;
    SDO_API unsigned int    getBytesDefault(char* val, unsigned int max) const;
    SDO_API bool        getBooleanDefault() const;
    SDO_API char        getByteDefault() const;
    SDO_API wchar_t     getCharacterDefault() const;
    SDO_API short       getShortDefault() const;
    SDO_API long        getIntegerDefault() const;
    SDO_API int64_t     getLongDefault() const;
    SDO_API float       getFloatDefault() const;
    SDO_API long double getDoubleDefault() const;
    SDO_API const SDODate  getDateDefault() const;
    SDO_API unsigned int  getDefaultLength() const;

    /**
    * Returns true if values for this Property cannot be modified using the SDO APIs.
    * When true, DataObject.set(Property property, Object value) throws an exception.
    * Values may change due to other factors, such as services operating on DataObjects.
    */
    virtual bool SDO_API isReadOnly() const;

    SDO_API PropertyImpl(const PropertyImpl& p);

  private:
    
     // clear the default value
    void deleteValue();

    bool bisReadOnly;
    bool bisContainer;
    bool bisReference;
    bool bisMany;

    bool bDefaulted;
      
    const TypeImpl& type;
    const Type& containertype;
    const Property* opposite;
    char* name;
    char* stringdef;

    void* defvalue;
    // in the event of a bytes and string, this holds the length
    unsigned int defvaluelength;

    // alias support
    std::vector<char*> aliases;

    std::vector<Substitution> substitutions;

    typedef std::list<PropertyImpl*> REFEREE_LIST;
    REFEREE_LIST references;

  
};
};
};

#endif //_PROPERTYIMPL_H_