|
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
public class XEngine
This class implements the XRepository (and XDataService) API. It is the query engine that executes queries.
| Nested Class Summary | |
|---|---|
class |
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 | |
|---|---|
XEngine()
Create an query engine. |
|
| 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,
String query,
VariableTable vars)
Deprecated. |
XNode |
execute(Object session,
String query,
VariableTable vars,
boolean resetVariables)
Deprecated. |
XNode |
execute(Object session,
String query,
VariableTable vars,
Principal user)
Deprecated. |
XNode |
execute(Object session,
String query,
VariableTable vars,
Principal user,
boolean resetVariables)
Deprecated. |
XNode |
execute(Object session,
String query,
VariableTable vars,
Principal user,
boolean resetVariables,
inetsoft.util.DataCacheVisitor visitor)
Execute the query and return the result set. |
XNode |
execute(Object session,
XQuery xquery,
VariableTable vars)
Deprecated. |
XNode |
execute(Object session,
XQuery xquery,
VariableTable vars,
boolean resetVariables)
Deprecated. |
XNode |
execute(Object session,
XQuery xquery,
VariableTable vars,
Principal user)
Deprecated. |
XNode |
execute(Object session,
XQuery xquery,
VariableTable vars,
Principal user,
boolean resetVariables)
Deprecated. |
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. |
XDataModel |
getDataModel(String dxname)
Get the data model for the specified data source. |
XDataSource |
getDataSource(String dsname)
Get the named data source. |
XDataSource |
getDataSource(String dsname,
boolean clone)
Get the named data source. |
DataSourceFolder |
getDataSourceFolder(String dsname)
Get the named data source folder. |
DataSourceFolder |
getDataSourceFolder(String dsname,
boolean clone)
Get the named data source folder. |
String[] |
getDataSourceFolderFullNames()
Get all data source folder names in repository. |
String[] |
getDataSourceFolderNames()
Get all data source folder names in repository. |
String[] |
getDataSourceFullNames()
Get full names of all the data sources in this repository. |
String[] |
getDataSourceNames()
Get the names of data sources in this repository. |
XDomain |
getDomain(String dxname)
Get the domain for the specified data source. |
XHandler |
getHandler(Object session,
XDataSource dx,
VariableTable params)
Get the handler. |
XNode |
getMetaData(Object session,
XDataSource dx,
XNode mtype)
Deprecated. |
XNode |
getMetaData(Object session,
XDataSource dx,
XNode mtype,
boolean clone)
Deprecated. |
XNode |
getMetaData(Object session,
XDataSource dx,
XNode mtype,
boolean clone,
XRepository.MetaDataListener listener)
Build the meta data of this data source as a XNode tree. |
XNode |
getMetaDataCache(String key)
Read the cached database meta data from disk. |
Enumeration |
getQueries()
Deprecated. |
XQuery |
getQuery(String qname)
Get the query object for the named query. |
XQuery |
getQuery(String qname,
boolean cloned)
Get the query object for the named query. |
String |
getQueryDatasource(String qname)
Get data source of specified query. |
String |
getQueryFolder(String qname)
Get folder of specified query. |
String[] |
getQueryNames()
Get the names of queries in this repository. |
String[] |
getQueryNames(String ds,
String folder,
boolean checkFolder)
Get names of query in specified data source and folder. |
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. |
int |
getQueryType()
Get query type in the query repository. |
String |
getQueryType(String qname)
Get type of specified query. |
String[] |
getSubDataSourceNames(String path)
Get the children data source from the specified data source folder path. |
String[] |
getSubfolderNames(String path)
Get the children data source folder from the specified data source folder path. |
boolean |
isQueryVisible(String qname)
Return if query is visible or not. |
void |
refreshMetaData()
Clear the cached meta data. |
void |
refreshMetaData(String dxName)
Refresh matadata of a datasource. |
void |
removeDataModel(String datasource)
Remove a data model from the repository. |
void |
removeDataSource(String dxname)
Remove a data source from the repository. |
boolean |
removeDataSource(String dxname,
boolean removeAnyWay)
Remove a data source from the repository. |
boolean |
removeDataSourceFolder(String name)
Remove a data source folder from the repository. |
boolean |
removeDataSourceFolder(String name,
boolean removeAnyWay)
Remove a data source folder from the repository. |
void |
removeDomain(String datasource)
Remove a domain from the repository. |
void |
removeMetaData(String dsname)
Remove meta data files with specified data source. |
void |
removeMetaDataFiles(String key)
Remove meta data files with specified data source. |
void |
removeQuery(String qname)
Remove a query from the repository. |
void |
renameQueryFolder(String nname,
String oname)
Rename a query folder in the repository. |
void |
testDataSource(Object session,
XDataSource dx,
VariableTable params)
Test a data source connection. |
void |
updateDataModel(XDataModel dm)
Add or replace a data model in the repository. |
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. |
void |
updateDataSourceFolder(DataSourceFolder folder,
String oname)
Add or replace a data source folder in the repository. |
void |
updateDomain(XDomain dx)
Add or replace a domain in the repository. |
void |
updateQuery(XQuery dx,
String oname)
Add or replace a query in the repository. |
void |
updateQuery(XQuery dx,
String oname,
Boolean actionRecord)
Add or replace a query in the repository. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public XEngine()
| Method Detail |
|---|
public int getQueryType()
getQueryType in interface XQueryRepositorypublic String[] getDataSourceNames()
getDataSourceNames in interface XRepositorypublic String[] getDataSourceFullNames()
getDataSourceFullNames in interface XRepositorypublic String[] getDataSourceFolderNames()
getDataSourceFolderNames in interface XRepositorypublic String[] getDataSourceFolderFullNames()
getDataSourceFolderFullNames in interface XRepositorypublic XDataSource getDataSource(String dsname)
getDataSource in interface XRepository
public XDataSource getDataSource(String dsname,
boolean clone)
getDataSource in interface XRepositoryclone - true to clone data source, false otherwise.public DataSourceFolder getDataSourceFolder(String dsname)
getDataSourceFolder in interface XRepository
public DataSourceFolder getDataSourceFolder(String dsname,
boolean clone)
getDataSourceFolder in interface XRepositoryclone - true to clone data source folder, false otherwise.
public void updateDataSource(XDataSource dx,
String oname)
throws Exception
updateDataSource in interface XRepositorydx - 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 XRepositorydx - 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
public void updateDataSourceFolder(DataSourceFolder folder,
String oname)
throws Exception
updateDataSourceFolder in interface XRepositoryfolder - new data source folder.oname - old name of the data source folder, if the name has been
changed. Otherwise it should be null.
Exception
public boolean removeDataSource(String dxname,
boolean removeAnyWay)
throws Exception
Exception
public boolean removeDataSourceFolder(String name)
throws Exception
removeDataSourceFolder in interface XRepositoryException
public boolean removeDataSourceFolder(String name,
boolean removeAnyWay)
throws Exception
Exceptionpublic String[] getSubfolderNames(String path)
getSubfolderNames in interface XRepositorypath - the specified data source folder name.
public String[] getSubDataSourceNames(String path)
getSubDataSourceNames in interface XRepositorypath - the specified data source folder name.
public void removeMetaData(String dsname)
public void removeMetaDataFiles(String key)
public void removeDataSource(String dxname)
throws Exception
removeDataSource in interface XRepositoryException
public XDataModel getDataModel(String dxname)
throws RemoteException
getDataModel in interface XRepositorydxname - the name of the data source.
RemoteException
public void updateDataModel(XDataModel dm)
throws RemoteException,
Exception
updateDataModel in interface XRepositorydm - new data model.
RemoteException
Exception
public void removeDataModel(String datasource)
throws RemoteException,
Exception
datasource - the name of the data source which the model represents.
RemoteException
Exception
public XDomain getDomain(String dxname)
throws RemoteException
getDomain in interface XRepositorydxname - the name of the data source.
RemoteException
public void updateDomain(XDomain dx)
throws Exception
updateDomain in interface XRepositorydx - the new domain.
Exception
public void removeDomain(String datasource)
throws Exception
removeDomain in interface XRepositorydatasource - the name of the data source to which the domain is
associated.
Exceptionpublic String[] getQueryNames()
getQueryNames in interface XRepositorypublic String getQueryDatasource(String qname)
getQueryDatasource in interface XRepositorypublic String getQueryFolder(String qname)
getQueryFolder in interface XRepositorypublic String getQueryType(String qname)
getQueryType in interface XRepository
public String[] getQueryNames(String ds,
String folder,
boolean checkFolder)
getQueryNames in interface XRepositorypublic boolean isQueryVisible(String qname)
isQueryVisible in interface XRepository
public Enumeration getQueries()
throws Exception
getQueries in interface XQueryRepositoryExceptionpublic XQuery getQuery(String qname)
getQuery in interface XQueryRepositorygetQuery in interface XRepositoryqname - the specified query name.
public XQuery getQuery(String qname,
boolean cloned)
getQuery in interface XRepository
public void updateQuery(XQuery dx,
String oname)
throws Exception
updateQuery in interface XQueryRepositoryupdateQuery in interface XRepositorydx - new query.oname - old name of the query, if the name has been changed.
Otherwise it should be null.
Exception
public void updateQuery(XQuery dx,
String oname,
Boolean actionRecord)
throws Exception
updateQuery in interface XRepositorydx - new query.oname - old name of the query, if the name has been changed.
Otherwise it should be null.actionRecord - control whether write audit record when remote in
designer.
Otherwise it should be null.
Exception
public void renameQueryFolder(String nname,
String oname)
throws Exception
renameQueryFolder in interface XRepositorynname - new name of query folder.oname - old name of the query folder, if the name has been
changed. Otherwise it should be null.
Exception
public void removeQuery(String qname)
throws Exception
removeQuery in interface XQueryRepositoryremoveQuery in interface XRepositoryException
public Object bind(Object uinfo)
throws RemoteException,
AccessException
bind in interface XDataServiceuinfo - user info.
RemoteException
AccessException
public void close(Object session)
throws RemoteException
close in interface XDataServicesession - session object.
RemoteException
public UserVariable[] getConnectionParameters(Object session,
String query)
throws RemoteException
getConnectionParameters in interface XDataServicesession - session object.query - query name.
RemoteException
public UserVariable[] getConnectionParameters(Object session,
XQuery xquery)
throws RemoteException
getConnectionParameters in interface XDataServicesession - session object.xquery - query to get connection parameters.
RemoteException
public UserVariable[] getConnectionParameters(Object session,
XDataSource dx)
throws RemoteException
getConnectionParameters in interface XDataServicesession - session object.dx - data source to get connection parameters.
RemoteException
public UserVariable[] getQueryParameters(Object session,
String query,
boolean promptOnly)
throws RemoteException
getQueryParameters in interface XDataServicesession - 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 XDataServicesession - 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 XDataServicesession - 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 XDataServicesession - session object.query - query name.params - connection parameters.
Exception
public void connect(Object session,
XDataSource dx,
VariableTable params)
throws Exception
connect in interface XDataServicesession - 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 XDataServicesession - the specified session object.dx - the specified data source.params - the specified variable table.
Exception
public XNode execute(Object session,
String query,
VariableTable vars)
throws Exception
execute in interface XDataServicesession - session object.query - query to execute.vars - variable values for the query.
Exception
public XNode execute(Object session,
String query,
VariableTable vars,
boolean resetVariables)
throws Exception
execute in interface XDataServicesession - session object.query - query to execute.vars - variable values for the query.resetVariables - true if should reset cached variables.
Exception
public XNode execute(Object session,
String query,
VariableTable vars,
Principal user)
throws Exception
execute in interface XDataServicesession - session object.query - query to execute.vars - variable values for the query.user - a Principal object that identifies the user executing the
query.
Exception
public XNode execute(Object session,
String query,
VariableTable vars,
Principal user,
boolean resetVariables)
throws Exception
execute in interface XDataServicesession - session object.query - 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.
Exception
public XNode execute(Object session,
String query,
VariableTable vars,
Principal user,
boolean resetVariables,
inetsoft.util.DataCacheVisitor visitor)
throws Exception
execute in interface XDataServicesession - session object.query - 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 XNode execute(Object session,
XQuery xquery,
VariableTable vars)
throws Exception
execute in interface XDataServicesession - session object.xquery - query to execute.vars - variable values for the query.
Exception
public XNode execute(Object session,
XQuery xquery,
VariableTable vars,
boolean resetVariables)
throws Exception
execute in interface XDataServicesession - session object.xquery - query to execute.vars - variable values for the query.resetVariables - true if should reset cached variables.
Exception
public XNode execute(Object session,
XQuery xquery,
VariableTable vars,
Principal user)
throws Exception
execute in interface XDataServicesession - session object.xquery - query to execute.vars - variable values for the query.user - a Principal object that identifies the user executing the
query.
Exception
public XNode execute(Object session,
XQuery xquery,
VariableTable vars,
Principal user,
boolean resetVariables)
throws Exception
execute in interface XDataServicesession - 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.
Exception
public XNode execute(Object session,
XQuery xquery,
VariableTable vars,
Principal user,
boolean resetVariables,
inetsoft.util.DataCacheVisitor visitor)
throws Exception
execute in interface XDataServicesession - 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 XNode getMetaData(Object session,
XDataSource dx,
XNode mtype)
throws Exception
getMetaData in interface XRepositorysession - session object.dx - data source.mtype - meta data type, defined in each data source.
Exception
public XNode getMetaData(Object session,
XDataSource dx,
XNode mtype,
boolean clone)
throws Exception
getMetaData in interface XRepositorysession - session object.dx - data source.mtype - meta data type, defined in each data source.clone - true to clone the cached node.
Exception
public XNode getMetaData(Object session,
XDataSource dx,
XNode mtype,
boolean clone,
XRepository.MetaDataListener listener)
throws Exception
getMetaData in interface XRepositorysession - 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 XRepositorypublic void refreshMetaData(String dxName)
refreshMetaData in interface XRepositorydxName - the specified datasource name.public void refreshMetaData()
refreshMetaData in interface XRepositorypublic XNode getMetaDataCache(String key)
|
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 | ||||||||