QueryObject (GemFire XD Java API Documentation)

java.lang.Object
- util.QueryObject

All Implemented Interfaces:

Serializable, Cloneable, Comparable

Direct Known Subclasses:

DeltaObject
```
public class QueryObject
extends Object
implements Serializable, Cloneable, Comparable
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`Boolean`	`aBoolean`
`Byte`	`aByte`
`byte[]`	`aByteArray`
`Character`	`aCharacter`
`Double`	`aDouble`
`Float`	`aFloat`
`Long`	`aLong`
`Integer`	`anInteger`
`boolean`	`aPrimitiveBoolean`
`byte`	`aPrimitiveByte`
`char`	`aPrimitiveChar`
`double`	`aPrimitiveDouble`
`float`	`aPrimitiveFloat`
`int`	`aPrimitiveInt`
`long`	`aPrimitiveLong`
`short`	`aPrimitiveShort`
`QueryObject`	`aQueryObject`
`Short`	`aShort`
`String`	`aString`
`static int`	`EQUAL_VALUES` All fields (except aByteArray, aQueryObject) have equal values except when the values are out of range for the field type, for example when a long value is out of range for a byte value.
`Object`	`extra`
`long`	`id`
`static int`	`INCREMENT` Increment fields
`String`	`myVersion`
`static int`	`NEGATE` Negate fields
`static int`	`NULL_NONPRIM_FIELDS` Null non-primitive fields
`static int`	`RANDOM_VALUES` The fields (except aByteArray, aQueryObject) have random values, determined by util.RandomValue parameters.
`static int`	`SEQUENTIAL_VALUES` The fields (except aByteArray, aQueryObject) have sequential values.

Constructor Summary

Constructors
Constructor and Description
`QueryObject()` No-arg constructor.
`QueryObject(long base, int valueGeneration, int byteArraySize, int levels)` All the query fields are initialized using the given base value and valueGeneration to determine the values of each field.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()` Make a copy of the QueryObject and any QueryObjects referenced by it, with a different id for all new QueryObjects.
`int`	`compareTo(Object anObj)`
`String`	`constantToString(int constant)` Return a string showing the given QueryObject constant.
`int`	`depth()` Return the depth of the QueryObject.
`boolean`	`equals(Object anObj)` Return true if the argument is equal to this QueryObject, false otherwise.
`protected void`	`fieldsToString(StringBuffer aStr)` Append to the given StringBuffer the basic fields in this QueryObject.
`void`	`fillInBaseValues(long base, int valueGeneration, int byteArraySize)` Init fields using base as appropriate, but does not initialize aQueryObject field.
`QueryObject`	`getAtDepth(int depth)` Return the QueryObject at the given depth.
`boolean`	`hasEqualId(QueryObject anObj)` Return true if the two QueryObjects have the same id, false otherwise.
`int`	`hashCode()` Return whether this QueryObject is equal to the argument.
`static void`	`main(String[] args)` Test QueryObject methods
`void`	`modify(int changeValueGeneration, int delta, boolean log)` Modify the QueryObject according to changeValueGeneration and delta.
`void`	`modify(int depth, int changeValueGeneration, int delta, boolean randomDepth, boolean log)` Modifies the QueryObject at the given depth by changing its values according to changeValueGeneration and delta.
`QueryObject`	`modifyWithNewInstance(int changeValueGeneration, int delta, boolean log)` Return a new instance of QueryObject.
`QueryObject`	`modifyWithNewInstance(int depth, int changeValueGeneration, int delta, boolean randomDepth, boolean log)` Creates new instance of the root QueryObject and modifies the values of the QueryObject at the given depth by changing its values according to changeValueGeneration and delta.
`String`	`toString()` Return a string representation of a QueryObject.
`static String`	`toString(List aList)` Return a String showing the given list of QueryObjects in abbreviated form.
`static String`	`toString(Map aMap)` Return a String showing the given Map of QueryObjects in abbreviated form.
`String`	`toStringAbbreviated()` Return an abbreviated string representation of a QueryObject.
`static String`	`toStringAbbreviated(List aList)` Return a String showing the given list of QueryObjects in an abbreviated form.
`static String`	`toStringAbbreviated(Map aMap)` Return a String showing the given Map of QueryObjects in an abbreviated form.
`String`	`toStringFull()` Return a full string representation of a QueryObject, included all levels.
`static String`	`toStringFull(List aList)` Return a String showing the given list of QueryObjects in full form.
`static String`	`toStringFull(Map aMap)` Return a String showing the given Map of QueryObjects in full form.
`String`	`toStringOneLevel()` Return a one-level string representation of a QueryObject without printing out any nested QueryObjects.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - myVersion
```
public String myVersion
```
  - aPrimitiveLong
```
public long aPrimitiveLong
```
  - aLong
```
public Long aLong
```
  - aPrimitiveInt
```
public int aPrimitiveInt
```
  - anInteger
```
public Integer anInteger
```
  - aPrimitiveShort
```
public short aPrimitiveShort
```
  - aShort
```
public Short aShort
```
  - aPrimitiveFloat
```
public float aPrimitiveFloat
```
  - aFloat
```
public Float aFloat
```
  - aPrimitiveDouble
```
public double aPrimitiveDouble
```
  - aDouble
```
public Double aDouble
```
  - aPrimitiveByte
```
public byte aPrimitiveByte
```
  - aByte
```
public Byte aByte
```
  - aPrimitiveChar
```
public char aPrimitiveChar
```
  - aCharacter
```
public Character aCharacter
```
  - aPrimitiveBoolean
```
public boolean aPrimitiveBoolean
```
  - aBoolean
```
public Boolean aBoolean
```
  - aString
```
public String aString
```
  - aByteArray
```
public byte[] aByteArray
```
  - aQueryObject
```
public QueryObject aQueryObject
```
  - extra
```
public Object extra
```
  - id
```
public long id
```
  - EQUAL_VALUES
```
public static final int EQUAL_VALUES
```
    All fields (except aByteArray, aQueryObject) have equal values except when the values are out of range for the field type, for example when a long value is out of range for a byte value. In that case, the desired is cast to the field with less precision.
    
    See Also:
    
    Constant Field Values
  - SEQUENTIAL_VALUES
```
public static final int SEQUENTIAL_VALUES
```
    The fields (except aByteArray, aQueryObject) have sequential values. where the ordering of fields is the same order they are declared, except when the values are out of range for the field type, for example when the desired value is out of range for a byte value. In that case, the desired is cast to the field with less precision.
    
    See Also:
    
    Constant Field Values
  - RANDOM_VALUES
```
public static final int RANDOM_VALUES
```
    The fields (except aByteArray, aQueryObject) have random values, determined by util.RandomValue parameters.
    
    See Also:
    
    Constant Field Values
  - INCREMENT
```
public static final int INCREMENT
```
    Increment fields
    
    See Also:
    
    Constant Field Values
  - NEGATE
```
public static final int NEGATE
```
    Negate fields
    
    See Also:
    
    Constant Field Values
  - NULL_NONPRIM_FIELDS
```
public static final int NULL_NONPRIM_FIELDS
```
    Null non-primitive fields
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - QueryObject
```
public QueryObject()
```
    No-arg constructor.
  - QueryObject
```
public QueryObject(long base,
                   int valueGeneration,
                   int byteArraySize,
                   int levels)
```
    All the query fields are initialized using the given base value and valueGeneration to determine the values of each field.
    
    Parameters:
    
    base - The base value for all fields. Fields are all set to a value using base as appropriate. Unused if valueGeneration is RANDOM_VALUES.
    
    valueGeneration - How to generate the values of the fields. Can be one of QueryObject.EQUAL_VALUES QueryObject.SEQUENTIAL_VALUES QueryObject.RANDOM_VALUES
    
    byteArraySize - The size of byte[]. If < 0 then there is no byteArray (it is null).
    
    levels - The number of levels of QueryObjects. 1 means the field aQueryObject is null, 2 means aQueryObject contains an instance of QueryObject with fields initialized with base+1, the next level is initialized with base+2 etc.
- Method Detail
  - fillInBaseValues
```
public void fillInBaseValues(long base,
                             int valueGeneration,
                             int byteArraySize)
```
    Init fields using base as appropriate, but does not initialize aQueryObject field.
    
    Parameters:
    
    base - The base value for all fields. Fields are all set to a value using base as appropriate.
    
    valueGeneration - How to generate the values of the fields. Can be one of QueryObject.EQUAL_VALUES QueryObject.SEQUENTIAL_VALUES QueryObject.RANDOM_VALUES
    
    byteArraySize - The size of byte[].
  - hashCode
```
public int hashCode()
```
    Return whether this QueryObject is equal to the argument.
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object anObj)
```
    Return true if the argument is equal to this QueryObject, false otherwise.
    
    Overrides:
    
    equals in class Object
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Make a copy of the QueryObject and any QueryObjects referenced by it, with a different id for all new QueryObjects. The copy will still be equal to the original.
    
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - toString
```
public String toString()
```
    Return a string representation of a QueryObject.
    
    Overrides:
    
    toString in class Object
  - toStringFull
```
public String toStringFull()
```
    Return a full string representation of a QueryObject, included all levels.
  - constantToString
```
public String constantToString(int constant)
```
    Return a string showing the given QueryObject constant.
  - toString
```
public static String toString(List aList)
```
    Return a String showing the given list of QueryObjects in abbreviated form.
    
    Parameters:
    
    aList - A List of QueryObjects.
  - toStringFull
```
public static String toStringFull(List aList)
```
    Return a String showing the given list of QueryObjects in full form.
    
    Parameters:
    
    aList - A List of QueryObjects.
  - toStringAbbreviated
```
public static String toStringAbbreviated(List aList)
```
    Return a String showing the given list of QueryObjects in an abbreviated form.
    
    Parameters:
    
    aList - A List of QueryObjects.
  - toString
```
public static String toString(Map aMap)
```
    Return a String showing the given Map of QueryObjects in abbreviated form.
    
    Parameters:
    
    aMap - A Map of QueryObjects as values.
  - toStringFull
```
public static String toStringFull(Map aMap)
```
    Return a String showing the given Map of QueryObjects in full form.
    
    Parameters:
    
    aMap - A Map of QueryObjects as values.
  - toStringAbbreviated
```
public static String toStringAbbreviated(Map aMap)
```
    Return a String showing the given Map of QueryObjects in an abbreviated form.
    
    Parameters:
    
    aMap - A Map of QueryObjects as values.
  - toStringAbbreviated
```
public String toStringAbbreviated()
```
    Return an abbreviated string representation of a QueryObject.
  - toStringOneLevel
```
public String toStringOneLevel()
```
    Return a one-level string representation of a QueryObject without printing out any nested QueryObjects.
  - fieldsToString
```
protected void fieldsToString(StringBuffer aStr)
```
    Append to the given StringBuffer the basic fields in this QueryObject.
  - modify
```
public void modify(int changeValueGeneration,
                   int delta,
                   boolean log)
```
    Modify the QueryObject according to changeValueGeneration and delta.
    
    Parameters:
    
    changeValueGeneration - How to determine the new values Can be one of: QueryObject.INCREMENT QueryObject.NEGATE QueryObject.NULL_NONPRIM_FIELDS If any fields are null and this is INCREMENT or NEGATE then the field is filled in with a random value.
    
    delta - The number to increment or decrement; unused if changeValueGeneration is QueryObject.NEGATE.
    
    log - If true, then log what is being modified, if false don't log since output can be large.
  - modifyWithNewInstance
```
public QueryObject modifyWithNewInstance(int changeValueGeneration,
                                         int delta,
                                         boolean log)
```
    Return a new instance of QueryObject. The returned object's fields are the receiver's field values modified as specified by the change argument. The new instance will have aByteArray of the same size as the receiver's byteArray, and any references to another QueryObject via the aQueryObject field is also set to a new instance, with its fields set according to the changeValueGeneration argument.
    
    Parameters:
    
    changeValueGeneration - How to determine the values of new instance. Can be one of : QueryObject.INCREMENT QueryObject.NEGATE
    
    delta - The number to increment or decrement; unused if changeValueGeneration is QueryObject.NEGATE.
    
    log - If true, then log what is being modified, if false don't log since output can be large.
  - modify
```
public void modify(int depth,
                   int changeValueGeneration,
                   int delta,
                   boolean randomDepth,
                   boolean log)
```
    Modifies the QueryObject at the given depth by changing its values according to changeValueGeneration and delta. The values are directly modified without creating any new QueryObject instances.
    
    Parameters:
    
    depth - Level number of the QueryObject, to be used according to other arguments.
    
    changeValueGeneration - How to determine the values of the modified QueryObject. Can be one of : QueryObject.INCREMENT QueryObject.NEGATE
    
    delta - The number to increment or decrement; unused if changeValueGeneration is QueryObject.NEGATE.
    
    randomDepth - If true then modify a QueryObject at a randomly chosen depth between 1 and depth, if false then modify the QueryObject at the given depth.
    
    log - If true, then log what is being modified, if false don't log since output can be large.
  - modifyWithNewInstance
```
public QueryObject modifyWithNewInstance(int depth,
                                         int changeValueGeneration,
                                         int delta,
                                         boolean randomDepth,
                                         boolean log)
```
    Creates new instance of the root QueryObject and modifies the values of the QueryObject at the given depth by changing its values according to changeValueGeneration and delta. In other words, the only new instance will be the top level QueryObject, but a deepter level QueryObject might be modified and it will not be a new instance. Since the top level QueryObject is a new instance, it could be used in a put to update a region entry.
    
    Parameters:
    
    changeValueGeneration - How to determine the values of the modified QueryObject. Can be one of : QueryObject.INCREMENT QueryObject.NEGATE
    
    delta - The number to increment or decrement; unused if changeValueGeneration is QueryObject.NEGATE.
    
    randomDepth - If true then modify a QueryObject at a randomly chosen depth between 1 and depth, if false then modify the QueryObject at the given depth.
    
    log - If true, then log what is being modified, if false don't log since output can be large.
  - depth
```
public int depth()
```
    Return the depth of the QueryObject.
  - getAtDepth
```
public QueryObject getAtDepth(int depth)
```
    Return the QueryObject at the given depth. For example, if depth is 1, then return this. If depth is 3, then return the QueryObject that is qo.aQueryObject.aQueryObject.
    
    Parameters:
    
    depth - The desired depth of the QueryObject.
    
    Returns:
    
    The QueryObject at the given depth or null if the QueryObject is not deep enough for depth.
  - hasEqualId
```
public boolean hasEqualId(QueryObject anObj)
```
    Return true if the two QueryObjects have the same id, false otherwise.
  - compareTo
```
public int compareTo(Object anObj)
```
    Specified by:
    
    compareTo in interface Comparable
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Test QueryObject methods
    
    Throws:
    
    Exception

Class QueryObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

myVersion

aPrimitiveLong

aLong

aPrimitiveInt

anInteger

aPrimitiveShort

aShort

aPrimitiveFloat

aFloat

aPrimitiveDouble

aDouble

aPrimitiveByte

aByte

aPrimitiveChar

aCharacter

aPrimitiveBoolean

aBoolean

aString

aByteArray

aQueryObject

extra

id

EQUAL_VALUES

SEQUENTIAL_VALUES

RANDOM_VALUES

INCREMENT

NEGATE

NULL_NONPRIM_FIELDS

Constructor Detail

QueryObject

QueryObject

Method Detail

fillInBaseValues

hashCode

equals

clone

toString

toStringFull

constantToString

toString

toStringFull

toStringAbbreviated

toString

toStringFull

toStringAbbreviated

toStringAbbreviated

toStringOneLevel

fieldsToString

modify

modifyWithNewInstance

modify

modifyWithNewInstance

depth

getAtDepth

hasEqualId

compareTo

main