| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.datatools.connectivity.oda.spec.QuerySpecification
public class QuerySpecification
Specification of the query characteristics to apply when preparing and executing 
 an IQuery.
| Nested Class Summary | |
|---|---|
|  class | QuerySpecification.ParameterIdentifierThe identifier of a data set query parameter, defined by its native name and/or id (1-based). | 
| Method Summary | |
|---|---|
|  java.lang.Object | getParameterValue(int parameterId)Gets the input value(s) of a data set query parameter, identified by its native name. | 
|  java.lang.Object | getParameterValue(QuerySpecification.ParameterIdentifier paramIdentifier)Gets the input value(s) of a data set query parameter, identified by native name or id. | 
|  java.lang.Object | getParameterValue(java.lang.String parameterName)Gets the input value(s) of a data set query parameter, identified by its native name. | 
|  java.util.Map<QuerySpecification.ParameterIdentifier,java.lang.Object> | getParameterValues()Gets the values of all input parameters of the associated IQuery, with  
 each parameter identified by name or id as the key to its corresponding input value(s). | 
|  java.util.Map<java.lang.String,java.lang.Object> | getProperties()Gets the values of all data set query properties, with each property name as the key to its corresponding value(s). | 
|  java.lang.Object | getProperty(java.lang.String propertyName)Gets the value(s) of a data set query property. | 
|  ResultSetSpecification | getResultSetSpecification()Gets the current result set specification of an IQuery. | 
|  boolean | hasResultSetSpecification()Indicates whether this contains a ResultSetSpecification with a non-empty content. | 
|  void | setParameterValue(int parameterId,
                  java.lang.Object value)Specifies the input value(s) of a data set query parameter, identified by its id. | 
|  void | setParameterValue(QuerySpecification.ParameterIdentifier paramIdentifier,
                  java.lang.Object value)Specifies the input value(s) of a data set query parameter, identified by native name or id. | 
|  void | setParameterValue(java.lang.String parameterName,
                  java.lang.Object value)Specifies the input value(s) of a data set query parameter, identified by its native name. | 
|  void | setParameterValues(java.util.Map<QuerySpecification.ParameterIdentifier,java.lang.Object> paramValues)Specifies the values of all input parameters of the associated IQuery, with  
 each parameter identified by name or id as the key to its corresponding input value(s). | 
|  void | setProperties(java.util.Map<java.lang.String,java.lang.Object> propertyMap)Specifies the values of all data set query properties, with each property name as the key to its corresponding value(s). | 
|  void | setProperty(java.lang.String propertyName,
            java.lang.Object value)Specifies the value(s) of a data set query property, overriding existing values if any. | 
|  void | setResultSetSpecification(ResultSetSpecification resultSpec)Specifies the characteristics of all the result set(s) to be retrieved by the associated IQuery. | 
|  void | validate(ValidationContext context)Validates this in the specified context. | 
| Methods inherited from class java.lang.Object | 
|---|
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Method Detail | 
|---|
public void setProperty(java.lang.String propertyName,
                        java.lang.Object value)
Collection.
 The property value specified here may be the same as the value set separately
 by IQuery.setProperty(String, String),
 which is set after a query is prepared.  
 
propertyName - name of the propertyvalue - the value of the specified property; may be nullpublic java.lang.Object getProperty(java.lang.String propertyName)
Collection.
 The property value specified here may be the same as the value set separately
 by IQuery.setProperty(String, String), 
 which is set after a query is prepared.  
 
propertyName - name of the property
public void setProperties(java.util.Map<java.lang.String,java.lang.Object> propertyMap)
Collection.
 The property values specified here may be the same as those set separately
 by IQuery.setProperty(String, String), 
 which are set after a query is prepared.  
 
propertyMap - a Map of data set query properties in name-value pairspublic java.util.Map<java.lang.String,java.lang.Object> getProperties()
Collection.
 The property values specified here may be the same as those set separately
 by IQuery.setProperty(String, String), 
 which are set after a query is prepared.  
 
Map of all currently specified data set query properties 
          with each property name as the key to its corresponding value(s); 
          may be empty if no property value is specified
public void setParameterValue(java.lang.String parameterName,
                              java.lang.Object value)
Collection.
 The parameter value specified here may be the same as the value set separately
 by a query's set by data type method, which is set after a query is prepared.
 
parameterName - native name of the parametervalue - input value of the specified parametersetParameterValue(int, Object)
public void setParameterValue(int parameterId,
                              java.lang.Object value)
Collection.
 The parameter value specified here may be the same as the value set separately
 by a query's set by data type method, which is set after a query is prepared.
 
parameterId - id of the parameter (1-based)value - input value of the specified parametersetParameterValue(String, Object)
public void setParameterValue(QuerySpecification.ParameterIdentifier paramIdentifier,
                              java.lang.Object value)
paramIdentifier - a QuerySpecification.ParameterIdentifier
                          that identifies an input parameter by its native name or id (1-based)value - input value of the specified parametersetParameterValue(String, Object), 
setParameterValue(int, Object)public java.lang.Object getParameterValue(java.lang.String parameterName)
Collection.
 The parameter value specified here may be the same as the value set separately
 by a query's set by data type method, which is set after a query is prepared.
 
parameterName - native name of the parameter
getParameterValue(int)public java.lang.Object getParameterValue(int parameterId)
Collection.
 The parameter value specified here may be the same as the value set separately
 by a query's set by data type method, which is set after a query is prepared.
 
parameterId - id of the parameter (1-based)
getParameterValue(String)public java.lang.Object getParameterValue(QuerySpecification.ParameterIdentifier paramIdentifier)
paramIdentifier - a QuerySpecification.ParameterIdentifier
                          that identifies an input parameter by its native name or id (1-based)
getParameterValue(String), 
getParameterValue(int)public void setParameterValues(java.util.Map<QuerySpecification.ParameterIdentifier,java.lang.Object> paramValues)
IQuery, with  
 each parameter identified by name or id as the key to its corresponding input value(s).
 Collection.
 The parameter values specified here may be the same as those set separately
 by a query's set by data type methods, which are set after a query is prepared.
 
paramValues - a Map of QuerySpecification.ParameterIdentifier as the key 
              to its corresponding input value(s)public java.util.Map<QuerySpecification.ParameterIdentifier,java.lang.Object> getParameterValues()
IQuery, with  
 each parameter identified by name or id as the key to its corresponding input value(s).
 Collection.
 The parameter values specified here may be the same as those set separately
 by a query's set by data type methods, which are set after a query is prepared.
 
Map of all currently specified data set query parameters 
          with each QuerySpecification.ParameterIdentifier as the key 
          to its corresponding input value(s);
          may be empty if no parameter value is specifiedpublic void setResultSetSpecification(ResultSetSpecification resultSpec)
IQuery.
resultSpec - specification of a query's result set(s)public ResultSetSpecification getResultSetSpecification()
IQuery.
ResultSetSpecification, or null if not specifiedpublic boolean hasResultSetSpecification()
public void validate(ValidationContext context)
              throws OdaException
context - context for validation; may be null which would limit the scope of validation
OdaException - if validation failed.  The exception thrown may be a chained OdaException, 
          which identifies each of those specification component(s) that has caused 
          the validation exception.org.eclipse.datatools.connectivity.oda.spec.util.ValidatorUtil}| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||