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

Diff for /pegasus/src/Pegasus/CQL/CQLValue.h between version 1.5 and 1.6

version 1.5, 2005/05/05 18:22:32 version 1.6, 2005/05/05 19:24:36
Line 93 
Line 93 
   /**   /**
       Contructs CQLValue default object.       Contructs CQLValue default object.
  
       @param  - None.        @param  None.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue();   CQLValue();
Line 103 
Line 103 
   /**   /**
       Destroys CQLValue object.       Destroys CQLValue object.
  
       @param  - None.        @param  None.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   ~CQLValue()   ~CQLValue()
Line 113 
Line 113 
   /**   /**
       Contructs CQLValue object (Copy-Constructor).       Contructs CQLValue object (Copy-Constructor).
  
       @param  - None.        @param  None.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */;   */;
   CQLValue(const CQLValue& val);   CQLValue(const CQLValue& val);
Line 123 
Line 123 
   /**   /**
       Contructs CQLValue object given a string and a numbericType       Contructs CQLValue object given a string and a numbericType
  
       @param  - inString - the string representation of a number        @param  inString The string representation of a number
       @param  - inValueType - the NumericType        @param  inValueType The NumericType
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(String inString, NumericType inValueType,    CQLValue(const String& inString, NumericType inValueType,
        Boolean inSign = true);        Boolean inSign = true);
  
   /**   /**
       Contructs CQLValue object via CQLChainedIdentifier.       Contructs CQLValue object via CQLChainedIdentifier.
  
       @param  - inCQLIdent - The CQLChained Identifer used to create the object        @param  inCQLIdent The CQLChained Identifer used to create the object
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(CQLChainedIdentifier inCQLIdent);    CQLValue(const CQLChainedIdentifier& inCQLIdent);
  
   /**   /**
       Initializes object as a CIMObjectPath.       Initializes object as a CIMObjectPath.
  
       @param  - inObjPath - CIMObjectPath use to construct object.        @param  inObjPath CIMObjectPath used to construct object.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(CIMObjectPath inObjPath);    CQLValue(const CIMObjectPath& inObjPath);
  
   /**   /**
       Initializes object as a CIMDateTime.       Initializes object as a CIMDateTime.
  
       @param  - inDateTime - used to construct object.        @param  inDateTime Datetime used to construct object.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(CIMDateTime inDateTime);    CQLValue(const CIMDateTime& inDateTime);
  
   /**   /**
       Initializes object as a literal string (non-numeric).       Initializes object as a literal string (non-numeric).
  
       @param  - inString - String used to construct object.        @param  inString String used to construct object.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(String inString);    CQLValue(const String& inString);
  
   /**   /**
       Initializes object as an Sint64.       Initializes object as an Sint64.
  
       @param  - inSint - Sint64 used to contruct object.        @param  inSint Sint64 used to contruct object.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(Sint64 inSint);   CQLValue(Sint64 inSint);
Line 185 
Line 185 
   /**   /**
       Initializes object as a Uint64       Initializes object as a Uint64
  
       @param  - inUint - Uint64 used to construct object.        @param  inUint Uint64 used to construct object.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(Uint64 inUint);   CQLValue(Uint64 inUint);
Line 195 
Line 195 
   /**   /**
       Initializes object as a Real64       Initializes object as a Real64
  
       @param  - inReal - Real64 used to construct object.        @param  inReal Real64 used to construct object.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(Real64 inReal);   CQLValue(Real64 inReal);
Line 205 
Line 205 
   /**   /**
       Initializes object as a CIMInstance       Initializes object as a CIMInstance
  
       @param  - inInstance - CIMInstance used to construct object.        @param  inInstance CIMInstance used to construct object.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(CIMInstance inInstance);    CQLValue(const CIMInstance& inInstance);
  
   /**   /**
       Initializes object as a Boolean       Initializes object as a Boolean
  
       @param  - inBool - inBool used to construct object.        @param  inBool inBool used to construct object.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(Boolean inBool);   CQLValue(Boolean inBool);
Line 225 
Line 225 
   /**   /**
       Initializes object as a inClass       Initializes object as a inClass
  
       @param  - inClass - CIMClass used to construct object.        @param  inClass CIMClass used to construct object.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(CIMClass inClass);    CQLValue(const CIMClass& inClass);
  
   /**   /**
       Initializes object as a CQLValueRep       Initializes object as a CQLValueRep
  
       @param  - rhs - CQLValueRep used to construct object.        @param  rhs CQLValueRep used to construct object.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(CQLValueRep rhs);    CQLValue(const CQLValueRep& rhs);
  
   /**   /**
       Initializes object as a CIMObject       Initializes object as a CIMObject
  
       @param  - inObject - CIMObject used to construct object.        @param  inObject CIMObject used to construct object.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(CIMObject inObject);    CQLValue(const CIMObject& inObject);
  
   /**   /**
       Initializes object as a CIMValue       Initializes object as a CIMValue
  
       @param  - inVal - CIMValue used to construct object.        @param  inVal CIMValue used to construct object.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue(CIMValue inVal);    CQLValue(const CIMValue& inVal);
  
   /**  This method is used to ask an identifier to resolve itself to   /**  This method is used to ask an identifier to resolve itself to
        a primitive value.        a primitive value.
Line 273 
Line 273 
        and this is recursive        and this is recursive
        - class aliasing        - class aliasing
  
       @param  - CI - CIMInstance where information is retrieved.        @param  CI CIMInstance where information is retrieved.
       @param  - inQueryCtx - QueryContext contains query data.        @param  inQueryCtx QueryContext contains query data.
       @return - None.        @return None.
       @throw  - CQLRuntimeException.        @throw  CQLRuntimeException.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   void resolve(const CIMInstance& CI,const  QueryContext& inQueryCtx);   void resolve(const CIMInstance& CI,const  QueryContext& inQueryCtx);
Line 284 
Line 284 
   /**   /**
       Assignment operator.       Assignment operator.
  
       @param  - rhs - right hand side of operator.        @param  rhs right hand side of operator.
       @return - CQLValue.        @return Reference to this object.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue& operator=(const CQLValue& rhs);   CQLValue& operator=(const CQLValue& rhs);
Line 295 
Line 295 
       operator == compares two CQLValue objects for equality and       operator == compares two CQLValue objects for equality and
       performs type checking.       performs type checking.
  
       @param  - rhs - right hand side of operator.        @param  rhs right hand side of operator.
       @return - Boolean.        @return Boolean.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   
   
   Boolean operator==(const CQLValue& x) const;   Boolean operator==(const CQLValue& x) const;
  
   /**   /**
       operator != compares two CQLValue objects for inequality and       operator != compares two CQLValue objects for inequality and
       performs type checking.       performs type checking.
  
       @param  - x - right hand side of operator.        @param  x Right hand side of operator.
       @return - Boolean.        @return Boolean.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   Boolean operator!=(const CQLValue& x) const;   Boolean operator!=(const CQLValue& x) const;
Line 319 
Line 317 
       operator <= compares two CQLValue objects to see if leftside is less than or       operator <= compares two CQLValue objects to see if leftside is less than or
       equal to right side and performs type checking.       equal to right side and performs type checking.
  
       @param  - x - right hand side of operator.        @param  x Right hand side of operator.
       @return - Boolean.        @return Boolean.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   Boolean operator<=(const CQLValue& x) const;   Boolean operator<=(const CQLValue& x) const;
Line 330 
Line 328 
       operator >= compares two CQLValue objects to see if leftside is greater than or       operator >= compares two CQLValue objects to see if leftside is greater than or
       equal to rightside and performs type checking.       equal to rightside and performs type checking.
  
       @param  - x - right hand side of operator.        @param  x Right hand side of operator.
       @return - Boolean.        @return Boolean.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   
   Boolean operator>=(const CQLValue& x) const;   Boolean operator>=(const CQLValue& x) const;
  
   /**   /**
       The overload operator < compares CQLValue obects and       The overload operator < compares CQLValue obects and
       performs type checking.       performs type checking.
  
       @param  - val1 - right hand side of operator.        @param  val1 Right hand side of operator.
       @return - Boolean.        @return Boolean.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   Boolean operator<(const CQLValue& val1) const;   Boolean operator<(const CQLValue& val1) const;
Line 353 
Line 350 
       The overload operator > compares CQLValue obects and       The overload operator > compares CQLValue obects and
       performs type checking.       performs type checking.
  
       @param  - val1 - right hand side of operator.        @param  val1 Right hand side of operator.
       @return - Boolean.        @return Boolean.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   Boolean operator>(const CQLValue& val1) const;   Boolean operator>(const CQLValue& val1) const;
Line 364 
Line 361 
       CQLValue objects and performs type checking.       CQLValue objects and performs type checking.
       (Currently supports only CQLValue of String type.)       (Currently supports only CQLValue of String type.)
  
       @param  - x - right hand side of operator.        @param  x Right hand side of operator.
       @return - Boolean.        @return Boolean.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValue operator+(const CQLValue& x);   CQLValue operator+(const CQLValue& x);
Line 374 
Line 371 
   /**   /**
       Accessor for getting the type of the CQLValue.       Accessor for getting the type of the CQLValue.
  
       @param  - None.        @param  None.
       @return - CQLValueType.        @return CQLValueType.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLValueType getValueType() const;   CQLValueType getValueType() const;
Line 384 
Line 381 
   /**   /**
       Clears this object and sets its type to NULL_VALUE       Clears this object and sets its type to NULL_VALUE
  
       @param  - None.        @param  None.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   void setNull();   void setNull();
Line 394 
Line 391 
   /**   /**
       Returns whether the value has been resolved to a primitive.       Returns whether the value has been resolved to a primitive.
  
       @param  - None.        @param  None.
       @return - true when value is a primitive.        @return True when value is a primitive.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   Boolean isResolved() const;   Boolean isResolved() const;
Line 404 
Line 401 
   /**   /**
       Returns whether the CQLValue is null.       Returns whether the CQLValue is null.
  
       @param  - None.        @param  None.
       @return - true if CQLValue primitive value is NULL.        @return True if CQLValue primitive value is NULL.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   Boolean isNull() const;   Boolean isNull() const;
Line 415 
Line 412 
       that identifies a class. The CQLValue must be of a type Instance or Class; Also       that identifies a class. The CQLValue must be of a type Instance or Class; Also
       the cid must contain a String that is a valid class name.       the cid must contain a String that is a valid class name.
  
       @param  - cid - Contains the class name.        @param  cid Contains the class name.
       @param  - QueryCtx - contains query related data.        @param  QueryCtx Contains query related data.
       @return - true CQLValue isa class identified by cid.        @return true CQLValue isa class identified by cid.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   
   Boolean isa(const CQLChainedIdentifier& cid, QueryContext& QueryCtx) const;   Boolean isa(const CQLChainedIdentifier& cid, QueryContext& QueryCtx) const;
  
   /** Tests to see if this "like" the input string.   /** Tests to see if this "like" the input string.
Line 436 
Line 432 
       chain, and       chain, and
       the right-hand expression may be restricted to be a literal-string.       the right-hand expression may be restricted to be a literal-string.
  
       @param  - inVal - CQLValue to be compared.        @param  inVal CQLValue to be compared.
       @return - true CQLValue is like the passed in CQLValue.        @return true CQLValue is like the passed in CQLValue.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   Boolean like(const CQLValue& inVal) const;   Boolean like(const CQLValue& inVal) const;
Line 446 
Line 442 
   /**   /**
       Get the ChainedIdentifier. Primitive from CQLValue       Get the ChainedIdentifier. Primitive from CQLValue
  
       @param  - None.        @param  None.
       @return - ChainedIdentifier.        @return ChainedIdentifier.
       @throw  - CQLRuntimeException.        @throw  CQLRuntimeException.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CQLChainedIdentifier getChainedIdentifier() const;   CQLChainedIdentifier getChainedIdentifier() const;
Line 456 
Line 452 
   /**   /**
       Get the Uint64.  Primitive from CQLValue       Get the Uint64.  Primitive from CQLValue
  
       @param  - None.        @param  None.
       @return - Uint64.        @return Uint64.
       @throw  - CQLRuntimeException.        @throw  CQLRuntimeException.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   Uint64 getUint() const;   Uint64 getUint() const;
Line 466 
Line 462 
   /**   /**
       Get the Sint64. Primitive from CQLValue.       Get the Sint64. Primitive from CQLValue.
  
       @param  - None.        @param  None.
       @return - Sint64.        @return Sint64.
       @throw  - CQLRuntimeException.        @throw  CQLRuntimeException.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   Sint64 getSint() const;   Sint64 getSint() const;
Line 476 
Line 472 
   /**   /**
       Get the Real64. Primitive from CQLValue.       Get the Real64. Primitive from CQLValue.
  
       @param  - None.        @param  None.
       @return - Real64.        @return Real64.
       @throw  - CQLRuntimeException.        @throw  CQLRuntimeException.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   Real64 getReal() const;   Real64 getReal() const;
Line 486 
Line 482 
   /**   /**
       Get the String. Primitive from CQLValue       Get the String. Primitive from CQLValue
  
       @param  - None.        @param  None.
       @return - String.        @return String.
       @throw  - CQLRuntimeException.        @throw  CQLRuntimeException.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   String getString() const;   String getString() const;
Line 496 
Line 492 
   /**   /**
       Get the Boolean. Primitive from CQLValue       Get the Boolean. Primitive from CQLValue
  
       @param  - None.        @param  None.
       @return - Boolean        @return Boolean
       @throw  - CQLRuntimeException.        @throw  CQLRuntimeException.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   Boolean getBool() const;   Boolean getBool() const;
Line 506 
Line 502 
   /**   /**
       Get the CIMDateTime. Primitive from CQLValue.       Get the CIMDateTime. Primitive from CQLValue.
  
       @param  - None.        @param  None.
       @return - CIMDateTime        @return CIMDateTime
       @throw  - CQLRuntimeException.        @throw  CQLRuntimeException.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CIMDateTime getDateTime() const;   CIMDateTime getDateTime() const;
Line 516 
Line 512 
   /**   /**
       Get the CIMObjectPath. Primitive from CQLValue.       Get the CIMObjectPath. Primitive from CQLValue.
  
       @param  - None.        @param  None.
       @return - Reference.        @return Reference.
       @throw  - CQLRuntimeException.        @throw  CQLRuntimeException.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CIMObjectPath getReference() const;   CIMObjectPath getReference() const;
Line 526 
Line 522 
   /**   /**
       Get the CIMObject. Primitive from CQLValue.       Get the CIMObject. Primitive from CQLValue.
  
       @param  - None.        @param  None.
       @return - CIMObject.        @return CIMObject.
       @throw  - CQLRuntimeException.        @throw  CQLRuntimeException.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   CIMObject getObject() const;   CIMObject getObject() const;
Line 536 
Line 532 
   /**   /**
       Return String representation of object.       Return String representation of object.
  
       @param  - None.        @param  None.
       @return - String        @return String
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   String toString() const;   String toString() const;
Line 546 
Line 542 
   /**   /**
       Apply scope and class to CQLValue's chainedIdentifier.       Apply scope and class to CQLValue's chainedIdentifier.
  
       @param  - None.        @param  None.
       @return - None.        @return None.
       @throw  - None.        @throw  None.
       <I><B>Experimental Interface</B></I><BR>       <I><B>Experimental Interface</B></I><BR>
   */   */
   void applyContext(QueryContext& _ctx,   void applyContext(QueryContext& _ctx,


Legend:
Removed from v.1.5  
changed lines
  Added in v.1.6

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2