(file) Return to CQLChainedIdentifier.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / CQL

  1 karl  1.7 //%2006////////////////////////////////////////////////////////////////////////
  2 chuck 1.2 //
  3 karl  1.4 // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
  4           // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
  5           // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
  6 chuck 1.2 // IBM Corp.; EMC Corporation, The Open Group.
  7 karl  1.4 // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
  8           // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
  9           // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10           // EMC Corporation; VERITAS Software Corporation; The Open Group.
 11 karl  1.7 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 12           // EMC Corporation; Symantec Corporation; The Open Group.
 13 chuck 1.2 //
 14           // Permission is hereby granted, free of charge, to any person obtaining a copy
 15           // of this software and associated documentation files (the "Software"), to
 16           // deal in the Software without restriction, including without limitation the
 17           // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 18           // sell copies of the Software, and to permit persons to whom the Software is
 19           // furnished to do so, subject to the following conditions:
 20           // 
 21           // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 22           // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 23           // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 24           // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 25           // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 26           // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 27           // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 28           // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 29           //
 30           //==============================================================================
 31 karl  1.4 
 32 chuck 1.2 //
 33           // Authors: David Rosckes (rosckes@us.ibm.com)
 34           //          Bert Rivero (hurivero@us.ibm.com)
 35           //          Chuck Carmack (carmack@us.ibm.com)
 36           //          Brian Lucier (lucier@us.ibm.com)
 37           //
 38 aruran.ms 1.6 // Modified By: Aruran, IBM(ashanmug@in.ibm.com) for Bug# 3588
 39 chuck     1.2 //
 40               //%/////////////////////////////////////////////////////////////////////////////
 41               
 42               #ifndef Pegasus_CQLChainedIdentifier_h
 43               #define Pegasus_CQLChainedIdentifier_h
 44               
 45               #include <Pegasus/CQL/Linkage.h>
 46               //#include <Pegasus/Common/Array.h>
 47               #include <Pegasus/Common/ArrayInternal.h>
 48               #include <Pegasus/Query/QueryCommon/QueryChainedIdentifier.h>
 49               #include <Pegasus/CQL/CQLIdentifier.h>
 50               
 51               #ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES
 52               
 53               PEGASUS_NAMESPACE_BEGIN 
 54               class PEGASUS_CQL_LINKAGE CQLFactory;
 55               class PEGASUS_CQL_LINKAGE CQLChainedIdentifierRep;
 56               
 57               /**  
 58               CQLChainedIdentifier class is used for parsing (not resolving)
 59               the identifier portion of a CQL select statement.  
 60 chuck     1.2 A couple examples of a CQLIdentifier:
 61               
 62                 Class.EmbeddedObject.Property[3]
 63                 Class.Property#'OK'
 64               
 65               
 66               The CQLChainedIdentifier class can parse and return each
 67                section of a CQL identifier.  The possible sections are:
 68               
 69                    class (optional)
 70                    zero or more embedded objects
 71                    property
 72               
 73               Note:  this must handle wildcard("*"), embedded objects, arrays, symbolic
 74               constants, etc.
 75                  */
 76               class PEGASUS_CQL_LINKAGE CQLChainedIdentifier : public QueryChainedIdentifier
 77               {
 78                 public:
 79               
 80                   CQLChainedIdentifier();
 81 humberto  1.3     /**  
 82               	Constructor 
 83                       Parses the string into the various components of a CQL identifier.
 84               	@param  - inString.  The raw string to be parsed into a CQLChainedIdentifier
 85                       @return - None.
 86                       @throws - None.
 87                   */
 88 aruran.ms 1.6     CQLChainedIdentifier(const String& inString);
 89 humberto  1.3     
 90                   /**  
 91               	The constructor for a CQLChainedIdentifier object.
 92                                                                                                                                                                            
 93                       @param  - id.  The CQLIdentifier to construct this object with.
 94                       @return - None.
 95                       @throws - None.
 96                   */
 97 chuck     1.2     CQLChainedIdentifier(const CQLIdentifier & id);
 98                
 99 humberto  1.3     /**
100                       Copy Constructor
101                                                                                                                                                                            
102                       @param  - cid.  The CQLChainedIdentifier to construct this object with.
103                       @return - None.
104                       @throws - None.
105                   */
106 chuck     1.2     CQLChainedIdentifier(const CQLChainedIdentifier& cid);
107               
108 humberto  1.3     /**
109                       Destructor
110                                                                                                                                                                            
111                       @param  - None.
112                       @return - None.
113                       @throws - None.
114                   */
115 chuck     1.2     ~CQLChainedIdentifier();
116               
117 humberto  1.3     /**
118                       Opertor=
119                                                                                                                                                                            
120                       @param  - rhs. Right hand side of assignement operator.
121                       @return - *this.
122                       @throws - None.
123                   */
124 chuck     1.2     CQLChainedIdentifier& operator=(const CQLChainedIdentifier& rhs);
125               
126 humberto  1.3     /**
127                       Operator[]. Allows indexed access into the CQLChainedIdentifier
128                                                                                                                                                                            
129                       @param  - index. Location of data within the CQLChainedIdentifier
130                       @return - CQLIdentifier.  returns CQLIdentifer() if index is out of bounds.
131                       @throws - None.
132                   */
133 chuck     1.2     CQLIdentifier operator[](Uint32 index)const;
134               
135 humberto  1.3     /**
136                       Gets all of the CQLIdentifiers within the CQLChainedIdentifier
137                                                                                                                                                                            
138                       @param  - None.
139                       @return - Array<CQLIdentifier>.
140                       @throws - None.
141                   */
142 chuck     1.2     Array<CQLIdentifier> getSubIdentifiers()const;
143               
144 humberto  1.3     /**
145                       Gets the last CQLIdentifier in this objects Array of CQLIdentifiers
146                                                                                                                                                                            
147                       @param  - None.
148                       @return - CQLIdentifier.
149                       @throws - None.
150                   */
151 chuck     1.2     CQLIdentifier getLastIdentifier()const;
152               	
153                   friend class CQLFactory;
154               
155                 private:
156               
157               };
158               
159               /*
160               #ifndef PEGASUS_ARRAY_T
161               #define PEGASUS_ARRAY_T CQLChainedIdentifier
162               #include <Pegasus/Common/ArrayInter.h>
163               #undef PEGASUS_ARRAY_T
164               #endif
165               */
166               
167               PEGASUS_NAMESPACE_END
168               #endif
169               #endif /* Pegasus_CQLChainedIdentifier_h */

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2