|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.uql.service.XHandler
public abstract class XHandler
XHandler defines the API for query handlers. A handler is responsible for a particular protocol. All interfaces to a data source, including connection, meta data retrieval, and query execution are processed through a handler.
| Field Summary | |
|---|---|
protected XRepository |
repository
|
protected Object |
session
|
| Constructor Summary | |
|---|---|
XHandler()
|
|
| Method Summary | |
|---|---|
abstract void |
close()
Close the data source connection. |
abstract void |
connect(XDataSource datasource,
VariableTable params)
Connect to the data source. |
abstract XNode |
execute(XQuery query,
VariableTable params,
Principal user,
inetsoft.util.DataCacheVisitor visitor)
Execute the query. |
abstract XNode |
getMetaData(XNode mtype)
Build the meta data of this data source as a XNode tree. |
String |
getQueryKey(XQuery query,
VariableTable qvars,
Principal user)
Get a query key for query caching. |
XNode |
postProcess(XNode root,
XQuery query,
VariableTable params)
Apply max rows to the resultset. |
protected void |
prepareVariableTable(XQuery xquery,
VariableTable vars)
Get the variable table to serve as base table. |
void |
reset()
Clear the internal cached states. |
void |
reset(XQuery query)
Clear the internal cached states of a query. |
void |
setRepository(XRepository repository)
Set the repository associated with this handler. |
void |
setSession(Object session)
Set the session associated with this handler. |
abstract void |
testDataSource(XDataSource datasource,
VariableTable params)
Test the data source. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected Object session
protected XRepository repository
| Constructor Detail |
|---|
public XHandler()
| Method Detail |
|---|
public abstract XNode execute(XQuery query,
VariableTable params,
Principal user,
inetsoft.util.DataCacheVisitor visitor)
throws Exception
params - parameters for query.
Exception
public abstract void connect(XDataSource datasource,
VariableTable params)
throws Exception
datasource - the data source name.params - parameters for connection.
Exception
public abstract void testDataSource(XDataSource datasource,
VariableTable params)
throws Exception
datasource - the data source name.params - parameters for connection.
Exception
public abstract XNode getMetaData(XNode mtype)
throws Exception
mtype - meta data type, defined in each data source.
Exception
public abstract void close()
throws Exception
Exceptionpublic void setSession(Object session)
public void setRepository(XRepository repository)
public void reset()
public void reset(XQuery query)
query - the specified query
public XNode postProcess(XNode root,
XQuery query,
VariableTable params)
throws Exception
Exception
protected void prepareVariableTable(XQuery xquery,
VariableTable vars)
public String getQueryKey(XQuery query,
VariableTable qvars,
Principal user)
throws Exception
Exception
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||