Style Intelligence v12.0

inetsoft.uql
Interface XRepository

All Superinterfaces:
XDataService, XQueryRepository
All Known Implementing Classes:
RemoteEngine, XEngine

public interface XRepository
extends XDataService, XQueryRepository

XRepository defines the API to the data source and query registries. It is normally used during design time to modify the registries, such as creating new data sources or queries, and modifying the existing data sources or queries. Runtime methods for executing queries are defined in the base class, XDataService.


Nested Class Summary
static interface XRepository.MetaDataListener
           
 
Field Summary
 
Fields inherited from interface inetsoft.uql.XQueryRepository
GLOBAL_SCOPE, LOCAL_QUERY, LOCAL_SCOPE, NORMAL_QUERY
 
Method Summary
 void clearCache()
          Clear cached data.
 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.
 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.
 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.
 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 removeDataSource(String dxname)
          Remove a data source from the repository.
 boolean removeDataSourceFolder(String name)
          Remove a data source folder from the repository.
 void removeDomain(String dxname)
          Remove a domain from the repository.
 void removeQuery(String qname)
          Remove a query from the repository.
 void renameQueryFolder(String nname, String oname)
          Rename a query folder in the repository.
 void updateDataModel(XDataModel dx)
          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 dx, String oname)
          Add or replace a data source folder in the repository.
 void updateDomain(XDomain domain)
          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 query repository.
 
Methods inherited from interface inetsoft.uql.XDataService
bind, close, connect, connect, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, getConnectionParameters, getConnectionParameters, getConnectionParameters, getHandler, getQueryParameters, getQueryParameters, testDataSource
 
Methods inherited from interface inetsoft.uql.XQueryRepository
getQueries, getQueryType
 

Method Detail

getDataSourceNames

String[] getDataSourceNames()
                            throws RemoteException
Get the names of data sources in this repository.

Throws:
RemoteException

getDataSourceFullNames

String[] getDataSourceFullNames()
                                throws RemoteException
Get full names of all the data sources in this repository.

Returns:
full names of all the data sources.
Throws:
RemoteException

getDataSourceFolderNames

String[] getDataSourceFolderNames()
                                  throws RemoteException
Get all data source folder names in repository.

Returns:
names of all the data source folders.
Throws:
RemoteException

getDataSourceFolderFullNames

String[] getDataSourceFolderFullNames()
                                      throws RemoteException
Get all data source folder names in repository.

Returns:
full names of all the data source folders.
Throws:
RemoteException

getSubfolderNames

String[] getSubfolderNames(String path)
                           throws RemoteException
Get the children data source folder from the specified data source folder path.

Parameters:
path - the specified data source folder name.
Returns:
the children data source folder of the specified data source folder.
Throws:
RemoteException

getSubDataSourceNames

String[] getSubDataSourceNames(String path)
                               throws RemoteException
Get the children data source from the specified data source folder path.

Parameters:
path - the specified data source folder name.
Returns:
the children data source of the specified data source folder.
Throws:
RemoteException

getDataSource

XDataSource getDataSource(String dsname)
                          throws RemoteException
Get the named data source.

Throws:
RemoteException

getDataSourceFolder

DataSourceFolder getDataSourceFolder(String dsname)
                                     throws RemoteException
Get the named data source folder.

Throws:
RemoteException

getDataSource

XDataSource getDataSource(String dsname,
                          boolean clone)
Get the named data source.

Parameters:
clone - true to clone data source, false otherwise.

getDataSourceFolder

DataSourceFolder getDataSourceFolder(String dsname,
                                     boolean clone)
Get the named data source folder.

Parameters:
clone - true to clone data source folder, false otherwise.

updateDataSource

void updateDataSource(XDataSource dx,
                      String oname)
                      throws Exception
Add or replace a data source in the repository.

Parameters:
dx - new data source.
oname - old name of the data source, if the name has been changed. Otherwise it should be null.
Throws:
Exception

updateDataSource

void updateDataSource(XDataSource dx,
                      String oname,
                      Boolean actionRecord)
                      throws Exception
Add or replace a data source in the repository.

Parameters:
dx - new data source.
oname - old name of the data source, if the name has been changed.
actionRecord - control whether write down audit record when remote in designer. Otherwise it should be null.
Throws:
Exception

updateDataSourceFolder

void updateDataSourceFolder(DataSourceFolder dx,
                            String oname)
                            throws Exception
Add or replace a data source folder in the repository.

Parameters:
dx - new data source folder.
oname - old name of the data source folder, if the name has been changed. Otherwise it should be null.
Throws:
Exception

removeDataSource

void removeDataSource(String dxname)
                      throws Exception
Remove a data source from the repository.

Throws:
Exception

removeDataSourceFolder

boolean removeDataSourceFolder(String name)
                               throws Exception
Remove a data source folder from the repository.

Throws:
Exception

getDataModel

XDataModel getDataModel(String dxname)
                        throws RemoteException
Get the data model for the specified data source.

Parameters:
dxname - the name of the data source.
Throws:
RemoteException

getDomain

XDomain getDomain(String dxname)
                  throws RemoteException
Get the domain for the specified data source.

Parameters:
dxname - the name of the data source.
Throws:
RemoteException

updateDomain

void updateDomain(XDomain domain)
                  throws Exception
Add or replace a domain in the repository.

Parameters:
domain - the new domain.
Throws:
Exception

removeDomain

void removeDomain(String dxname)
                  throws Exception
Remove a domain from the repository.

Parameters:
dxname - the name of the data source to which the domain is associated.
Throws:
Exception

updateDataModel

void updateDataModel(XDataModel dx)
                     throws Exception
Add or replace a data model in the repository.

Parameters:
dx - new data model.
Throws:
Exception

getQueryNames

String[] getQueryNames()
                       throws RemoteException
Get the names of queries in this repository.

Throws:
RemoteException

getQueryNames

String[] getQueryNames(String ds,
                       String folder,
                       boolean checkFolder)
Get names of query in specified data source and folder.


getQuery

XQuery getQuery(String qname)
                throws RemoteException
Get the query object for the named query.

Specified by:
getQuery in interface XQueryRepository
Parameters:
qname - the specified query name.
Returns:
query matches the specified query name.
Throws:
RemoteException

getQueryDatasource

String getQueryDatasource(String qname)
Get data source of specified query.


getQueryFolder

String getQueryFolder(String qname)
Get folder of specified query.


getQueryType

String getQueryType(String qname)
Get type of specified query.


getQuery

XQuery getQuery(String qname,
                boolean cloned)
                throws RemoteException
Get the query object for the named query.

Throws:
RemoteException

isQueryVisible

boolean isQueryVisible(String qname)
Return if query is visible or not.


updateQuery

void updateQuery(XQuery dx,
                 String oname)
                 throws Exception
Add or replace a query in the repository.

Specified by:
updateQuery in interface XQueryRepository
Parameters:
dx - new query.
oname - old name of the query, if the name has been changed. Otherwise it should be null.
Throws:
Exception

updateQuery

void updateQuery(XQuery dx,
                 String oname,
                 Boolean actionRecord)
                 throws Exception
Add or replace a query in the query repository.

Parameters:
dx - new query.
oname - old name of the query, if the name has been changed.
actionRecord - control whether write audit record when remote in designer. Otherwise it should be null.
Throws:
Exception

removeQuery

void removeQuery(String qname)
                 throws Exception
Remove a query from the repository.

Specified by:
removeQuery in interface XQueryRepository
Throws:
Exception

getMetaData

XNode getMetaData(Object session,
                  XDataSource dx,
                  XNode mtype)
                  throws Exception
Deprecated. 

Build the meta data of this data source as a XNode tree. This method will rebuild the meta data tree everytime it's called. The meta data should be cached by the caller.

Parameters:
session - session object.
dx - data source.
mtype - meta data type, defined in each data source.
Returns:
return the root node of the meta data tree.
Throws:
Exception

getMetaData

XNode getMetaData(Object session,
                  XDataSource dx,
                  XNode mtype,
                  boolean clone)
                  throws Exception
Deprecated. 

Build the meta data of this data source as a XNode tree. This method will rebuild the meta data tree everytime it's called. The meta data should be cached by the caller.

Parameters:
session - session object.
dx - data source.
mtype - meta data type, defined in each data source.
clone - true to clone the cached node.
Returns:
the root node of the meta data tree.
Throws:
Exception

getMetaData

XNode getMetaData(Object session,
                  XDataSource dx,
                  XNode mtype,
                  boolean clone,
                  XRepository.MetaDataListener listener)
                  throws Exception
Build the meta data of this data source as a XNode tree. This method will rebuild the meta data tree everytime it's called. The meta data should be cached by the caller.

Parameters:
session - session object.
dx - data source.
mtype - meta data type, defined in each data source.
clone - true to clone the cached node.
Returns:
return the root node of the meta data tree.
Throws:
Exception

clearCache

void clearCache()
Clear cached data.


refreshMetaData

void refreshMetaData(String dxName)
Refresh matadata of a datasource. It will remove the related file caches and memory caches.

Parameters:
dxName - the specified datasource name.

refreshMetaData

void refreshMetaData()
Clear the cached meta data.


renameQueryFolder

void renameQueryFolder(String nname,
                       String oname)
                       throws Exception
Rename a query folder in the repository.

Parameters:
nname - new name of query folder.
oname - old name of the query folder, if the name has been changed. Otherwise it should be null.
Throws:
Exception

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.