Query

java.lang.Object
- arlut.csd.ganymede.common.Query

All Implemented Interfaces:

java.io.Serializable
```
public class Query
extends java.lang.Object
implements java.io.Serializable
```
The Query class is used to submit query requests to the GANYMEDE server, both for complex database searches and for simple object listings. A Query class can fully specify a boolean search expression on any field of any object type in the GANYMEDE database. Each Query, however, can only search one object type at a time.

While providing support for arbitrarily complex queries, the Query class also includes constructors for the simple "list object" case.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) QueryDescriber`	`describer` If we are on the server, we'll have a generic reference to a GanymedeSession so that we can look up the description of the object type.
`boolean`	`editableOnly` If true, this query will only be matched against objects in the database that the user has permission to edit.
`boolean`	`filtered` If true, this query will only be matched against the subset of objects in the database that the user has requested via the Session filter mechanism.
`java.lang.String`	`objectName` The name of the object type that the queryNodes are looking to match on.
`short`	`objectType` The id of the object type that the queryNodes are looking to match on.
`private java.util.Set<java.lang.Short>`	`permitSet` A Set of field id's in Short form that the server will take into account when returning a data dump.
`QueryNode`	`root` The root of a graph of QueryNodes that encodes the desired search criteria.
`java.lang.String`	`saveName` We want to be able to save a query on the server and re-issue it on behalf of the user.
`(package private) static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description
`Query(short objectType)` Constructor for a query to list all editable objects of the specified type.
`Query(short objectType, QueryNode root)` Constructor to create a query returning only editable objects (base by id)
`Query(short objectType, QueryNode root, boolean editableOnly)` Constructor for fully specified query (base by id)
`Query(java.lang.String objectName)` Constructor for a query to list all editable objects of the specified type.
`Query(java.lang.String objectName, QueryNode root)` Constructor to create a query returning only editable objects (base by name)
`Query(java.lang.String objectName, QueryNode root, boolean editableOnly)` Constructor for fully specified query (base by name)

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addField(short id)` This method adds a field identifier to the list of fields that may be returned.
`java.lang.String`	`describeField(short fieldId)`
`java.util.Set<java.lang.Short>`	`getFieldSet()` Returns a copy of the restricted list of fields that this Query wants to have returned.
`boolean`	`hasPermitSet()` This method returns true if this Query is requesting a restricted set of fields.
`void`	`removeField(short id)` This method adds a field identifier to the list of fields that may be returned.
`void`	`resetPermitSet()` This method resets the permitSet, allowing all fields to be returned by default.
`boolean`	`returnField(short id)` This method returns true if the field with the given id number should be returned.
`boolean`	`returnField(java.lang.Short value)` This method returns true if the field with the given id number should be returned.
`void`	`setDescriber(QueryDescriber describer)` Sets a reference to a GanymedeSession on the server only, for use in providing more descriptive toString() results.
`void`	`setFiltered(boolean filtered)` This method determines whether the query engine will filter the query according to the current list of visible owner groups.
`java.lang.String`	`toString()`

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

- Field Detail
  - serialVersionUID
```
static final long serialVersionUID
```
    See Also:
    Constant Field Values
  - objectType
```
public short objectType
```
    The id of the object type that the queryNodes are looking to match on.
    
    If this value is left at -1, objectName will be consulted instead.
  - objectName
```
public java.lang.String objectName
```
    The name of the object type that the queryNodes are looking to match on.
    
    This value is consulted only if objectType is left at -1.
  - saveName
```
public java.lang.String saveName
```
    We want to be able to save a query on the server and re-issue it on behalf of the user. If we are saved, the name to save under will be here. We may or may not want it here.
    
    I don't believe anything in the server actually uses this yet.
  - root
```
public QueryNode root
```
    The root of a graph of QueryNodes that encodes the desired search criteria.
  - editableOnly
```
public boolean editableOnly
```
    If true, this query will only be matched against objects in the database that the user has permission to edit.
  - filtered
```
public boolean filtered
```
    If true, this query will only be matched against the subset of objects in the database that the user has requested via the Session filter mechanism.
  - permitSet
```
private java.util.Set<java.lang.Short> permitSet
```
    A Set of field id's in Short form that the server will take into account when returning a data dump. If null, all default fields should be returned.
  - describer
```
transient QueryDescriber describer
```
    If we are on the server, we'll have a generic reference to a GanymedeSession so that we can look up the description of the object type.
- Constructor Detail
  - Query
```
public Query(short objectType,
     QueryNode root,
     boolean editableOnly)
```
    Constructor for fully specified query (base by id)
    
    Parameters:
    objectType - numeric object type code to search over
    root - root node of a boolean logic tree to be processed in an in-order traversal
    editableOnly - if true, the server will only return objects that the user's session currently has permission to edit
  - Query
```
public Query(java.lang.String objectName,
     QueryNode root,
     boolean editableOnly)
```
    Constructor for fully specified query (base by name)
    
    Parameters:
    objectName - name of object type to query
    root - root node of a boolean logic tree to be processed in an in-order traversal
    editableOnly - if true, the server will only return objects that the user's session currently has permission to edit
  - Query
```
public Query(short objectType,
     QueryNode root)
```
    Constructor to create a query returning only editable objects (base by id)
    
    Parameters:
    objectType - numeric object type code to search over
    root - root node of a boolean logic tree to be processed in an in-order traversal
  - Query
```
public Query(java.lang.String objectName,
     QueryNode root)
```
    Constructor to create a query returning only editable objects (base by name)
    
    Parameters:
    objectName - name of object type to query
    root - root node of a boolean logic tree to be processed in an in-order traversal
  - Query
```
public Query(short objectType)
```
    Constructor for a query to list all editable objects of the specified type.
    
    Parameters:
    objectType - numeric object type code to search over
  - Query
```
public Query(java.lang.String objectName)
```
    Constructor for a query to list all editable objects of the specified type.
    
    Parameters:
    objectName - name of object type to query
- Method Detail
  - setDescriber
```
public void setDescriber(QueryDescriber describer)
```
    Sets a reference to a GanymedeSession on the server only, for use in providing more descriptive toString() results.
  - setFiltered
```
public void setFiltered(boolean filtered)
```
    This method determines whether the query engine will filter the query according to the current list of visible owner groups. Queries by default are filtered.
    
    Parameters:
    filtered - If true, the query will be masked by ownership
    See Also:
    Session.filterQueries(java.util.Vector)
  - resetPermitSet
```
public void resetPermitSet()
```
    This method resets the permitSet, allowing all fields to be returned by default.
  - hasPermitSet
```
public boolean hasPermitSet()
```
    This method returns true if this Query is requesting a restricted set of fields.
  - addField
```
public void addField(short id)
```
    This method adds a field identifier to the list of fields that may be returned. Once this method is called with a field identifier, the query will only return fields that have been explicitly added.
    
    resetPermitSet() may be called to reset the list to the initial allow-all state.
  - removeField
```
public void removeField(short id)
```
    This method adds a field identifier to the list of fields that may be returned. Once this method is called with a field identifier, the query will only return fields that have been explicitly added.
    
    resetPermitSet() may be called to reset the list to the initial allow-all state.
  - returnField
```
public boolean returnField(short id)
```
    This method returns true if the field with the given id number should be returned.
  - returnField
```
public boolean returnField(java.lang.Short value)
```
    This method returns true if the field with the given id number should be returned.
  - getFieldSet
```
public java.util.Set<java.lang.Short> getFieldSet()
```
    Returns a copy of the restricted list of fields that this Query wants to have returned.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - describeField
```
public java.lang.String describeField(short fieldId)
```

Class Query

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

objectType

objectName

saveName

root

editableOnly

filtered

permitSet

describer

Constructor Detail

Query

Query

Query

Query

Query

Query

Method Detail

setDescriber

setFiltered

resetPermitSet

hasPermitSet

addField

removeField

returnField

returnField

getFieldSet

toString

describeField