|
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.XEngine
inetsoft.uql.service.RemoteEngine
public class RemoteEngine
Specialization of XEngine that delegates all query execution and meta-data retrieval to the server.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class inetsoft.uql.service.XEngine |
|---|
XEngine.MetaDataLoader |
| Nested classes/interfaces inherited from interface inetsoft.uql.XRepository |
|---|
XRepository.MetaDataListener |
| Field Summary |
|---|
| Fields inherited from interface inetsoft.uql.XQueryRepository |
|---|
GLOBAL_SCOPE, LOCAL_QUERY, LOCAL_SCOPE, NORMAL_QUERY |
| Constructor Summary | |
|---|---|
RemoteEngine()
Creates a new instance of RemoteEngine. |
|
| Method Summary | |
|---|---|
Object |
bind(Object uinfo)
Connect to the data service. |
void |
clearCache()
Clear cached data. |
void |
close(Object session)
Close an active session. |
void |
connect(Object session,
String query,
VariableTable params)
Initialize a data source connection. |
void |
connect(Object session,
XDataSource dx,
VariableTable params)
Initialize a data source connection. |
XNode |
execute(Object session,
XQuery xquery,
VariableTable vars,
Principal user,
boolean resetVariables,
inetsoft.util.DataCacheVisitor visitor)
Execute the query and return the result set. |
UserVariable[] |
getConnectionParameters(Object session,
String query)
Get the parameters for a data source. |
UserVariable[] |
getConnectionParameters(Object session,
XDataSource dx)
Get the parameters for a data source. |
UserVariable[] |
getConnectionParameters(Object session,
XQuery xquery)
Get the parameters for a data source. |
XHandler |
getHandler(Object session,
XDataSource dx,
VariableTable params)
Get the handler. |
XNode |
getMetaData(Object session,
XDataSource dx,
XNode mtype,
boolean clone)
Build the meta data of this data source as a XNode tree. |
UserVariable[] |
getQueryParameters(Object session,
String query,
boolean promptOnly)
Get the parameters for a query. |
UserVariable[] |
getQueryParameters(Object session,
XQuery xquery,
boolean promptOnly)
Get the parameters for a query. |
void |
refreshMetaData()
Clear the cached meta data. |
void |
refreshMetaData(String dxName)
Refresh matadata of a datasource. |
void |
testDataSource(Object session,
XDataSource dx,
VariableTable params)
Test a data source connection. |
void |
updateDataSource(XDataSource dx,
String oname)
Add or replace a data source in the repository. |
void |
updateDataSource(XDataSource dx,
String oname,
Boolean actionRecord)
Add or replace a data source in the repository. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public RemoteEngine()
| Method Detail |
|---|
public Object bind(Object uinfo)
throws RemoteException
bind in interface XDataServicebind in class XEngineuinfo - user info.
RemoteException
public UserVariable[] getConnectionParameters(Object session,
String query)
throws RemoteException
getConnectionParameters in interface XDataServicegetConnectionParameters in class XEnginesession - session object.query - query name.
RemoteException
public UserVariable[] getConnectionParameters(Object session,
XQuery xquery)
throws RemoteException
getConnectionParameters in interface XDataServicegetConnectionParameters in class XEnginesession - session object.xquery - query to get connection parameters.
RemoteException
public UserVariable[] getConnectionParameters(Object session,
XDataSource dx)
throws RemoteException
getConnectionParameters in interface XDataServicegetConnectionParameters in class XEnginesession - session object.dx - data source to get connection parameters.
RemoteException
public UserVariable[] getQueryParameters(Object session,
String query,
boolean promptOnly)
throws RemoteException
getQueryParameters in interface XDataServicegetQueryParameters in class XEnginesession - session object.query - query name.promptOnly - true if only include the user variables that
are declared as 'Prompt User'.
RemoteException
public UserVariable[] getQueryParameters(Object session,
XQuery xquery,
boolean promptOnly)
throws RemoteException
getQueryParameters in interface XDataServicegetQueryParameters in class XEnginesession - session object.xquery - query to get parameters.promptOnly - true if only include the user variables that
are declared as 'Prompt User'.
RemoteException
public void testDataSource(Object session,
XDataSource dx,
VariableTable params)
throws Exception
testDataSource in interface XDataServicetestDataSource in class XEnginesession - session object.dx - the specified data source.params - connection parameters.
Exception
public void connect(Object session,
String query,
VariableTable params)
throws Exception
connect in interface XDataServiceconnect in class XEnginesession - session object.query - query name.params - connection parameters.
Exception
public void connect(Object session,
XDataSource dx,
VariableTable params)
throws Exception
connect in interface XDataServiceconnect in class XEnginesession - session object.dx - the specified data source.params - connection parameters.
Exception
public XHandler getHandler(Object session,
XDataSource dx,
VariableTable params)
throws Exception
getHandler in interface XDataServicegetHandler in class XEnginesession - the specified session object.dx - the specified data source.params - the specified variable table.
Exception
public XNode execute(Object session,
XQuery xquery,
VariableTable vars,
Principal user,
boolean resetVariables,
inetsoft.util.DataCacheVisitor visitor)
throws Exception
execute in interface XDataServiceexecute in class XEnginesession - session object.xquery - query to execute.vars - variable values for the query.user - a Principal object that identifies the user executing the
query.resetVariables - true if should reset cached variables.visitor - used to process cache facility.
Exception
public void close(Object session)
throws RemoteException
close in interface XDataServiceclose in class XEnginesession - session object.
RemoteException
public XNode getMetaData(Object session,
XDataSource dx,
XNode mtype,
boolean clone)
throws Exception
getMetaData in interface XRepositorygetMetaData in class XEnginesession - session object.dx - data source.mtype - meta data type, defined in each data source.clone - true to clone the cached node.
Exceptionpublic void clearCache()
clearCache in interface XRepositoryclearCache in class XEnginepublic void refreshMetaData(String dxName)
refreshMetaData in interface XRepositoryrefreshMetaData in class XEnginedxName - the specified datasource name.public void refreshMetaData()
refreshMetaData in interface XRepositoryrefreshMetaData in class XEngine
public void updateDataSource(XDataSource dx,
String oname)
throws Exception
updateDataSource in interface XRepositoryupdateDataSource in class XEnginedx - new data source.oname - old name of the data source, if the name has been changed.
Otherwise it should be null.
Exception
public void updateDataSource(XDataSource dx,
String oname,
Boolean actionRecord)
throws Exception
updateDataSource in interface XRepositoryupdateDataSource in class XEnginedx - new data source.oname - old name of the data source, if the name has been changed.
Otherwise it should be null.actionRecord - control whether write down audit record when remote
in designer.
Otherwise it should be null.
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 | ||||||||