|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DataFoundationService
Provides methods to manage the fully qualified names of the data foundation tables, detect the columns of lists of values, and refresh the structure of the data foundation.
Method Summary | |
---|---|
void |
detectLovColumns(SQLQueryLov sqlQueryLov)
Creates the columns of the list of values from the SQL expression on which the list of values is based. |
java.lang.String |
getTableFullName(java.lang.String qualifier,
java.lang.String owner,
java.lang.String table)
Returns the fully qualified table name that identifies a table within a DataFoundation . |
java.lang.String |
getTableFullName(Table table)
Returns the fully qualified table name that identifies a table within a DataFoundation . |
IStatus |
refreshStructure(java.lang.String dataFoundationPath,
boolean applyChanges)
Refreshes the structure of the data foundation. |
IStatus |
setConnectionPath(java.lang.String multiDataFoundationPath,
java.util.List<DataFederatorSourceInfo> sourceInfos)
Set the connection paths of a multi-source data foundation. |
IStatus |
setConnectionPath(java.lang.String monoDataFoundationPath,
java.lang.String connectionPath)
Set the connection path of a mono-source data foundation. |
java.lang.String[] |
splitTableFullName(java.lang.String fullName)
Splits a fully qualified table name into an array of strings [qualifier, owner, table name]. |
Method Detail |
---|
java.lang.String[] splitTableFullName(java.lang.String fullName)
The fullName
identifies a table within a DataFoundation
.
If not available, qualifier and owner are set to an empty string.
fullName
- The fully qualified name of a table. It must follow the same format as the one used in "Rows" Data
Security Profile.
String[]
containing the owner, qualifier and table namegetTableFullName(String, String, String)
,
getTableFullName(Table)
,
RowRestriction.getTable()
,
RelationalBinding.getExtraTables()
java.lang.String getTableFullName(java.lang.String qualifier, java.lang.String owner, java.lang.String table)
DataFoundation
.
The returned string is formatted as "qualifier"."owner"."tablename".
qualifier
- The qualifier of the tableowner
- The owner of the tabletable
- The name of the table
String
containing the fully qualified table nameRowRestriction.setTable(String)
,
RelationalBinding.getExtraTables()
,
splitTableFullName(String)
java.lang.String getTableFullName(Table table)
DataFoundation
.
table
- The table
String
containing the fully qualified table namegetTableFullName(String, String, String)
void detectLovColumns(SQLQueryLov sqlQueryLov)
This method detects the columns from the SQL expression and then creates the columns of the SQLQueryLov
object.
The columns cannot be edited (adding, modifying, removing).
Example:
SQLQueryLov sqlQueryLov = dataFoundationFactory.createSQLQueryLov("SQLQueryLov", dataFoundation); sqlQueryLov.setDescription("Description of SQLQueryLov"); sqlQueryLov.setSQLExpression("SELECT * FROM " + dataFoundation.getTables().get(0).getName()); ... DataFoundationService dataFoundationService = context.getService(DataFoundationService.class); dataFoundationService.detectLovColumns(sqlQueryLov);
sqlQueryLov
- The list of values attached to a data foundationDataFoundationFactory.createSQLQueryLov(String, DataFoundation)
,
Lov.setDescription(String)
,
SQLQueryLov.setSQLExpression(String)
,
SlContext.getService(Class)
IStatus refreshStructure(java.lang.String dataFoundationPath, boolean applyChanges)
This method performs the following operations:
All objects modified in the database are refreshed at once in the data foundation.
Important: If you load the data foundation before running this method, all changes will be discarded.
dataFoundationPath
- The path of the data foundation, with the following format:
[folder]/.../[data foundation name].dfx
.applyChanges
- If true
, the method applies the changes and saves the data foundation. If
false
, the method only returns the description of the changes.
IStatus
that contains the description of changes made to the data foundationIStatus setConnectionPath(java.lang.String monoDataFoundationPath, java.lang.String connectionPath)
This method avoids to load the data foundation to change the path of its connection.
monoDataFoundationPath
- The mono-source data foundation path.connectionPath
- The path of the connection. It can be local or CMS (path or CUID)
IStatus
that contains the result of change made to the data foundationIStatus setConnectionPath(java.lang.String multiDataFoundationPath, java.util.List<DataFederatorSourceInfo> sourceInfos)
This method avoids to load the data foundation to change the paths of its connections.
multiDataFoundationPath
- The multi-source data foundation path.sourceInfos
- The list of sourceInfos replacing the current ones.
IStatus
that contains the result of change made to the data foundation
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |