Interface Query
-
- All Known Implementing Classes:
AbstractQuery,LdapQuery,SqlQuery
public interface Query
<p>Data interrogation query class.</p> <p>Defines an interrogation query (SQL select, LDAP search, ...) on a specified data source, with optional parameters, which returns either a single result (i.e. name of a person in a LDAP directory), or a list of multiple structured results (i.e. list of products from a SQL database). </p>
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classQuery.ResultTypeQuery result type.
-
Field Summary
Fields Modifier and Type Field Description static PatternPARAMETER_MATCHERParameter matcher.static StringPARAMETER_PATTERNParameter pattern.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Map<String,String>getAdditionalConfiguration()Get the additional query configuration information.StringgetDataSourceId()Get the id of datasource on which depends this query.StringgetDescription()Get the query description.StringgetFactory()Get the id of source factoryStringgetId()Get the query ID.StringgetName()Get the query name.Map<String,String>getParameters()Get the query parameter names.Query.ResultTypegetResultType()Get the query result type.DataSourceClientInteraction.DataSourceTypegetType()Get the query type.
-
-
-
Field Detail
-
PARAMETER_PATTERN
static final String PARAMETER_PATTERN
Parameter pattern.- See Also:
- Constant Field Values
-
PARAMETER_MATCHER
static final Pattern PARAMETER_MATCHER
Parameter matcher.
-
-
Method Detail
-
getDescription
String getDescription()
Get the query description.- Returns:
- the query description.
-
getType
DataSourceClientInteraction.DataSourceType getType()
Get the query type.- Returns:
- the query type.
-
getFactory
String getFactory()
Get the id of source factory- Returns:
- the id of source factory
-
getParameters
Map<String,String> getParameters()
Get the query parameter names.- Returns:
- the query parameter names as a Collection.
-
getResultType
Query.ResultType getResultType()
Get the query result type.- Returns:
- the query result type.
-
getAdditionalConfiguration
Map<String,String> getAdditionalConfiguration()
Get the additional query configuration information.- Returns:
- the additional query configuration information as a Map of String -> String.
-
getDataSourceId
String getDataSourceId()
Get the id of datasource on which depends this query.- Returns:
- the datasource on which depends this query.
-
-