|
Query |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.sas.iquery.dataretrieval.SimpleQueryConnector
public class SimpleQueryConnector
A basic query connector without result or connection management.
Please don't instantiate this class directly! Consumers should use the
QueryConnector
subclass or
QueryConnectorInterface
.
See the package-level documentation for com.sas.iquery.dataretrieval
for
examples of how to use the query connector.
QueryConnectorInterface
,
QueryConnector
Method Summary | |
---|---|
java.util.Locale |
getComputationalLocale()
Returns the Locale to override all query computations submitted
or null if the computation locale of the query is not to be overridden. |
java.util.Map<java.lang.String,com.sas.iquery.metadata.physical.MLSLookup> |
getMLSLookups()
returns the MLSLookup definitions map, keyed by output column name (RSID) If MLS is disabled then this returns null. |
java.lang.String |
getPhysicalQuery(BusinessQuery businessQuery)
Returns the generated query as a string, excluding connection information. |
java.lang.String |
getResultSetStructure(BusinessQuery businessQuery)
Returns information about the structure of a result set. |
RetrievalPolicy |
getRetrievalPolicy()
Returns the query connector's current retrieval policy as last set by the setRetrievalPolicy(RetrievalPolicy) method or
the default if not explicitly set. |
com.sas.iquery.execution.instructions.StpNames |
getStpNames()
Returns the stored process assigned names cache. |
boolean |
isMultipleLanguageSupportEnabled()
Enables Multiple Language Support for output results. |
protected com.sas.iquery.dataretrieval.QueryContainer |
newQueryContainer(BusinessQuery businessQuery,
RetrievalPolicy retrievalPolicy)
The query container acts as a parameter object between: a. |
ResultSetInterface |
retrieveQueryResult(BusinessQuery query)
|
java.util.Map<java.lang.String,ResultSetInterface> |
retrieveQueryResultMap(java.util.List<? extends BusinessQuery> queries)
Creates a map of query results (ResultSetInterface), based on a list of input business queries. |
java.util.Map<java.lang.String,ResultSetInterface> |
retrieveQueryResultMap(java.util.List<? extends BusinessQuery> queries,
RetrievalPolicy retrievalPolicy)
Creates a map of query results, based on a list of input business queries. |
void |
setComputationalLocale(java.util.Locale overrideComputationalLocale)
Sets the Locale to override all query computations submitted
or if the computation locale of the query is not to be overridden then use null . |
void |
setMLSLookups(java.util.Map<java.lang.String,com.sas.iquery.metadata.physical.MLSLookup> mlsLookupsByColumnName)
sets the Overriding MLSLookup definitions map, keyed by output column name (RSID) (null to use NONE, empty to auto-generate and return the lookup defs). |
void |
setMultipleLanguageSupportEnabled(boolean enabled)
Enables or disables Multiple Language Support for output results. |
void |
setRetrievalPolicy(RetrievalPolicy policy)
Sets a retrieval policy on the query connector. |
void |
setStpNames(com.sas.iquery.execution.instructions.StpNames stpNames)
sets the stored process assigned names cache. |
Method Detail |
---|
public RetrievalPolicy getRetrievalPolicy()
setRetrievalPolicy(RetrievalPolicy)
method or
the default if not explicitly set.
public void setRetrievalPolicy(RetrievalPolicy policy)
This retrieval policy will be used if the retrieveQueryResultMap(List)
method is called.
@Nonnull public java.util.Map<java.lang.String,ResultSetInterface> retrieveQueryResultMap(java.util.List<? extends BusinessQuery> queries, RetrievalPolicy retrievalPolicy) throws DataRetrievalException
The keys of the resulting map are the ID's of the input business queries. Use the
IntelligentQueryInterface.getID()
method to determine the id.
The input list must fulfill the following requirements:
BusinessQuery
, for example DataSelection
queries
- a list of business queries to executeretrievalPolicy
- the policy to use for executing
ResultSetInterface
results
DataRetrievalException
retrieveQueryResultMap(List)
@Nonnull public ResultSetInterface retrieveQueryResult(@Nonnull BusinessQuery query) throws DataRetrievalException
DataRetrievalException
@Nonnull public java.util.Map<java.lang.String,ResultSetInterface> retrieveQueryResultMap(java.util.List<? extends BusinessQuery> queries) throws DataRetrievalException
Uses the retrieval policy returned by getRetrievalPolicy()
.
BusinessQuery
queries
- a list of business queries to execute
ResultSetInterface
results
DataRetrievalException
retrieveQueryResultMap(List,RetrievalPolicy)
public java.lang.String getPhysicalQuery(BusinessQuery businessQuery) throws com.sas.iquery.intelligentquery.IntelligentQueryException
businessQuery
- The business query to generate code for
com.sas.iquery.intelligentquery.IntelligentQueryException
public java.lang.String getResultSetStructure(BusinessQuery businessQuery) throws com.sas.iquery.intelligentquery.IntelligentQueryException
businessQuery
- The query to examine
com.sas.iquery.intelligentquery.IntelligentQueryException
- If the structure cannot be determinedprotected com.sas.iquery.dataretrieval.QueryContainer newQueryContainer(BusinessQuery businessQuery, RetrievalPolicy retrievalPolicy) throws DataRetrievalException
query
- retrievalPolicy
-
MetadataException
DataRetrievalException
public java.util.Locale getComputationalLocale()
Locale
to override all query computations submitted
or null
if the computation locale of the query is not to be overridden.
getComputationalLocale
in interface com.sas.iquery.execution.OverrideLocaleInterface
QueryConnectorInterface.getComputationalLocale()
,
BusinessModel.getComputationalLocale()
public void setComputationalLocale(java.util.Locale overrideComputationalLocale)
Locale
to override all query computations submitted
or if the computation locale of the query is not to be overridden then use null
.
setComputationalLocale
in interface com.sas.iquery.execution.OverrideLocaleInterface
computationLocale
- Locale to override query computation locale or null
to not override.QueryConnectorInterface.setComputationalLocale(Locale)
,
BusinessModel.setComputationalLocale(Locale)
public com.sas.iquery.execution.instructions.StpNames getStpNames()
OverrideStpNamesInterface
getStpNames
in interface com.sas.iquery.execution.OverrideStpNamesInterface
OverrideStpNamesInterface.getStpNames()
public void setStpNames(com.sas.iquery.execution.instructions.StpNames stpNames)
OverrideStpNamesInterface
setStpNames
in interface com.sas.iquery.execution.OverrideStpNamesInterface
OverrideStpNamesInterface.setStpNames(com.sas.iquery.execution.instructions.StpNames)
public java.util.Map<java.lang.String,com.sas.iquery.metadata.physical.MLSLookup> getMLSLookups()
getMLSLookups
in interface com.sas.iquery.execution.OverrideMLSLookupsInterface
OverrideMLSLookupsInterface.getMLSLookups()
public void setMLSLookups(java.util.Map<java.lang.String,com.sas.iquery.metadata.physical.MLSLookup> mlsLookupsByColumnName)
setMLSLookups
in interface com.sas.iquery.execution.OverrideMLSLookupsInterface
OverrideMLSLookupsInterface.setMLSLookups(java.util.Map)
public void setMultipleLanguageSupportEnabled(boolean enabled)
enabled
- public boolean isMultipleLanguageSupportEnabled()
enabled
-
|
Query |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |