|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.datatools.connectivity.oda.spec.util.QuerySpecificationHelper
public class QuerySpecificationHelper
The helper that locates the factory class, associated
with an org.eclipse.datatools.connectivity.oda.dynamicResultSet extension,
to create and/or access the content of a QuerySpecification
.
Provides convenient methods to create and access specification instances.
Constructor Summary | |
---|---|
QuerySpecificationHelper(ExtensionContributor contributor)
Constructor for use with the specified dynamicResultSet extension contributor. |
|
QuerySpecificationHelper(QuerySpecificationFactory factory)
Constructor for use with the specified query specification factory. |
|
QuerySpecificationHelper(java.lang.String dynamicResultSetExtnId)
Constructor for use with the specified dynamicResultSet extension id. |
Method Summary | |
---|---|
AdvancedQuerySpecification |
createAdvancedQuerySpecification()
Returns an empty advanced query specification instance created by the QuerySpecificationFactory specified in the constructor. |
QuerySpecification |
createQuerySpecification()
Returns an empty query specification instance created by the QuerySpecificationFactory specified in the constructor. |
QuerySpecification |
createQuerySpecification(FilterExpression filterExpr)
Creates a query specification instance with the specified filter expression root. |
QuerySpecification |
createQuerySpecification(FilterExpression filterExpr,
ResultProjection projectionSpec,
SortSpecification sortSpec)
Creates a query specification instance with the specified filter expression root, result projection, and/or sort specification. |
QuerySpecification |
createQuerySpecification(ResultProjection projectionSpec)
Creates a query specification instance with the specified result projection. |
QuerySpecification |
createQuerySpecification(SortSpecification sortSpec)
Creates a query specification instance with the specified sort specification. |
ResultProjection |
createResultProjection()
Returns an empty result projection instance created by the QuerySpecificationFactory specified in the constructor. |
ResultSetSpecification |
createResultSetSpecification()
Returns an empty result set specification instance created by the QuerySpecificationFactory specified in the constructor. |
SortSpecification |
createSortSpecification()
Returns an empty sort specification instance created by the QuerySpecificationFactory specified in the constructor. |
SortSpecification |
createSortSpecification(int sortMode)
Returns an empty sort specification instance created by the QuerySpecificationFactory specified in the constructor. |
static java.lang.String |
getContentAsString(QuerySpecification querySpec)
Returns the string representation of the content found in the specified QuerySpecification. |
QuerySpecificationFactory |
getFactory()
Gets the associated query specification factory instance. |
static FilterExpression |
getFilterSpecification(QuerySpecification querySpec)
Gets the filter expression root from the specified querySpec. |
static java.util.logging.Logger |
getLogger(java.lang.String loggerName)
Gets a Logger by the specified name. |
static ResultProjection |
getResultProjection(QuerySpecification querySpec)
Gets the result projection from the specified querySpec. |
static ResultSetSpecification |
getResultSetSpecification(QuerySpecification querySpec)
Gets the result set specification from the specified querySpec. |
static SortSpecification |
getSortSpecification(QuerySpecification querySpec)
Gets the sort specification from the specified querySpec. |
static void |
logValidationException(java.lang.String className,
java.lang.Throwable exception)
Logs the validation exception message at the FINE log level. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public QuerySpecificationHelper(java.lang.String dynamicResultSetExtnId)
dynamicResultSetExtnId
- the id of an extension that implements
the oda.dynamicResultSet extension point;
may be null to use the default factorypublic QuerySpecificationHelper(ExtensionContributor contributor)
contributor
- contributor of a dynamicResultSet extension;
may be null to use the default factorypublic QuerySpecificationHelper(QuerySpecificationFactory factory)
factory
- the factory to create instances of query specification classesMethod Detail |
---|
public QuerySpecificationFactory getFactory()
public QuerySpecification createQuerySpecification(FilterExpression filterExpr)
filterExpr
- a composite or atomic FilterExpression with corresponding variable
and argument values; may be null
QuerySpecification
instancepublic QuerySpecification createQuerySpecification(ResultProjection projectionSpec)
projectionSpec
- the projection specification of a query result set; may be null
QuerySpecification
instancepublic QuerySpecification createQuerySpecification(SortSpecification sortSpec)
sortSpec
- the SortSpecification representing sorting characteristics
of a query result set; may be null
QuerySpecification
instancepublic QuerySpecification createQuerySpecification(FilterExpression filterExpr, ResultProjection projectionSpec, SortSpecification sortSpec)
filterExpr
- a composite or atomic FilterExpression with corresponding variable
and argument values; may be nullprojectionSpec
- the projection specification of a query result set; may be nullsortSpec
- the SortSpecification representing sorting characteristics; may be null
of a query result set
QuerySpecification
instancepublic QuerySpecification createQuerySpecification()
QuerySpecification
instancepublic AdvancedQuerySpecification createAdvancedQuerySpecification()
AdvancedQuerySpecification
instancepublic ResultSetSpecification createResultSetSpecification()
ResultSetSpecification
instancepublic ResultProjection createResultProjection()
ResultProjection
instancepublic SortSpecification createSortSpecification()
SortSpecification
instancepublic SortSpecification createSortSpecification(int sortMode)
sortMode
- the sort mode of this SortSpecification
; one of
IDataSetMetaData.sortModeNone
,
IDataSetMetaData.sortModeSingleOrder
,
IDataSetMetaData.sortModeColumnOrder
,
IDataSetMetaData.sortModeSingleColumn
.
SortSpecification
instance with the defined mode,public static FilterExpression getFilterSpecification(QuerySpecification querySpec)
querySpec
- a query specification
public static ResultProjection getResultProjection(QuerySpecification querySpec)
querySpec
- a query specification
public static SortSpecification getSortSpecification(QuerySpecification querySpec)
querySpec
- a query specification
public static ResultSetSpecification getResultSetSpecification(QuerySpecification querySpec)
querySpec
- a query specification
public static java.lang.String getContentAsString(QuerySpecification querySpec)
querySpec
- a query specification
public static java.util.logging.Logger getLogger(java.lang.String loggerName)
loggerName
- the name of logger
public static void logValidationException(java.lang.String className, java.lang.Throwable exception)
className
- name of class that initiates the loggingexception
- validation exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |