jet.api.API
jet.api.CatalogAPI
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class CatalogAPI
The CatalogAPI class allows an application to create and manipulate JReport catalog objects. By building a CatalogAPI instance in a Java program, users can edit a catalog by methods provided by API.
JReport catalog and its objects are stored in a tree
structure. An instance of CatalogAPI can
retrieve each object in the catalog by its handle. The handle
of the catalog object is named by its qualified and unique instance
name. Besides the handle, some catalog objects
also have resource names, such as query, table, table column,
and formula. And the resource name of table, field(formula,parameter)
also be called mapping name. The mapping name maps the real name of
a database object to JReport catalog's name.
The following are the objects that a JReport catalog can hold:
A CatalogAPI instance can be generated by a
Designer instance.
Below is an example of the use of the CatalogAPI.
Designer dr = null;
try
{
String path = %install root%/JReport/demo/reports/SampleReports/;
String catName = "SampleReports.cat";
DesignerUserInfo userInfo=new DesignerUserInfo("UID", "license key");
dr = new Designer(path, catName,userInfo);
CatalogAPI cat = dr.getCatalogAPI();
}
catch(Exception e)
{
;
}
finally
{
dr.exit();
}
| Field Summary | |
|---|---|
static int |
ALIAS
SQL alias class type. |
static int |
AVERAGE
constant for summary function name |
static java.lang.String |
BINARY
parameter data type |
static java.lang.String |
BOOLEAN
parameter data type |
static int |
BUSINESSLOGIC
BusinessLogic (also named Business/Report Cube) object type. |
static int |
BUSINESSLOGIC_CATEGORY
BusinessLogic (also named Business/Report Cube) Category object type. |
static int |
BUSINESSLOGIC_DETAILINFO
BusinessLogic (also named Business/Report Cube) Detail object type. |
static int |
BUSINESSLOGIC_DIMENSION
BusinessLogic (also named Business/Report Cube) Dimension object type. |
static int |
BUSINESSLOGIC_HIERARCHY
BusinessLogic (also named Business/Report Cube) Hierarchy object type. |
static int |
BUSINESSLOGIC_HIERARCHYCONTAINER
BusinessLogic (also named Business/Report Cube) Hierarchy container object type. |
static int |
BUSINESSLOGIC_MEASURE
BusinessLogic (also named Business/Report Cube) Measure object type. |
static int |
BUSINESSVIEW_AGGREGATION
BusinessView AGGREGATION object type. |
static int |
BUSINESSVIEW_DETAIL
BusinessView DETAIL object type. |
static int |
BUSINESSVIEW_GROUP
BusinessView Group object type. |
static int |
CATALOG
Catalog object type. |
static int |
COLUMN
Column object type. |
static int |
CONNECTION
Connection object type. |
static int |
COUNT
constant for summary function name |
static java.lang.String |
CURRENCY
parameter data type |
static int |
DATABASE
Database object type. |
static java.lang.String |
DATE
parameter data type |
static java.lang.String |
DATETIME
parameter data type |
static java.lang.String |
DECIMAL
parameter data type |
static int |
DISTINCTCOUNT
constant for summary function name |
static int |
ENCODINGAUTO
encoded data type |
static int |
ENCODINGNO
encoded data type |
static int |
ENCODINGYES
encoded data type |
static int |
EXTRA_NAME_JDBC
extra name type |
static int |
EXTRA_NAME_USERDEFINED
extra name type |
static int |
FILESQL
Imported SQL object type. |
static int |
FORMULA
Formula object type. |
static int |
HDS
HierDataSource object type. |
static java.lang.String |
INTEGER
parameter data type |
static int |
JDBC
Connection with JDBC |
static int |
JDBC_ODBC_BRIDGE
Connection with JDBC-ODBC bridge |
static int |
MAXIMUM
constant for summary function name |
static int |
MINIMUM
constant for summary function name |
static java.lang.String |
NUMBER
parameter data type |
static int |
ONDEMAND_QUERY
Demand Query object type. |
static int |
PARAMETER
Parameter object type. |
static java.lang.String |
PARAMETERS
parameter data type |
static int |
PATTERN_1PART_NAME
qualified name pattern |
static int |
PATTERN_2PART_NAME
qualified name pattern |
static int |
PATTERN_3PART_NAME
qualified name pattern |
static int |
POPULATIONSTDDEV
constant for summary function name |
static int |
POPULATIONVARIANCE
constant for summary function name |
static int |
PROCEDURE
Stored Procedure object type. |
static int |
QUERY
Query object type |
static int |
READ_ONLY_DEFAULT
connection Read-only property |
static int |
READ_ONLY_FALSE
connection Read-only property |
static int |
READ_ONLY_TRUE
connection Read-only property |
static int |
RUNNING_AVERAGE
constant for summary function name |
static int |
RUNNING_COUNT
constant for summary function name |
static int |
RUNNING_DISTINCTCOUNT
constant for summary function name |
static int |
RUNNING_MAXIMUM
constant for summary function name |
static int |
RUNNING_MINIMUM
constant for summary function name |
static int |
RUNNING_SUM
constant for summary function name |
static int |
STDDEV
constant for summary function name |
static java.lang.String |
STRING
parameter data type |
static int |
SUM
constant for summary function name |
static int |
SUMMARY
Summary object type. |
static int |
SYNONYM
SQL synonym class type. |
static int |
TABLE
Table object type. |
static java.lang.String |
TIME
parameter data type |
static int |
TRANSACTION_DEFAULT
transaction isolation level value |
static int |
TRANSACTION_NONE
transaction isolation level value |
static int |
TRANSACTION_READ_COMMITTED
transaction isolation level value |
static int |
TRANSACTION_READ_UNCOMMITTED
transaction isolation level value |
static int |
TRANSACTION_REPEATABLE_READ
transaction isolation level value |
static int |
TRANSACTION_SERIALIZABLE
transaction isolation level value |
static int |
UDS
User Defined DataSource object type. |
static int |
VARIANCE
constant for summary function name |
static int |
VIEW
View object type. |
static int |
WHEREPORTION
SQL Where Portion clause object type. |
static int |
WSDLTYPE_LOCALEFILE
WSDL connection type |
static int |
WSDLTYPE_URI
WSDL connection type |
static int |
XML_CONNECTION
XMLConnection object type. |
static int |
XML_MDCONTAINER
XMLContainer object type. |
| Fields inherited from class jet.api.API |
|---|
CAT, CENTIMETER, COLOR, DOUBLE, ENUM, FLOAT, INCH, LONG, PIXEL, REFERENCE, RPT, SELFRPT, TEXTRPT, UNKNOWN, XMLCAT, XMLRPT |
| Method Summary | |
|---|---|
boolean |
checkParam(ParameterInfo info)
Checks whether or not the parameter's definition is valid. |
Designer |
create(java.lang.String path,
java.lang.String name)
Deprecated. |
boolean |
delete(java.lang.String handle)
Deletes an object from the catalog. |
boolean |
delete(java.lang.String qryName,
java.lang.String tablename)
Deletes the specified table in the query. |
boolean |
delete(java.lang.String qryName,
java.lang.String unionQuery,
boolean unionAll)
Deletes the "union query" of the query in the data source. |
boolean |
delete(java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname)
Deletes the specified table's column in the query. |
boolean |
delete(java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
java.lang.String expression)
Deletes the QBE condition in the query. |
boolean |
delete(java.lang.String qryName,
java.lang.String sExpression1,
java.lang.String sOperator,
java.lang.String sExpression2,
java.lang.String sLogic)
Deletes where conditions in the query. |
boolean |
delete(java.lang.String qryName,
java.lang.String tableFrom,
java.lang.String columnFrom,
java.lang.String operator,
java.lang.String tableTo,
java.lang.String columnTo)
Deletes a join of the query. |
boolean |
delete(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tableFrom,
java.lang.String columnFrom,
java.lang.String operator,
java.lang.String tableTo,
java.lang.String columnTo)
Deletes a join in the query |
boolean |
delete(java.lang.String dataSourceName,
java.lang.String qryName,
UnionInfo info)
Deletes the "union query" of the query in the specified data source. |
boolean |
delete(java.lang.String qryName,
UnionInfo info)
Deletes the "union query" of the query. |
boolean |
deleteCompCol(java.lang.String qryName,
java.lang.String columnName)
Deletes the Computed Column from the query. |
boolean |
deleteCompCol(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String columnName)
Deletes the Computed Column from the query. |
boolean |
deleteCondition(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String sExpression1,
java.lang.String sOperator,
java.lang.String sExpression2,
java.lang.String sLogic)
Deletes where conditions in the query. |
boolean |
deleteQBE(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
java.lang.String expression)
Deletes the QBE condition in the query. |
boolean |
deleteQuery(java.lang.String qryName)
Deletes the query from the data source. |
boolean |
deleteQuery(java.lang.String dataSourceName,
java.lang.String qryName)
Deletes the query from the specified data source. |
boolean |
deleteQueryField(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname)
Deletes the specified table's column in the query of the specified data source. |
boolean |
deleteQueryTable(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename)
Deletes the specified table in the query of the specified data source. |
boolean |
deleteUnionQuery(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String unionQuery,
boolean unionAll)
Deletes the "union query" of the query in the specified data source. |
java.lang.String[][] |
getAndConditions(java.lang.String queryName)
Deprecated. Replaced by getAndInfos(String queryName) |
java.lang.String[][] |
getAndConditions(java.lang.String dataSourceName,
java.lang.String queryName)
Deprecated. -Replaced by getAndInfos(String dataSourceName, String queryName) |
AndInfo[] |
getAndInfos(java.lang.String queryName)
Gets "And" filter condition information of the query |
AndInfo[] |
getAndInfos(java.lang.String dataSourceName,
java.lang.String queryName)
Gets "And" filter condition information of the query in the specified data source. |
java.lang.String[] |
getBLCategoryHandles(java.lang.String handle)
Gets Business Logic (also named Business/Report Cube) category handles in the specified Business Logic node. |
java.lang.String[] |
getBLDetailHandles(java.lang.String handle)
Gets Business Logic (also named Business/Report Cube) Detail Information handles in the specified Business Logic node. |
java.lang.String[] |
getBLDimensionHandles(java.lang.String handle)
Gets Business Logic (also named Business/Report Cube) Dimension handles in the specified Business Logic node. |
java.lang.String[] |
getBLHierarchyHandles(java.lang.String handle)
Gets Business Logic (also named Business/Report Cube) Hierarchy handles in the specified Business Logic node. |
java.lang.String[] |
getBLMeasureHandles(java.lang.String handle)
Gets Business Logic (also named Business/Report Cube) Measure handles in the specified Business Logic node. |
java.lang.String |
getBLNodeQualifyName(java.lang.String handle)
Gets BusinessLogic node's qualified name. |
java.lang.String[] |
getBLViewHandles(java.lang.String dataSourceName)
Gets Business Logic (also named Business/Report Cube) handles in the specified data source. |
java.lang.String[] |
getBLViewHandles(java.lang.String dataSourceName,
int queryType)
Gets Business Logic (also named Business/Report Cube) handles by the specified query type in the specified data source. |
java.lang.String[] |
getBLViewNames(java.lang.String dataSourceName)
Gets Business Logic (also named Business/Report Cube) names in the specified data source. |
java.lang.String[] |
getBLViewNames(java.lang.String dataSourceName,
int queryType)
Gets Business Logic (also named Business/Report Cube) names in the specified data source. |
java.lang.String[] |
getBusinessNodeNames(java.lang.String dataSourceName,
java.lang.String businessViewName)
Gets business node names of the specified Business Logic (also named Business/Report Cube) in the specified data source. |
java.lang.String[] |
getBusinessViewAggregationHandles(java.lang.String handle)
Gets Business View Aggregation handles in the specified Business Logic node. |
java.lang.String[] |
getBusinessViewDetailHandles(java.lang.String handle)
Gets Business View detail handles in the specified Business Logic node. |
java.lang.String[] |
getBusinessViewGroupHandles(java.lang.String handle)
Gets Business View Group handles in the specified Business Logic node. |
java.lang.String[] |
getBusinessViewHandles(java.lang.String dataSourceName)
Gets Business View handles by the specified query type in the specified data source. |
java.lang.String[] |
getBusinessViewHandles(java.lang.String dataSourceName,
int queryType)
Gets Business View handles by the specified query type in the specified data source. |
java.lang.String[] |
getBusinessViewNames(java.lang.String dataSourceName)
Gets Business View names in the specified data source. |
java.lang.String[] |
getBusinessViewNames(java.lang.String dataSourceName,
int queryType)
Gets Business View names in the specified data source. |
java.lang.String[] |
getBusinesViewCategoryHandles(java.lang.String handle)
Gets Business View category handles in the specified Business Logic node. |
java.lang.String[] |
getChartFunctions(java.lang.String queryName,
java.lang.String groupBy)
Gets formulas and summaries which are valid to the query and can be grouped on this field. |
java.lang.String[] |
getChartFunctions(java.lang.String dataSourceName,
java.lang.String queryName,
java.lang.String groupBy)
Gets formulas and summaries which are valid to the query and can be grouped on this field. |
java.lang.String[] |
getColumnMappingnames(java.lang.String queryName)
Gets all columns' mapping names in the query. |
java.lang.String[] |
getColumnMappingnames(java.lang.String dataSourceName,
java.lang.String queryName)
Gets all columns' mapping names in the query. |
QueryTableInfo |
getColumns(java.lang.String queryName,
boolean allColumns)
Gets definitions of all tables and columns in the query. |
QueryTableInfo |
getColumns(java.lang.String dataSourceName,
java.lang.String queryName,
boolean allColumns)
Gets definitions of all tables and columns in the query. |
QueryTableInfo |
getColumnsCanBeGroupedBy(java.lang.String queryName)
Gets columns in the query which can be used to group data in the report. |
QueryTableInfo |
getColumnsCanBeGroupedBy(java.lang.String dataSourceName,
java.lang.String queryName)
Gets columns in the query which can be used to group data in the report. |
java.lang.String[] |
getCompColumnHandles(java.lang.String dataSourceName,
java.lang.String queryName)
Gets handles of the computed columns in the query |
java.lang.String[] |
getCompColumns(java.lang.String queryName)
Gets computed columns in the query |
java.lang.String[] |
getCompColumns(java.lang.String dataSourceName,
java.lang.String queryName)
Gets computed columns in the query |
ConnectionInfo |
getConnectionInfo()
Gets connection information from the default data source. |
ConnectionInfo |
getConnectionInfo(java.lang.String dataSourceName)
Gets connection information from the specified data source. |
ConnectionInfo |
getConnectionInfo(java.lang.String dataSourceName,
java.lang.String connectionName)
Gets connection information from the specified data source. |
java.lang.String[] |
getDataSources()
Gets all Data Source names in the catalog. |
java.lang.String[] |
getDBFields(java.lang.String qryName)
Gets DBFields' mapping names that are defined in the query of the specified data source. |
java.lang.String[] |
getDBFields(java.lang.String dataSourceName,
java.lang.String qryName)
Gets DBFields' mapping names that are defined in the query of the specified data source. |
java.lang.String |
getDefaultConnectionName(java.lang.String datasourceName)
Gets the resource name of the default connection in the specified data source. |
java.lang.String |
getDefaultDataSourceName()
Gets the data source name of the default data source. |
java.lang.String[] |
getForeignKeys(java.lang.String tablename)
Gets foreign keys of the table. |
java.lang.String[] |
getForeignKeys(java.lang.String dataSourceName,
java.lang.String tablename)
Gets foreign keys of the table. |
java.lang.String[] |
getForeignKeys(java.lang.String dataSourceName,
java.lang.String connectionName,
java.lang.String tablename)
Gets foreign keys of the table. |
java.lang.String[] |
getFormulae()
Gets all formulas' mapping names that are defined in the default datasource. |
java.lang.String[] |
getFormulae(java.lang.String dataSourceName)
Gets all formulas' mapping names that are defined in the specified data source. |
java.lang.String[] |
getFormulaeCanBeGroupedBy(java.lang.String queryName)
Gets formulas which are valid to the query and can be grouped on. |
java.lang.String[] |
getFormulaeCanBeGroupedBy(java.lang.String queryName,
java.lang.String groupBy)
Gets formulas which are valid to the query and can be grouped on this field. |
java.lang.String[] |
getFormulaeCanBeGroupedBy(java.lang.String dataSourceName,
java.lang.String queryName,
java.lang.String groupBy)
Gets formulas which are valid to the query and can be grouped on this field. |
java.lang.String[] |
getFormulaeForQuery(java.lang.String queryName)
Gets formulas which are valid to the query. |
java.lang.String[] |
getFormulaeForQuery(java.lang.String dataSourceName,
java.lang.String queryName)
Gets formulas which are valid to the query. |
FormulaInfo |
getFormulaInfo(java.lang.String handle)
Gets the Formula's information. |
java.lang.String[] |
getFormulasCanBeGroupedBy(java.lang.String dataSourceName,
java.lang.String queryName)
Gets formulas which are valid to the query and can be grouped on The "valid" means that the formulas and their referred fields are the valid fields in the specified query. |
java.lang.String[] |
getFunctions(int iType)
Gets available embedded function names according to SQL type. |
java.lang.String[] |
getFunctions(java.lang.String resourceName)
Gets available embedded function names according to the field mapping name. |
java.lang.String[] |
getFunctions(java.lang.String dataSourceName,
java.lang.String resourceName)
Gets available embedded function names according to the field mapping name in the specified data source. |
java.lang.String |
getHandle(java.lang.String resourceName,
int type)
Gets the handle of an object according to the object's resource name and object type, which can identify the object in the catalog. |
java.lang.String |
getHandle(java.lang.String dataSourceName,
java.lang.String resourceName,
int type)
Gets the handle of an object according to the object's resource name and object type in the specified data source in JReport catalog, which can identify the object in the catalog. |
java.lang.String[] |
getHDSs()
Gets all resource names of Hierarchical Data Sources (HDS) query that are defined in the default data source. |
java.lang.String[] |
getHDSs(java.lang.String dataSourceName)
Gets all resource names of Hierarchical Data Sources (HDS) query that are defined in the specified data source. |
JoinInfo[] |
getJoinInfos(java.lang.String queryName)
Gets joins' definitions in the query. |
JoinInfo[] |
getJoinInfos(java.lang.String dataSourceName,
java.lang.String queryName)
Gets joins' definitions in the query. |
java.lang.String[][] |
getJoins(java.lang.String queryName)
Deprecated. Replaced by getJoinInfos(String queryName)
Gets joins definition in the query. |
java.lang.String[][] |
getJoins(java.lang.String dataSourceName,
java.lang.String queryName)
Deprecated. Replaced by getJoinInfos(String dataSourceName, String queryName)
Gets joins definition in the query. |
QueryTableInfo |
getMapColumns(java.lang.String queryName)
Gets definitions of all tables and columns in the query. |
QueryTableInfo |
getMapColumns(java.lang.String dataSourceName,
java.lang.String queryName)
Gets definitions of all tables and columns in the query. |
java.lang.String |
getMappingname(java.lang.String handle)
Gets a resource name for the specified catalog object by its handle. |
java.lang.String[] |
getMappingnames(java.lang.String DSName)
Gets the fields' mapping names in default data source. |
java.lang.String[] |
getMappingnames(java.lang.String dataSourceName,
java.lang.String DSName)
Gets the fields' mapping names in the specified data source |
java.lang.String |
getNewFormulaName()
Gets a default formula name for the formula to be created in the current catalog,which is unique in the specified data source. |
java.lang.String |
getNewFormulaName(java.lang.String sourceName)
Gets a default mapping name for the formula to be created in the specified data source of the current catalog, which is unique in the specified data source. |
java.lang.String |
getNewQueryName()
Gets a default resource name for the query to be created in the current catalog, which is unique in the specified data source. |
java.lang.String |
getNewQueryName(java.lang.String sourceName)
Gets a default resource name for the query to be created in the specified data source of the current catalog, which is unique in the specified data source. |
java.lang.String |
getNewReportName()
Gets a default report name for the report to be created, which must be unique. |
ObjectInfo |
getObjectInfo(java.lang.String handle)
Gets resource entity's information of an object in the catalog. |
ObjectInfo |
getObjectInfo(java.lang.String resourceName,
int type)
Gets resource entity's information of an object in catalog. |
ObjectInfo |
getObjectInfo(java.lang.String dataSourceName,
java.lang.String resourceName,
int type)
Gets resource entity's information of an object in the catalog. |
java.lang.String[] |
getParameter()
Gets mapping names of the parameters defined in the default data source. |
java.lang.String[] |
getParameter(java.lang.String dataSourceName)
Gets mapping names of the parameters defined in the specified data source. |
java.lang.String[] |
getParameterCanBeGroupedBy()
Gets parameters which can be used to group by in the report from the default data source. |
java.lang.String[] |
getParameterCanBeGroupedBy(java.lang.String dataSourceName)
Gets parameters which can be used to group by in the report from the specified data source. |
ParameterInfo |
getParameterInfo(java.lang.String handle)
Gets the parameter's information. |
java.lang.String[] |
getPrimaryKeys(java.lang.String tablename)
Gets Primary keys of the table. |
java.lang.String[] |
getPrimaryKeys(java.lang.String dataSourceName,
java.lang.String tablename)
Gets Primary keys of the table in the default connection of the specified data source. |
java.lang.String[] |
getPrimaryKeys(java.lang.String dataSourceName,
java.lang.String connectionName,
java.lang.String tablename)
Gets Primary keys of the table in the specified data source and connection. |
java.lang.String[] |
getProcColumns(java.lang.String procedureName)
Gets all column names of the specified Stored Procedure query that are defined in the default data source. |
java.lang.String[] |
getProcColumns(java.lang.String dataSourceName,
java.lang.String procedureName)
Gets all column names of the specified Stored Procedure query that are defined in the specified data source. |
java.lang.String[] |
getProcColumnsMap(java.lang.String proceName)
Gets all columns' mapping names of the specified Stored Procedure query that are defined in the default data source. |
java.lang.String[] |
getProcColumnsMap(java.lang.String dataSourceName,
java.lang.String proceName)
Gets all columns' mapping names of the specified Stored Procedure query that are defined in the specified data source. |
java.lang.String[] |
getProcedureNames()
Gets all resource names of Stored Procedure query that are defined in the default data source. |
java.lang.String[] |
getProcedureNames(java.lang.String dataSourceName)
Gets all resource names of Stored Procedure query that are defined in the default data source. |
java.lang.String[][] |
getQBEInfo(java.lang.String queryName)
Deprecated. -Replaced by getQBEInfos(String queryName)
Gets QBE information in the query. |
java.lang.String[][] |
getQBEInfo(java.lang.String dataSourceName,
java.lang.String queryName)
Deprecated. Replaced by getQBEInfos(String dataSourceName, String queryName)
Gets QBE information in the query |
QBEInfo[] |
getQBEInfos(java.lang.String queryName)
Gets "QBE" condition information of the query. |
QBEInfo[] |
getQBEInfos(java.lang.String dataSourceName,
java.lang.String queryName)
Gets "QBE" condition information of the query in the specified data source. |
java.lang.String[] |
getQueries()
Gets all resource names of the Query that are defined in the default data source. |
java.lang.String[] |
getQueries(java.lang.String dataSourceName)
Gets all resource names of the Query that are defined in the specified data source. |
java.lang.String |
getQuoteChar()
Gets the quote char from the default JDBC connection of default data source. |
java.lang.String |
getQuoteChar(java.lang.String dataSourceName)
Gets the quote char from the JDBC connection of the specified data source |
java.lang.String |
getQuoteChar(java.lang.String dataSourceName,
java.lang.String connectionName)
Gets the quote char from the specified JDBC connection. |
java.lang.String[] |
getSPFields(java.lang.String dataSourceName,
java.lang.String procedureName,
boolean isMapping)
Gets field names of the specified stored procedure's fields. |
java.lang.String[] |
getSPFieldsMap(java.lang.String dataSourceName,
java.lang.String procedureName,
boolean isMapping)
Gets mapping names of the specified stored procedure's fields. |
java.lang.String[] |
getSQLColumns(java.lang.String sqlname)
Gets all columns' real names of the specified Imported SQL query that are defined in the default data source. |
java.lang.String[] |
getSQLColumns(java.lang.String dataSourceName,
java.lang.String sqlname)
Gets all columns' real names of the specified Imported SQL query that are defined in the specified data source. |
java.lang.String[] |
getSQLColumnsMap(java.lang.String sqlname)
Gets all columns' mapping names of the specified Imported SQL query that are defined in the default data source. |
java.lang.String[] |
getSQLColumnsMap(java.lang.String dataSourceName,
java.lang.String sqlname)
Gets all columns' mapping names of the specified Imported SQL query that are defined in the specified data source. |
java.lang.String[] |
getSQLs()
Gets all Imported SQL queries' resource names that are defined in the default data source. |
java.lang.String[] |
getSQLs(java.lang.String dataSourceName)
Gets all Imported SQL queries' resource names that are defined in the specified data source. |
java.lang.String |
getSQLString(java.lang.String queryName)
Gets sql statement text of a queriable object. |
java.lang.String |
getSQLString(java.lang.String dataSourceName,
java.lang.String queryName)
Gets sql statement text of a queriable object. |
int |
getSQLType(java.lang.String query,
java.lang.String colName)
Gets sql type of a query column. |
int |
getSQLType(java.lang.String sourceName,
java.lang.String query,
java.lang.String colName)
Gets sql type of a query column. |
java.lang.String[] |
getSubQueries(java.lang.String queryName)
Gets the "subquery" names of the query. |
java.lang.String[] |
getSubQueries(java.lang.String dataSourceName,
java.lang.String queryName)
Gets "subquery" names of the query. |
java.lang.String[] |
getSummaries()
Gets all Summaries' mapping names that are defined in the default data source. |
java.lang.String[] |
getSummaries(java.lang.String dataSourceName)
Gets all Summaries' mapping names that are defined in the specified data source. |
java.lang.String[] |
getSummariesForQuery(java.lang.String queryName)
Gets Summaries which are valid to the query. |
java.lang.String[] |
getSummariesForQuery(java.lang.String dataSourceName,
java.lang.String queryName)
Gets Summaries which are valid to the query. |
java.lang.String[] |
getSummaryCanBeSortedBy(java.lang.String queryName,
java.lang.String groupBy)
Gets the summaries which can be sorted by in a report group. |
java.lang.String[] |
getSummaryCanBeSortedBy(java.lang.String dataSourceName,
java.lang.String queryName,
java.lang.String groupBy)
Gets the summaries which can be sorted by in a report group. |
SummaryInfo |
getSummaryInfo(java.lang.String handle)
Gets the Summary's information. |
java.lang.String[] |
getTableColumns(java.lang.String tablename)
Gets all columns' real names of the Table/View that are defined in the default data source. |
java.lang.String[] |
getTableColumns(java.lang.String tablename,
boolean isMapping)
Gets all column names of the Table/View that are defined in the default data source. |
java.lang.String[] |
getTableColumns(java.lang.String dataSourceName,
java.lang.String tablename)
Gets all columns' real names of the Table/View that are defined in the specified data source. |
java.lang.String[] |
getTableColumns(java.lang.String dataSourceName,
java.lang.String tablename,
boolean isMapping)
Gets all column names of the Table/View that are defined in the specified data source. |
java.lang.String[] |
getTableColumnsMap(java.lang.String tablename)
Gets all columns' mapping names of the Table/View that are defined in the default data source. |
java.lang.String[] |
getTableColumnsMap(java.lang.String tablename,
boolean isMapping)
Gets all columns' mappping names of the Table/View that are defined in the default data source. |
java.lang.String[] |
getTableColumnsMap(java.lang.String dataSourceName,
java.lang.String tablename)
Gets all columns' mapping names of the Table/View that are defined in the specified data source. |
java.lang.String[] |
getTableColumnsMap(java.lang.String dataSourceName,
java.lang.String tablename,
boolean isMapping)
Gets all columns' mapping names of the Table/View that are defined in the specified data source. |
java.lang.String[] |
getTables()
Gets all mapping names of the Table/View that are defined in the default data source. |
java.lang.String[] |
getTables(boolean bIncludeSystemTable)
Gets tables and views in the data source |
java.lang.String[] |
getTables(java.lang.String dataSourceName)
Gets all mapping names of the Table/View that are defined in the specified data source. |
java.lang.String[] |
getTables(java.lang.String dataSourceName,
boolean bIncludeSystemTable)
Gets tables and views in the specified datasource. |
java.lang.String[] |
getTables(java.lang.String dataSourceName,
java.lang.String connectionName,
boolean bIncludeSystemTable)
Gets tables and views in the specified datasource. |
java.lang.String[] |
getUDSColumns(java.lang.String udsname)
Gets all column names of the specified UDS query that are defined in the specified data source. |
java.lang.String[] |
getUDSColumns(java.lang.String dataSourceName,
java.lang.String udsname)
Gets all column names of the specified UDS query that are defined in the specified data source. |
java.lang.String[] |
getUDSColumnsMap(java.lang.String udsname)
Gets all columns' mapping names of the specified UDS query that are defined in the specified data source. |
java.lang.String[] |
getUDSColumnsMap(java.lang.String dataSourceName,
java.lang.String udsname)
Gets all columns' mapping names of the specified UDS query that are defined in the specified data source. |
java.lang.String[] |
getUDSs()
Gets all resource names of User Data Source(UDS) query that are defined in the specified data source. |
java.lang.String[] |
getUDSs(java.lang.String dataSourceName)
Gets all resource names of User Data Source(UDS) query that are defined in the specified data source. |
java.lang.String[] |
getUnionableQueries(java.lang.String queryname)
Gets available query names that can be unioned to this query. |
java.lang.String[] |
getUnionableQueries(java.lang.String dataSourceName,
java.lang.String queryname)
Gets available query names that can be unioned to this query. |
UnionInfos |
getUnionInfos(java.lang.String queryName)
Gets union query information of a specified query |
UnionInfos |
getUnionInfos(java.lang.String dataSourceName,
java.lang.String queryName)
Gets union query information of the query of the specified data source. |
java.lang.String[] |
getUnionQueries(java.lang.String queryName)
Gets unioned query names of the specified query. |
java.lang.String[] |
getUnionQueries(java.lang.String queryName,
boolean isUnionAll)
Gets unioned query names of a specified query according to the union status |
java.lang.String[] |
getUnionQueries(java.lang.String dataSourceName,
java.lang.String queryName)
Gets unioned query names of the specified query. |
java.lang.String[] |
getUnionQueries(java.lang.String dataSourceName,
java.lang.String queryName,
boolean isUnionAll)
Gets unioned query names of a specified query according to the union status |
java.lang.String |
getUserID()
Gets the user's ID of this CatalogAPI instance |
java.lang.String |
insert(boolean bUseJDBCODBCBridge,
java.lang.String name,
java.lang.String desc,
java.lang.String url,
java.lang.String driver)
Inserts a JReport database connection object. |
java.lang.String |
insert(boolean bUseJDBCODBCBridge,
java.lang.String strName,
java.lang.String strDesc,
java.lang.String URL,
java.lang.String driver,
ConnectionInfo info)
Inserts a JReport database connection object into the specified data source. |
java.lang.String |
insert(java.lang.String dataSourceName,
boolean bUseJDBCODBCBridge,
java.lang.String name,
java.lang.String desc,
java.lang.String url,
java.lang.String driver)
Inserts a JReport database connection object into the database. |
java.lang.String |
insert(java.lang.String dataSourceName,
boolean bUseJDBCODBCBridge,
java.lang.String strName,
java.lang.String strDesc,
java.lang.String URL,
java.lang.String DRV,
ConnectionInfo info)
Inserts a JReport database connection object into the specified data source. |
java.lang.String |
insert(java.lang.String name,
int type)
Adds a resource entity into the catalog. |
java.lang.String |
insert(java.lang.String qryName,
QueryFieldInfo queryFieldInfo,
QueryJoinInfo queryJoinInfo,
QueryQBEInfo queryQBEInfo,
QueryAndInfo queryAndInfo)
Inserts a query into the catalog. |
java.lang.String |
insert(java.lang.String SQLName,
java.lang.String filename)
Inserts an imported query into the default Connection of the default data source. |
java.lang.String |
insert(java.lang.String dataSourceName,
java.lang.String name,
int type)
Adds a resource entity into a specified data source in the catalog. |
java.lang.String |
insert(java.lang.String summaryName,
java.lang.String desc,
int functionType,
java.lang.String fieldName,
java.lang.String groupByFld)
Adds an aggregate function into the data source. |
java.lang.String |
insert(java.lang.String dataSourceName,
java.lang.String qryName,
QueryFieldInfo queryFieldInfo,
QueryJoinInfo queryJoinInfo,
QueryQBEInfo queryQBEInfo,
QueryAndInfo queryAndInfo)
Inserts a query into the catalog. |
java.lang.String |
insert(java.lang.String formulaName,
java.lang.String desc,
java.lang.String expression)
Adds a formula into the data source. |
java.lang.String |
insert(java.lang.String catalogName,
java.lang.String schemaPattern,
java.lang.String tablePattern,
int type)
Inserts a table or view into the data source. |
java.lang.String |
insert(java.lang.String catalogName,
java.lang.String schemaPattern,
java.lang.String tablePattern,
int type,
boolean setMappingName)
Inserts a table or view into the data source. |
java.lang.String |
insert(java.lang.String dataSourceName,
java.lang.String summaryName,
java.lang.String desc,
int functionType,
java.lang.String fieldName,
java.lang.String groupByFld)
Adds an aggregate function into the data source. |
java.lang.String |
insert(java.lang.String dataSourceName,
java.lang.String formulaName,
java.lang.String desc,
java.lang.String expression)
Adds a formula into the specified data source. |
java.lang.String |
insert(java.lang.String tableName,
java.lang.String catalogName,
java.lang.String schemaPattern,
java.lang.String tablePattern,
int type,
boolean setMappingName)
Inserts a table or view into the data source. |
java.lang.String |
insert(java.lang.String tableName,
java.lang.String catalogName,
java.lang.String schemaPattern,
java.lang.String tablePattern,
int type,
java.lang.String character)
Inserts a table or view into the data source. |
java.lang.String |
insert(java.lang.String parameterName,
java.lang.String desc,
java.lang.String prompt,
java.lang.String type,
java.lang.String defaultValue)
Inserts a JReport parameter object into the data source. |
java.lang.String |
insert(java.lang.String procName,
java.lang.String catalog,
java.lang.String schema,
java.lang.String name,
java.lang.String remarks,
int iType)
Inserts a stored procedure into a Connection of the default data source. |
java.lang.String |
insert(java.lang.String procName,
java.lang.String catalog,
java.lang.String schema,
java.lang.String name,
java.lang.String remarks,
int iType,
boolean setMappingName)
Inserts a stored procedure into a Connection of the default data source. |
java.lang.String |
insert(java.lang.String dataSourceName,
java.lang.String tableName,
java.lang.String catalogName,
java.lang.String schemaPattern,
java.lang.String tablePattern,
int type,
java.lang.String character)
Inserts a table or view into the specified data source. |
java.lang.String |
insert(java.lang.String dataSourceName,
java.lang.String parameterName,
java.lang.String desc,
java.lang.String prompt,
java.lang.String type,
java.lang.String defaultValue)
Inserts a JReport parameter object into the specified data source. |
java.lang.String |
insert(java.lang.String dataSourceName,
java.lang.String procName,
java.lang.String catalog,
java.lang.String schema,
java.lang.String name,
java.lang.String remarks,
int iType,
boolean setMappingName)
Inserts a stored procedure into a Connection of the specified data source. |
java.lang.String |
insert(java.lang.String dataSourceName,
java.lang.String procName,
java.lang.String catalog,
java.lang.String schema,
java.lang.String name,
java.lang.String remarks,
int iType,
boolean setMappingName,
java.lang.String connector)
Inserts a stored procedure into the default Connection of the specified data source. |
java.lang.String |
insert(java.lang.String dataSourceName,
java.lang.String procName,
java.lang.String catalog,
java.lang.String schema,
java.lang.String name,
java.lang.String remarks,
int iType,
java.lang.String connector)
Inserts a stored procedure into a Connection of the specified data source. |
java.lang.String |
insert(java.lang.String dataSourceName,
java.lang.String strDSName,
java.lang.String strClassName,
java.lang.String strParameter,
UDSColumnInfo udsColInfo)
Inserts a User Defined Datasource(UDS) into specified data source. |
java.lang.String |
insert(java.lang.String strDSName,
java.lang.String strClassName,
java.lang.String strParameter,
UDSColumnInfo udsColInfo)
Inserts a User Defined Datasource(UDS) into the data source. |
java.lang.String |
insert(java.lang.String dataSourceName,
java.lang.String wherePotionName,
java.lang.String desc,
WherePortionInfo whereportionInfo)
Inserts a predefined WherePortion into the specified data source. |
java.lang.String |
insert(java.lang.String wherePotionName,
java.lang.String desc,
WherePortionInfo whereportionInfo)
Inserts a predefined WherePortion into the data source. |
java.lang.String |
insertBLCategory(java.lang.String parentHandle,
BLCategoryInfo info)
Inserts a Business Logic Category object into the specified container. |
java.lang.String |
insertBLDetail(java.lang.String parentHandle,
BLDetailInfo info)
Inserts a BusinessLogic (also named Business/Report Cube) Detail information object into the specified container object Detail information objects provide additional information. |
java.lang.String |
insertBLDimension(java.lang.String parentHandle,
BLDimensionInfo info)
Inserts a Business Logic (also named Business/Report Cube) Dimension object into the specified object. |
java.lang.String |
insertBLHierarchy(java.lang.String blViewHandle,
BLHierarchyInfo info)
Inserts a Business Logic (also named Business/Report Cube) Hierarchy object into the specified object. |
java.lang.String |
insertBLMeasure(java.lang.String parentHandle,
BLMeasureInfo info)
Inserts a Business Logic (also named Business/Report Cube) Measure objectinto the specified object. |
java.lang.String |
insertBusinessView(java.lang.String dataSourceName,
java.lang.String queriableName,
java.lang.String businessViewName)
Inserts a Business Logic into the specified queriable object. |
java.lang.String |
insertBusinessView(java.lang.String dataSourceName,
java.lang.String queriableName,
java.lang.String businessViewName,
boolean isLogicView)
Inserts a Business Logic/View into the specified queriable object. |
java.lang.String |
insertBusinessViewAggregation(java.lang.String parentHandle,
BVAggregationInfo info)
Inserts a Business View Aggregation object into the specified object. |
java.lang.String |
insertBusinessViewCategory(java.lang.String parentHandle,
BLCategoryInfo info)
Deprecated. |
java.lang.String |
insertBusinessViewCategory(java.lang.String parentHandle,
BusinessViewCategoryInfo info)
Inserts a Business View Category object into the specified object. |
java.lang.String |
insertBusinessViewDetail(java.lang.String parentHandle,
BVDetailInfo info)
Inserts a Business View Detail object into the specified container object. |
java.lang.String |
insertBusinessViewGroup(java.lang.String parentHandle,
BVGroupInfo info)
Inserts a Business View Group object into the specified object. |
java.lang.String |
insertClassHDS(java.lang.String dataSourceName,
java.lang.String name,
java.lang.String classPath,
java.lang.String parameter)
Inserts a hierarchical data sources (HDS) into the catalog. |
java.lang.String |
insertCompCol(java.lang.String qryName,
java.lang.String columnName,
java.lang.String sExpression)
Inserts a Computed Column into the query. |
java.lang.String |
insertCompCol(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String columnName,
java.lang.String sExpression)
Inserts a Computed Column into the query of the specified data source. |
java.lang.String |
insertSql(java.lang.String dataSourceName,
java.lang.String SQLName,
java.lang.String filename)
Inserts an imported query into a Connection of the specified data source. |
java.lang.String |
insertSql(java.lang.String dataSourceName,
java.lang.String connectionName,
java.lang.String SQLName,
java.lang.String filename)
Inserts an imported query into the specified Connection of the specified data source. |
java.lang.String |
insertStoredProcedure(java.lang.String dataSourceName,
java.lang.String connectionName,
java.lang.String procName,
java.lang.String catalog,
java.lang.String schema,
java.lang.String name,
java.lang.String remarks,
int iType,
boolean setMappingName,
java.lang.String connector)
Inserts a stored procedure into the specified Connection of the specified data source. |
java.lang.String |
insertTable(java.lang.String dataSourceName,
java.lang.String connectionName,
java.lang.String tableName,
java.lang.String catalogName,
java.lang.String schemaPattern,
java.lang.String tablePattern,
int type,
java.lang.String character)
Inserts a table or view into the specified data source. |
java.lang.String |
insertWSDLConnection(java.lang.String dataSourceName,
java.lang.String strName,
java.lang.String strDesc,
java.lang.String URI,
int uriType,
ConnectionInfo info)
Inserts a JReport WebService-based connection object into the specified data source. |
java.lang.String |
insertXMLHDS(java.lang.String dataSourceName,
java.lang.String name,
java.lang.String xmlPath,
java.lang.String xsdPath)
Inserts a hierarchical data sources (HDS) into the catalog. |
boolean |
isDistinctQuery(java.lang.String dataSourceName,
java.lang.String queryName)
Geta the distinct status of the query |
boolean |
isModified()
Checks whether or not the catalog has been modified. |
boolean |
isNameExist(java.lang.String name)
Determines whether or not the resource entity exists in the catalog. |
boolean |
isNameExist(java.lang.String dataSourceName,
java.lang.String name)
Determines whether or not the resource entity exists in the specified data source of the catalog. |
java.lang.String |
mapFunction(int function)
Converts aggregate function type from number to String. |
java.lang.String |
parseFormula(FormulaInfo info)
Parses a formula definition in the data source. |
java.lang.String |
parseFormula(java.lang.String dataSourceName,
FormulaInfo info)
Parses a formula definition in the data source. |
java.lang.String |
parseFormulae()
Parses all formulas in the data source. |
java.lang.String |
parseFormulae(java.lang.String dataSourceName)
Parses all formulas in the specified data source. |
boolean |
refreshReference()
Creates a new or refreshes an existing CrossReference with CrossReferenceConfigure. |
void |
rename(java.lang.String resourceName,
java.lang.String newName,
int type)
Renames the specified object. |
void |
rename(java.lang.String dataSourceName,
java.lang.String resourceName,
java.lang.String newName,
int type)
Renames the resource name of the specified object. |
boolean |
save()
Saves an open catalog. |
boolean |
saveAs(java.lang.String path,
java.lang.String name)
Saves an open catalog as a new catalog file. |
boolean |
set(java.lang.String qryName,
AndInfo andInfo)
Adds a new and condition to the query. |
boolean |
set(java.lang.String handle,
FormulaInfo info)
Sets the Formula's information. |
boolean |
set(java.lang.String qryName,
JoinInfo joinInfo)
Adds a new SQL join into the query of the data source. |
boolean |
set(java.lang.String handle,
ParameterInfo info)
Sets the parameter's information. |
boolean |
set(java.lang.String qryName,
QBEInfo qbeInfo)
Adds a QBE condition into the query. |
boolean |
set(java.lang.String dataSourceName,
java.lang.String qryName,
AndInfo andInfo)
Adds a new and condition to the query |
boolean |
set(java.lang.String dataSourceName,
java.lang.String qryName,
JoinInfo joinInfo)
Adds a new SQL join into the query of the specified data source. |
boolean |
set(java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
boolean isFormula)
Adds a table's field into the query of the default data source. |
boolean |
set(java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
java.lang.String expression)
Adds a QBE condition into the query. |
boolean |
set(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
boolean isFormula)
Adds a new table's field into the query of the specified data source. |
boolean |
set(java.lang.String qryName,
java.lang.String sExpression1,
java.lang.String sOperator,
java.lang.String sExpression2,
java.lang.String sLogic)
Adds a new where condition into the query. |
boolean |
set(java.lang.String qryName,
java.lang.String tableFrom,
java.lang.String columnFrom,
java.lang.String operator,
java.lang.String tableTo,
java.lang.String columnTo)
Adds a new SQL join into the query of the specified data source. |
boolean |
set(java.lang.String qryName,
java.lang.String tableFrom,
java.lang.String columnFrom,
java.lang.String operator,
java.lang.String tableTo,
java.lang.String columnTo,
boolean isSQL92,
int outerJoin)
Adds a new join to the query. |
boolean |
set(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tableFrom,
java.lang.String columnFrom,
java.lang.String operator,
java.lang.String tableTo,
java.lang.String columnTo,
boolean isSQL92,
int outerJoin)
Adds a new join to the query. |
boolean |
set(java.lang.String dataSourceName,
java.lang.String qryName,
SubQueryInfo subqueryInfo)
Adds a subquery into the query of the specified data source. |
boolean |
set(java.lang.String dataSourceName,
java.lang.String qryName,
UnionInfo unionInfo)
Adds a union query into the query of the specified data source. |
boolean |
set(java.lang.String qryName,
SubQueryInfo subqueryInfo)
Adds a subquery into the query. |
boolean |
set(java.lang.String handle,
SummaryInfo info)
Sets the Summary's information. |
boolean |
set(java.lang.String qryName,
UnionInfo unionInfo)
Adds a union query into the specified query. |
boolean |
setCompCol(java.lang.String qryName,
java.lang.String columnName,
java.lang.String sExpression)
Modifies the Computed Column in the query. |
boolean |
setCompCol(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String columnName,
java.lang.String sExpression)
Modifies the Computed Column in the query. |
boolean |
setCondition(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String sExpression1,
java.lang.String sOperator,
java.lang.String sExpression2,
java.lang.String sLogic)
Adds a new where condition to the specified query. |
void |
setDefaultConnection(java.lang.String datasourceName,
java.lang.String connectionName)
Sets the specified connection as the default in the specified datasource. |
boolean |
setDefaultDataSource(java.lang.String datasourceName)
Sets the specified data source as the default data source. |
boolean |
setDistinctQuery(java.lang.String dataSourceName,
java.lang.String queryName,
boolean isDisTinct)
set the distinct status of the query |
boolean |
setJoin(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tableFrom,
java.lang.String columnFrom,
java.lang.String operator,
java.lang.String tableTo,
java.lang.String columnTo)
Adds a new SQL join into the query of the specified data source. |
void |
setModified(boolean isModified)
Sets the modifying status of the Catalog. |
boolean |
setQBE(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
java.lang.String expression)
Adds a QBE condition into the query. |
boolean |
setQueryField(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
boolean isMapping,
boolean isFormula)
Adds a new table's field into the query of the specified data source. |
boolean |
setQueryTable(java.lang.String qryName,
java.lang.String tablename,
boolean selectAllFields)
Adds a new table into the query of default data source. |
boolean |
setQueryTable(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
boolean selectAllFields)
Adds a new table into the query of the specified data source. |
boolean |
setQueryTable(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
boolean isMapping,
boolean selectAllFields)
Adds a new table into the query of the specified data source. |
java.lang.String |
updateSQLFile(java.lang.String SQLName,
java.lang.String filename)
Updates an imported query of a Connection of the data source. |
java.lang.String |
updateSQLFile(java.lang.String dataSourceName,
java.lang.String SQLName,
java.lang.String filename)
Updates an imported query of a Connection of the data source. |
boolean |
updateUDS(java.lang.String userDataSourceName)
Updates UDS in the default Data Source of the Catalog. |
boolean |
updateUDS(java.lang.String dataSourceName,
java.lang.String userDataSourceName)
Updates UDS in the specified Data Source of the Catalog. |
| Methods inherited from class jet.api.API |
|---|
clearError, clearMsg, clearWarning, closeLog, containPropName, getBool, getChildren, getClassType, getColor, getDouble, getError, getFloat, getHandles, getHandles, getHandles, getHandles, getInstanceName, getInt, getLong, getParent, getPropNames, getPropType, getQualifyName, getString, getStringArray, getUnit, getWarning, set, set, set, set, set, set, set, setLog, setLog, setLog, setReference, setUnit, writeLog, writeLog |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int CATALOG
public static final int CONNECTION
public static final int TABLE
public static final int VIEW
public static final int COLUMN
public static final int QUERY
public static final int PROCEDURE
public static final int FILESQL
public static final int UDS
public static final int FORMULA
public static final int SUMMARY
public static final int PARAMETER
public static final int WHEREPORTION
public static final int SYNONYM
public static final int ALIAS
public static final int DATABASE
public static final int HDS
public static final int BUSINESSLOGIC
public static final int BUSINESSLOGIC_CATEGORY
public static final int BUSINESSLOGIC_DIMENSION
public static final int BUSINESSLOGIC_MEASURE
public static final int BUSINESSLOGIC_DETAILINFO
public static final int BUSINESSLOGIC_HIERARCHY
public static final int BUSINESSLOGIC_HIERARCHYCONTAINER
public static final int ONDEMAND_QUERY
public static final int XML_CONNECTION
public static final int XML_MDCONTAINER
public static final int BUSINESSVIEW_GROUP
public static final int BUSINESSVIEW_AGGREGATION
public static final int BUSINESSVIEW_DETAIL
public static final int JDBC_ODBC_BRIDGE
public static final int JDBC
public static final int PATTERN_1PART_NAME
public static final int PATTERN_2PART_NAME
public static final int PATTERN_3PART_NAME
public static final int EXTRA_NAME_JDBC
public static final int EXTRA_NAME_USERDEFINED
public static final int ENCODINGAUTO
public static final int ENCODINGYES
public static final int ENCODINGNO
public static final int TRANSACTION_DEFAULT
public static final int TRANSACTION_NONE
public static final int TRANSACTION_READ_UNCOMMITTED
public static final int TRANSACTION_READ_COMMITTED
public static final int TRANSACTION_REPEATABLE_READ
public static final int TRANSACTION_SERIALIZABLE
public static final int READ_ONLY_DEFAULT
public static final int READ_ONLY_TRUE
public static final int READ_ONLY_FALSE
public static final java.lang.String INTEGER
public static final java.lang.String NUMBER
public static final java.lang.String STRING
public static final java.lang.String DECIMAL
public static final java.lang.String CURRENCY
public static final java.lang.String BOOLEAN
public static final java.lang.String DATE
public static final java.lang.String TIME
public static final java.lang.String DATETIME
public static final java.lang.String BINARY
public static final java.lang.String PARAMETERS
public static final int COUNT
public static final int SUM
public static final int AVERAGE
public static final int MAXIMUM
public static final int MINIMUM
public static final int POPULATIONSTDDEV
public static final int POPULATIONVARIANCE
public static final int STDDEV
public static final int VARIANCE
public static final int DISTINCTCOUNT
public static final int RUNNING_COUNT
public static final int RUNNING_DISTINCTCOUNT
public static final int RUNNING_MAXIMUM
public static final int RUNNING_MINIMUM
public static final int RUNNING_AVERAGE
public static final int RUNNING_SUM
public static final int WSDLTYPE_LOCALEFILE
public static final int WSDLTYPE_URI
| Method Detail |
|---|
public java.lang.String getUserID()
CatalogAPI instance
CatalogAPI instance
public boolean save()
throws jet.jetc.WriteFailureException,
jet.universe.exception.FMLFileException
true if the catalog object is saved successfully;
false otherwise.
jet.jetc.WriteFailureException - if the catalog fails to save
the catalog file.
jet.universe.exception.FMLFileException - if the catalog fails to compile
the java class of the formula in the catalog.
public boolean saveAs(java.lang.String path,
java.lang.String name)
path - The file path of the new catalog file. It is the full path of the file.name - The file name of the new catalog file.
true if the catalog file is saved successfully;
false otherwise.public java.lang.String getNewQueryName()
public java.lang.String getNewQueryName(java.lang.String sourceName)
sourceName - The resource name of the data source.
public java.lang.String getNewFormulaName()
public java.lang.String getNewFormulaName(java.lang.String sourceName)
sourceName - The resource name of the data source.
public java.lang.String getNewReportName()
public java.lang.String getMappingname(java.lang.String handle)
handle - Indicates the handle of the object, which can
identify the object in the catalog.
public Designer create(java.lang.String path,
java.lang.String name)
path - The catalog file's path.name - The catalog file's name.
public java.lang.String insert(java.lang.String name,
int type)
name - Indicates the mapping name of the new object.type - Indicates the object type of the new object.
The CatalogAPI class provides a number of convenient constants
that you can use to specify the catalog objects. For example,
QUERYPARAMETERFORMULASUMMARY
public java.lang.String insert(java.lang.String dataSourceName,
java.lang.String name,
int type)
dataSourceName - Indicates the resource name of the data source. If it is null
or "", it means that it is a default data source in the catalog.name - Indicates the resource name of the new object.type - Indicates the object type of the new object.
The CatalogAPI class provides a number of convenient constants
that you can use to specify the catalog objects. For example,
DATABASE- The database in the catalog of JReport is also calleddata dource.QUERYPARAMETERFORMULASUMMARY
public java.lang.String insert(java.lang.String dataSourceName,
java.lang.String procName,
java.lang.String catalog,
java.lang.String schema,
java.lang.String name,
java.lang.String remarks,
int iType,
boolean setMappingName)
dataSourceName - Indicates the resource name of the data source in the catalog.procName - Indicates the new resource name of the procedure defined in
JReport connection.catalog - Indicates the catalog name of the procedure of the real database
if the procedure is defined as a 3-part name model; it must
match the catalog name as it is stored in this database;
"" retrieves those without a catalog; null means that the
catalog name should not be used to narrow the search.schema - Indicates the schema name of the procedure of the real database
if the procedure is defined as a 3-part name model; it must
match the schema name as it is stored in the database;
"" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search.name - Indicates the name of the procedure of the real database.remarks - Indicates the remark of the procedure.iType - Indicates the returned result set's type of the procedure.
Constants of the procedure type:
java.sql.DatabaseMetaData.setMappingName - Indicates whether or not to set the mapping name of a field
in the procedure as "name_fieldName".
null value will be returned.
public java.lang.String insert(java.lang.String dataSourceName,
java.lang.String procName,
java.lang.String catalog,
java.lang.String schema,
java.lang.String name,
java.lang.String remarks,
int iType,
java.lang.String connector)
dataSourceName - Indicates the resource name of the data source in the catalog.procName - Indicates the new resource name of the procedure defined in
JReport connection.catalog - Indicates the catalog name of the procedure of the real database
if the procedure is defined a as 3-part name model; it must
match the catalog name as it is stored in this database;
"" retrieves those without a catalog; null means that the
catalog name should not be used to narrow the searchschema - Indicates the schema name of the procedure of the real database
if the procedure is defined as a 3-part name model; it must
match the schema name as it is stored in the database;
"" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search.name - Indicates the name of the procedure of the real database.remarks - Indicates the remark of the procedure.iType - Indicates the returned result set's type of the procedure.
Constants of the procedure type:
java.sql.DatabaseMetaData.connector - The character which is used to connect table name and fieldName as the mapping name (resource Name) of a field.
null value will be returned.
public java.lang.String insert(java.lang.String dataSourceName,
java.lang.String procName,
java.lang.String catalog,
java.lang.String schema,
java.lang.String name,
java.lang.String remarks,
int iType,
boolean setMappingName,
java.lang.String connector)
dataSourceName - Indicates the resource name of data source in catalog.procName - Indicates the new resource name of the procedure defined in
the JReport connection.catalog - Indicates the catalog name of the procedure of the real database
if the procedure is defined as a 3-part name model; it must
match the catalog name as it is stored in this database;
"" retrieves those without a catalog; null means that the
catalog name should not be used to narrow the searchschema - Indicates the schema name of the procedure of the real database
if the procedure is defined as 3-part name model; it must
match the schema name as it is stored in the database;
"" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search.name - Indicates the name of the procedure of the real database.remarks - Indicates the remark of the procedure.iType - Indicates the returned result set's type of the procedure.
Constants of procedure type:
java.sql.DatabaseMetaData.setMappingName - Indicates whether or not to set the mapping name of a field
in the procedure as "procedureName_fieldName".connector - The character which is used to connect procedure name and fieldName
as the mapping name (resource Name) of the field if setMappingName is true.
null value will be returned.
public java.lang.String insertStoredProcedure(java.lang.String dataSourceName,
java.lang.String connectionName,
java.lang.String procName,
java.lang.String catalog,
java.lang.String schema,
java.lang.String name,
java.lang.String remarks,
int iType,
boolean setMappingName,
java.lang.String connector)
dataSourceName - Indicates the resource name of data source in catalog.connectionName - Indicates the resource name of connection in the data source.procName - Indicates the new resource name of the procedure defined in
the JReport connection.catalog - Indicates the catalog name of the procedure of the real database
if the procedure is defined as a 3-part name model; it must
match the catalog name as it is stored in this database;
"" retrieves those without a catalog; null means that the
catalog name should not be used to narrow the searchschema - Indicates the schema name of the procedure of the real database
if the procedure is defined as 3-part name model; it must
match the schema name as it is stored in the database;
"" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search.name - Indicates the name of the procedure of the real database.remarks - Indicates the remark of the procedure.iType - Indicates the returned result set's type of the procedure.
Constants of procedure type:
java.sql.DatabaseMetaData.setMappingName - Indicates whether or not to set the mapping name of a field
in the procedure as "procedureName_fieldName".connector - The character which is used to connect procedure name and fieldName
as the mapping name (resource Name) of the field if setMappingName is true.
null value will be returned.
public java.lang.String insert(java.lang.String procName,
java.lang.String catalog,
java.lang.String schema,
java.lang.String name,
java.lang.String remarks,
int iType,
boolean setMappingName)
dataSourceName - Indicates the resource name of the data source in the catalog.procName - Indicates the new resource name of the procedure defined in
JReport connection.catalog - Indicates the catalog name of the procedure of the real database
if the procedure is defined as a 3-part name model; it must
match the catalog name as it is stored in this database;
"" retrieves those without a catalog; null means that the
catalog name should not be used to narrow the searchschema - Indicates the schema name of the procedure of the real database
if the procedure is defined as a 3-part name model; it must
match the schema name as it is stored in the database;
"" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search.name - Indicates the name of the procedure of the real database.remarks - Indicates the remark of the procedure.iType - Indicates the returned result set's type of the procedure.
Constants of the procedure:
java.sql.DatabaseMetaData.setMappingName - Indicates whether or not to set the mapping name of a field
in the procedure as "name_fieldName".
null value will be returned.
public java.lang.String insert(java.lang.String procName,
java.lang.String catalog,
java.lang.String schema,
java.lang.String name,
java.lang.String remarks,
int iType)
procName - Indicates the new resource name of the procedure defined in
the JReport connection.catalog - Indicates the catalog name of the procedure of the real database
if the procedure is defined as a 3-part name model; it must
match the catalog name as it is stored in this database;
"" retrieves those without a catalog; null means that the
catalog name should not be used to narrow the searchschema - Indicates the schema name of the procedure of the real database
if the procedure is defined as a 3-part name model; it must
match the schema name as it is stored in the database;
"" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search.name - Indicates the name of the procedure of the real database.remarks - Indicates the remark of the procedure.iType - Indicates the returned result set's type of the procedure.
Constants of procedure type:
java.sql.DatabaseMetaData.
null value will be returned.
public java.lang.String insert(java.lang.String strDSName,
java.lang.String strClassName,
java.lang.String strParameter,
UDSColumnInfo udsColInfo)
strDSName - Indicates the resource name of new UDS.strClassName - Indicates the class name of the UDS.strParameter - Indicates all parameters and their String values.
All parameters and values are assembled as
parameterName-value pairs. For example,
strParameter = "param1=XXX, param2=XXXX".udsColInfo - Indicates the definition of the UDS's columns.
null value will be returned.
public java.lang.String insert(java.lang.String dataSourceName,
java.lang.String strDSName,
java.lang.String strClassName,
java.lang.String strParameter,
UDSColumnInfo udsColInfo)
dataSourceName - Indicates the resource name of data source in catalog.strDSName - Indicates the resource name of new UDS.strClassName - Indicates the class name of the UDS.strParameter - Indicates all parameters and their String values.
All parameters and values are assemble as
parametername-value pairs. For example,
strParameter = "param1=XXX, param2=XXXX".udsColInfo - Indicates the definition of UDS's columns.
null value will be returned.
public java.lang.String insert(java.lang.String parameterName,
java.lang.String desc,
java.lang.String prompt,
java.lang.String type,
java.lang.String defaultValue)
parameterName - Indicates the mapping name of the new parameter.desc - Indicates a description of the parameter.prompt - Specifies the prompt text for the new parameter. The prompt
text can help user to input a parameter value in runtime.type - Indicates the parameter's data type. Defined
constants for the type:
defaultValue - Sets a default value for the parameter. The value and its format
must match the parameter's type.
null value will be returned.
public java.lang.String insert(java.lang.String dataSourceName,
java.lang.String parameterName,
java.lang.String desc,
java.lang.String prompt,
java.lang.String type,
java.lang.String defaultValue)
dataSourceName - Indicates the resource name of the data source in the catalog.parameterName - Indicates the mapping name of the new parameter.desc - Indicates a description of the parameter.prompt - Specifies the prompt text for the new parameter. The prompt
text can help user to input parameter value in runtime.type - Indicates the parameter's data type. Defined
constants for the type:
defaultValue - Sets a default value for the parameter. The value and its format
must match the parameter's type.
null value will be returned.
public java.lang.String insert(java.lang.String wherePotionName,
java.lang.String desc,
WherePortionInfo whereportionInfo)
wherePotionName - Indicates the resource name of the WherePotion.desc - Specifies the description of the WherePotion.whereportionInfo - The WherePortion's information.
null value will be returned.
public java.lang.String insert(java.lang.String dataSourceName,
java.lang.String wherePotionName,
java.lang.String desc,
WherePortionInfo whereportionInfo)
dataSourceName - Indicates the resource name of the data source in the catalog.wherePotionName - Indicates the resource name of the WherePotion.desc - Specifies the description of the WherePotion.whereportionInfo - The WherePortion's information.
null value will be returned.
public java.lang.String insert(java.lang.String formulaName,
java.lang.String desc,
java.lang.String expression)
formulaName - Indicates the mapping name of the formula.desc - Indicates the description of the formulaexpression - Indicates the expression and function in String format.
null value will be returned.
public java.lang.String insert(java.lang.String dataSourceName,
java.lang.String formulaName,
java.lang.String desc,
java.lang.String expression)
dataSourceName - Indicates the resource name of the data source in the catalog.formulaName - Indicates the mapping name of the formula.desc - Indicates the description of the formulaexpression - Indicates the expression and function in String format.
null value will be returned.
public java.lang.String insert(java.lang.String summaryName,
java.lang.String desc,
int functionType,
java.lang.String fieldName,
java.lang.String groupByFld)
summaryName - Indicates the mapping name of the new summary.desc - Indicates the description of the function.functionType - Indicates the function type. Defined
constants for the function type:
COUNT
SUM
AVERAGE
MAXIMUM
MINIMUM
POPULATIONSTDDEV
POPULATIONVARIANCE
STDDEV
VARIANCE
DISTINCTCOUNT
RUNNING_COUNT
RUNNING_SUM
RUNNING_MAXIMUM
RUNNING_MINIMUM
RUNNING_AVERAGE
RUNNING_DISTINCTCOUNTfieldName - Indicates the mapping name of the field that is calculated on.groupByFld - Indicates the mapping name of the field that is grouped by.
null value will be returned.
public java.lang.String insert(java.lang.String dataSourceName,
java.lang.String summaryName,
java.lang.String desc,
int functionType,
java.lang.String fieldName,
java.lang.String groupByFld)
dataSourceName - Indicates the resource name of the data source in the catalog.summaryName - Indicates the mapping name of the new summary.desc - Indicates the description of the function.functionType - Indicates the function type. Defined
constants for the function type:
COUNT
SUM
AVERAGE
MAXIMUM
MINIMUM
POPULATIONSTDDEV
POPULATIONVARIANCE
STDDEV
VARIANCE
DISTINCTCOUNT
RUNNING_COUNT
RUNNING_SUM
RUNNING_MAXIMUM
RUNNING_MINIMUM
RUNNING_AVERAGE
RUNNING_DISTINCTCOUNTfieldName - Indicates the mapping name of the field that is calculated on.groupByFld - Indicates the mapping name of the field that is grouped by.
null value will be returned.
public java.lang.String insert(java.lang.String SQLName,
java.lang.String filename)
SQLName - Indicates the resource name of the new imported query.filename - Indicates the full path file name of the imported query.
null value will be returned.
public java.lang.String insertSql(java.lang.String dataSourceName,
java.lang.String SQLName,
java.lang.String filename)
dataSourceName - Indicates the resource name of the data source in the catalog.SQLName - Indicates the resource name of the new imported query.filename - Indicates the full path file name of the imported query.
null value will be returned.
public java.lang.String insertSql(java.lang.String dataSourceName,
java.lang.String connectionName,
java.lang.String SQLName,
java.lang.String filename)
dataSourceName - Indicates the resource name of the data source in the catalog.connectionName - Indicates the resource name of the connection in the specified data source in the catalog.SQLName - Indicates the resource name of the new imported query.filename - Indicates the full path file name of the imported query.
null value will be returned.
public java.lang.String updateSQLFile(java.lang.String SQLName,
java.lang.String filename)
SQLName - Indicates the resource name of the imported query.filename - Indicates the full path file name of the imported query.
null value will be returned.
public java.lang.String updateSQLFile(java.lang.String dataSourceName,
java.lang.String SQLName,
java.lang.String filename)
dataSourceName - Indicates the resource name of the data source in the catalog.SQLName - Indicates the resource name of the imported query.filename - Indicates the full path file name of the imported query.
null value will be returned.
public java.lang.String insert(boolean bUseJDBCODBCBridge,
java.lang.String name,
java.lang.String desc,
java.lang.String url,
java.lang.String driver)
bUseJDBCODBCBridge - Indicates how to connect to the database. if it is
true, connects by the
JDBC_ODBC bridge; otherwise, connects by JDBC driver.name - Indicates the resource name of the connection.desc - Indicates a String description for the connectionurl - Indicates the URL used to connect to the database if
UseJDBCODBCBridge is false;
otherwise, it is the data source name (for JDBC-ODBC bridge).driver - Indicates the driver class name used to connect to the database if
UseJDBCODBCBridge is false.
null value will be returned.
public java.lang.String insert(java.lang.String dataSourceName,
boolean bUseJDBCODBCBridge,
java.lang.String name,
java.lang.String desc,
java.lang.String url,
java.lang.String driver)
bUseJDBCODBCBridge - Indicates how to connect to the database. if it is
true, connects by the
JDBC_ODBC bridge; otherwise, connects by JDBC driver.name - Indicates the resource name of the connection.desc - Indicates a String description for the connectionurl - Indicates the URL used to connect to the database if
UseJDBCODBCBridge is false;
otherwise, it is the data source name (for JDBC-ODBC bridge).driver - Indicates the driver class name used to connect to the database if
UseJDBCODBCBridge is false.
null value will be returned.
public java.lang.String insert(boolean bUseJDBCODBCBridge,
java.lang.String strName,
java.lang.String strDesc,
java.lang.String URL,
java.lang.String driver,
ConnectionInfo info)
dataSourceName - Indicates the resource name of the data source in the catalog.bUseJDBCODBCBridge - Indicates how to connect to the database. if it is
true, connects by the
JDBC_ODBC bridge; otherwise, connects by JDBC driver.strName - Indicates the resource name of the connection.strDesc - Indicates a String description for the connectionURL - Indicates the URL used to connect to the database if
UseJDBCODBCBridge is false;
otherwise, it is the data source name (for JDBC-ODBC bridge).driver - Indicates the driver class name used to connect to the database if
UseJDBCODBCBridge is false.info - Defines the properties of the connection, such as username and password.
null value will be returned.
public java.lang.String insert(java.lang.String dataSourceName,
boolean bUseJDBCODBCBridge,
java.lang.String strName,
java.lang.String strDesc,
java.lang.String URL,
java.lang.String DRV,
ConnectionInfo info)
dataSourceName - Indicates the resource name of the data source in the catalog.bUseJDBCODBCBridge - Indicates how to connect to the database. if it is
true, connects by the
JDBC_ODBC bridge; otherwise, connects by JDBC driver.strName - Indicates the resource name of the connection.strDesc - Indicates a String description for the connectionURL - Indicates the URL used to connect to the database if
UseJDBCODBCBridge is false;
otherwise, it is the data source name (for JDBC-ODBC bridge).driver - Indicates the driver class name used to connect to the database if
UseJDBCODBCBridge is false.info - Defines the properties of the connection, such as username and password.
null value will be returned.
public java.lang.String insertWSDLConnection(java.lang.String dataSourceName,
java.lang.String strName,
java.lang.String strDesc,
java.lang.String URI,
int uriType,
ConnectionInfo info)
dataSourceName - Indicates the resource name of the data source in the catalog.bUseJDBCODBCBridge - Indicates how to connect to the database. if it is
true, connects by the
JDBC_ODBC bridge; otherwise, connects by JDBC driver.strName - Indicates the resource name of the connection.strDesc - Indicates a String description for the connectionURI - Indicates to use the URI or file location to connect to the WebService.uriType - Indicates to use a WSDL file on your local disk or through a URI.
info - Defines the properties of the connection, such as username and password.
null value will be returned.public ConnectionInfo getConnectionInfo()
ConnectionInfo storing the connection propertiespublic ConnectionInfo getConnectionInfo(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
ConnectionInfo storing the connection properties
public ConnectionInfo getConnectionInfo(java.lang.String dataSourceName,
java.lang.String connectionName)
dataSourceName - Indicates the resource name of the data source in the catalog.connectionName - Indicates the resource name of connection in the specified data source.
if it is null, it means default connection.
ConnectionInfo storing the connection properties
public java.lang.String insert(java.lang.String catalogName,
java.lang.String schemaPattern,
java.lang.String tablePattern,
int type)
catalog - Indicates the catalog name of the table in the real database.
if the table is defined as a 3-part name model; it must
match the catalog name as it is stored in this database;
"" retrieves those without a catalog; null means that the
catalog name should not be used to narrow the searchschema - Indicates the schema name of the table in the real database.
if the table is defined as a 3-part name model; it must
match the schema name as it is stored in the database;
"" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search.tablePattern - Indicates the table name of the table in the real database.
And this name is also defined as mapping name in JReport database.type - Indicates the type of table in data source. Constants of the table type:
null value will be returned.
public java.lang.String insert(java.lang.String catalogName,
java.lang.String schemaPattern,
java.lang.String tablePattern,
int type,
boolean setMappingName)
catalog - Indicates the catalog name of the table in the real database.
if the table is defined as a 3-part name model; it must
match the catalog name as it is stored in this database;
"" retrieves those without a catalog; null means that the
catalog name should not be used to narrow the searchschema - Indicates the schema name of the table in the real database.
if the table is defined as a 3-part name model; it must
match the schema name as it is stored in the database;
"" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search.tablePattern - Indicates the table name of the table in the real database.
And this name is also defined as the mapping name in JReport data source.type - Indicates the type of table in database. Constants of the table type:
setMappingName - Indicates whether or not to set the mapping name of the field
in the table as "tablePattern_fieldName".
null value will be returned.
public java.lang.String insert(java.lang.String tableName,
java.lang.String catalogName,
java.lang.String schemaPattern,
java.lang.String tablePattern,
int type,
boolean setMappingName)
tablename - Indicates the mapping name of the table.catalog - Indicates the catalog name of the table in the real database.
if the table is defined as a 3-part name model; it must
match the catalog name as it is stored in this database;
"" retrieves those without a catalog; null means that the
catalog name should not be used to narrow the searchschema - Indicates the schema name of the table in the real database.
if the table is defined as a 3-part name model; it must
match the schema name as it is stored in the database;
"" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search.tablePattern - Indicates the table name of the table in the real database.
And this name is also defined as the mapping name in JReport data source.type - Indicates the type of table in database. Constants of the table type:
setMappingName - Indicates whether or not to set the mapping name of the field
in the table as "tablePattern_fieldName".
null value will be returned.
public java.lang.String insert(java.lang.String tableName,
java.lang.String catalogName,
java.lang.String schemaPattern,
java.lang.String tablePattern,
int type,
java.lang.String character)
tablename - Indicates the mapping name of the table.catalog - Indicates the catalog name of the table in the real database.
if the table is defined as a 3-part name model; it must
match the catalog name as it is stored in this database;
"" retrieves those without a catalog; null means that the
catalog name should not be used to narrow the searchschema - Indicates the schema name of the table in the real database.
if the table is defined as a 3-part name model; it must
match the schema name as it is stored in the database;
"" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search.tablePattern - Indicates the table name of the table in the real database.
And this name is also defined as the mapping name in JReport database.type - Indicates the type of table in the data source. Constants of table type:
character - The character which is used to connect table name and field Name
as the mapping name (resource Name) of the field.
null value will be returned.
public java.lang.String insert(java.lang.String dataSourceName,
java.lang.String tableName,
java.lang.String catalogName,
java.lang.String schemaPattern,
java.lang.String tablePattern,
int type,
java.lang.String character)
dataSourceName - Indicates the resource name of the data source in the catalog.tablename - Indicates the mapping name of the table.catalog - Indicates the catalog name of the table in the real database.
if the table is defined as a 3-part name model; it must
match the catalog name as it is stored in this database;
"" retrieves those without a catalog; null means that the
catalog name should not be used to narrow the searchschema - Indicates the schema name of the table in the real database.
if the table is defined as a 3-part name model; it must
match the schema name as it is stored in the database;
"" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search.tablePattern - Indicates the table name of the table in the real database.
And this name is also defined as the mapping name in JReport data source.type - Indicates the type of the table in the database. Constants of table type:
character - The character which is used to connect table name and field Name
as the mapping name (resource Name) of the field.
null value will be returned.
public java.lang.String insertTable(java.lang.String dataSourceName,
java.lang.String connectionName,
java.lang.String tableName,
java.lang.String catalogName,
java.lang.String schemaPattern,
java.lang.String tablePattern,
int type,
java.lang.String character)
dataSourceName - Indicates the resource name of the data source in the catalog.tablename - Indicates the mapping name of the table.catalog - Indicates the catalog name of the table in the real database.
if the table is defined as a 3-part name model; it must
match the catalog name as it is stored in this database;
"" retrieves those without a catalog; null means that the
catalog name should not be used to narrow the searchschema - Indicates the schema name of the table in the real database.
if the table is defined as a 3-part name model; it must
match the schema name as it is stored in the database;
"" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search.tablePattern - Indicates the table name of the table in the real database.
And this name is also defined as the mapping name in JReport data source.type - Indicates the type of the table in the database. Constants of table type:
character - The character which is used to connect table name and field Name
as the mapping name (resource Name) of the field.
null value will be returned.public java.lang.String[] getPrimaryKeys(java.lang.String tablename)
tablename - Indicates the mapping name of the table.
public java.lang.String[] getPrimaryKeys(java.lang.String dataSourceName,
java.lang.String tablename)
dataSourceName - Indicates the mapping name of the data source in the catalog.tablename - Indicates the mapping name of the table.
public java.lang.String[] getPrimaryKeys(java.lang.String dataSourceName,
java.lang.String connectionName,
java.lang.String tablename)
dataSourceName - Indicates the resource name of the data source in the catalog.connectionName - Indicates the resource name of the connection in the specified data source.tablename - Indicates the mapping name of the table.
public java.lang.String[] getForeignKeys(java.lang.String tablename)
tablename - Indicates the mapping name of the table.
public java.lang.String[] getForeignKeys(java.lang.String dataSourceName,
java.lang.String tablename)
dataSourceName - Indicates the resource name of the data source in the catalog.tablename - Indicates the mapping name of the table.
public java.lang.String[] getForeignKeys(java.lang.String dataSourceName,
java.lang.String connectionName,
java.lang.String tablename)
dataSourceName - Indicates the resource name of the data source in the catalog.connectionName - Indicates the resource name of the connection in the specified data source.tablename - Indicates the mapping name of the table.
public java.lang.String insertCompCol(java.lang.String qryName,
java.lang.String columnName,
java.lang.String sExpression)
qryName - Indicates the resource name of the query.columnName - Indicates the mapping name of the computed column.sExpression - Indicates the expression String of this computed column.
null value will be returned.
public java.lang.String insertCompCol(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String columnName,
java.lang.String sExpression)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.columnName - Indicates the mapping name of the computed column.sExpression - Indicates the expression String of this computed column.
null value will be returned.
public boolean deleteCompCol(java.lang.String qryName,
java.lang.String columnName)
qryName - Indicates the resource name of the query.columnName - Indicates the mapping name of the computed column.
true if the specified Computed Column is removed from query;
false otherwise.
public boolean deleteCompCol(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String columnName)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.columnName - Indicates the mapping name of the computed column.
true if the specified Computed Column is removed from query;
false otherwise.
public boolean setCompCol(java.lang.String qryName,
java.lang.String columnName,
java.lang.String sExpression)
qryName - Indicates the resource name of the query.columnName - Indicates the mapping name of the computed column.sExpression - Indicates the new expression String of the computed column.
true if the specified Computed Column is changed in query;
false otherwise.
public boolean setCompCol(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String columnName,
java.lang.String sExpression)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.columnName - Indicates the mapping name of the computed column.sExpression - Indicates the new expression String of the computed column.
true if the specified Computed Column is changed in query;
false otherwise.
public java.lang.String insert(java.lang.String qryName,
QueryFieldInfo queryFieldInfo,
QueryJoinInfo queryJoinInfo,
QueryQBEInfo queryQBEInfo,
QueryAndInfo queryAndInfo)
Relational databases typically contain many rows of data, with each row constituting a separate record. Most relational database queries retrieve only a portion of the records contained in a table. The WHERE clause qualifies the query command statement to limit the data to specific records from the tables.
JReport Query's concept is similar to that in the database. The working objects a query can select include tables/views (DBFields), formulas or summaries, and parameters, and the tables/views it can select from are the mapped tables/views defined in a JReport catalog. In this way, a query is independent from the raw database. You can use queries to view, change and analyze data in different ways, and JReport can help you with the building of various professional reports based on queries.
qryName - Indicates the resource name of the query.queryFieldInfo - Indicates the information of the table and fields in the query.queryJoinInfo - Indicates the joins information of the query.queryQBEInfo - Indicates the QBE(Query By Example) information of the query.queryAndInfo - Indicates the where condition information of the query.
null value will be returned.
public java.lang.String insert(java.lang.String dataSourceName,
java.lang.String qryName,
QueryFieldInfo queryFieldInfo,
QueryJoinInfo queryJoinInfo,
QueryQBEInfo queryQBEInfo,
QueryAndInfo queryAndInfo)
Relational databases typically contain many rows of data, with each row constituting a separate record. Most relational database queries retrieve only a portion of the records contained in a table. The WHERE clause qualifies the query command statement to limit the data to specific records from the tables.
JReport Query's concept is similar to that in the database. The working objects a query can select include tables/views (DBFields), formulas or summaries, and parameters, and the tables/views it can select from are the mapped tables/views defined in a JReport catalog. In this way, a query is independent from the raw database. You can use queries to view, change and analyze data in different ways, and JReport can help you with the building of various professional reports based on queries.
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.queryFieldInfo - Indicates the information of the table and fields in the query.queryJoinInfo - Indicates the joins information of the query.queryQBEInfo - Indicates the QBE(Query By Example) information of the query.queryAndInfo - Indicates the where condition information of the query.
null value will be returned.
public java.lang.String insertXMLHDS(java.lang.String dataSourceName,
java.lang.String name,
java.lang.String xmlPath,
java.lang.String xsdPath)
dataSourceName - Indicates the resource name of the data source in the catalog.name - Indicates the resource name of HDS.xmlPath - Indicates the full file path of imported XML file.xsdPath - Indicates the full file path of imported XSD file.
null value will be returned.
public java.lang.String insertClassHDS(java.lang.String dataSourceName,
java.lang.String name,
java.lang.String classPath,
java.lang.String parameter)
dataSourceName - Indicates the resource name of the data source in the catalog.name - Indicates the resource name of HDS.classPath - Indicates the full path of the class that implements HDS API.parameter - Indicates the values of the parameter that can be identified by
the implementation class.
null value will be returned.public boolean deleteQuery(java.lang.String qryName)
qryName - Indicates the resource name of the query to be deleted.
true if deleted successfully; false otherwise.
public boolean deleteQuery(java.lang.String dataSourceName,
java.lang.String qryName)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query to be deleted.
true if deleted successfully; false otherwise.
public boolean delete(java.lang.String qryName,
java.lang.String tablename)
qryName - Indicates the resource name of the query.tablename - Indicates the mapping name of the table to be deleted.
true if deleted successfully; false otherwise.
public boolean deleteQueryTable(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.tablename - Indicates the mapping name of the table to be deleted.
true if deleted successfully; false otherwise.
public boolean delete(java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname)
qryName - Indicates the resource name of the query.tablename - Indicates the mapping name of the table to be deleted.columnname - Indicates the mapping name of the deleted field.
true if deleted successfully; false otherwise.
public boolean deleteQueryField(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.tablename - Indicates the mapping name of the table to be deleted.columnname - Indicates the mapping name of the deleted field.
true if deleted successfully; false otherwise.
public boolean delete(java.lang.String qryName,
java.lang.String tableFrom,
java.lang.String columnFrom,
java.lang.String operator,
java.lang.String tableTo,
java.lang.String columnTo)
qryName - Indicates the resource name of the query.tableFrom - The name of the table from which the join links.columnFrom - The name of the column from which the join links.tableTo - The name of the table to which the join links.columnTo - The name of the column to which the join links.operator - The String operator of the join to be deleted.
true if deleted successfully; false otherwise.
public boolean delete(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tableFrom,
java.lang.String columnFrom,
java.lang.String operator,
java.lang.String tableTo,
java.lang.String columnTo)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query to be changed.tableFrom - The name of the table from which the join links.columnFrom - The name of the column from which the join links.tableTo - The name of the table to which the join links.columnTo - The name of the column to which the join links.operator - The operator of the join to be deleted.
true if deleted successfully; false otherwise.
public boolean delete(java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
java.lang.String expression)
qryName - Indicates the resource name of the query.tablename - The name of the table where the QBE condition is.columnname - The name of the column where the QBE condition is.expression - The expression of the QBE condition.
true if deleted successfully; false otherwise.
public boolean deleteQBE(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
java.lang.String expression)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.tablename - The name of the table where the QBE condition is.columnname - The name of the column where the QBE condition is.expression - The expression of the QBE condition.
true if deleted successfully; false otherwise.
public boolean delete(java.lang.String qryName,
java.lang.String sExpression1,
java.lang.String sOperator,
java.lang.String sExpression2,
java.lang.String sLogic)
qryName - Indicates the query name in which the where clause stored.sLogic - The logic string of the where condition to be deleted.
The logic describes the relationship between this sentence
and the next condition, such as "AND" and "OR".sExpression1 - The first expression of the where condition to be deleted.sOperator - The operator of the where condition to be deleted.sExpression2 - The second expression of the where condition to be deleted.
true if deleted successfully; false otherwise.
public boolean deleteCondition(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String sExpression1,
java.lang.String sOperator,
java.lang.String sExpression2,
java.lang.String sLogic)
dataSourceName - Indicates the resource name of data source in catalog.qryName - Indicates the query name in which the where clause stored.sLogic - The logic string of the where condition to be deleted.
The logic describes the relationship between this sentence
and the next condition, such as "AND" and "OR".sExpression1 - The first expression of the where condition to be deleted.sOperator - The operator of the where condition to be deleted.sExpression2 - The second expression of the where condition to be deleted.
true if deleted successfully; false otherwise.
public boolean delete(java.lang.String qryName,
UnionInfo info)
qryName - Indicates the resource name of the query.info - Indicates the information of the union query to be deleted.
If and only if this definition of the union query matches the existing one in the
specified query, the union will be deleted.
true if deleted successfully; false otherwise.
public boolean delete(java.lang.String dataSourceName,
java.lang.String qryName,
UnionInfo info)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.info - Indicates the information of the union query to be deleted.
If and only if this definition of the union query matches the existing one in the
specified query, the union will be deleted.
true if deleted successfully; false otherwise.
public boolean delete(java.lang.String qryName,
java.lang.String unionQuery,
boolean unionAll)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.unionQuery - Indicates the resource name of the union query to be deleted.unionAll - Specifies the "unionAll" status of the union query to be deleted.
If true, all records will be returned;
If false, no duplicate records will be returned.
true if deleted successfully; false otherwise.
public boolean deleteUnionQuery(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String unionQuery,
boolean unionAll)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.unionQuery - Indicates the resource name of the union query to be deleted.unionAll - Specifies the "unionAll" status of the union query to be deleted.
If true, all records will be returned;
If false, no duplicate records will be returned.
true if deleted successfully; false otherwise.
public boolean setQueryTable(java.lang.String qryName,
java.lang.String tablename,
boolean selectAllFields)
qryName - Indicates the resource name of the query to be changed.tablename - Indicates the real name of the table to be inserted.selectAllFields - Indicates whether or not to insert the table with all its fields.
true if inserted successfully; false otherwise.
public boolean setQueryTable(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
boolean selectAllFields)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query to be changed.tablename - Indicates the real name of the table to be inserted.selectAllFields - Indicates whether or not to insert the table with all its fields.
true if inserted successfully; false otherwise.
public boolean setQueryTable(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
boolean isMapping,
boolean selectAllFields)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query to be changed.tablename - Indicates the real name of the table to be inserted.isMapping - Indicates whether or not to use table's mapping name to define the query table.selectAllFields - Indicates whether or not to insert the table with all its fields.
true if inserted successfully; false otherwise.
public boolean set(java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
boolean isFormula)
dataSourceName - Indicates the resource name of the data source in the catalog.tablename - Indicates the real name of the table to be inserted.
If isFormula is true, this is ignored.columnname - Indicates the column real name of the table to be inserted.
If isFormula is true, this is mapping name of the formula.isFormula - Indicates whether or not to insert a formula into the query.
true if inserted successfully; false otherwise.setQueryField(String, String, String, String, boolean, boolean)
public boolean set(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
boolean isFormula)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query to be changed.tablename - Indicates the real name of the table to be inserted.
If isFormula is true, this is ignored.columnname - Indicates the column real name of the table to be inserted.
If isFormula is true, this is mapping name of the formula.isFormula - Indicates whether or not to insert a formula into the query.
true if inserted successfully; false otherwise.setQueryField(String, String, String, String, boolean, boolean)
public boolean setQueryField(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
boolean isMapping,
boolean isFormula)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query to be changed.tablename - Indicates the real name of the table to be inserted.
If isFormula is true, this is ignored.columnname - Indicates the column real name of the table to be inserted.
If isFormula is true, this is mapping name of the formula.isMapping - Indicates whether or not to use table/field's mapping name to define the query field.isFormula - Indicates whether or not to insert a formula into the query.
true if inserted successfully; false otherwise.
public boolean set(java.lang.String qryName,
JoinInfo joinInfo)
qryName - Indicates the resource name of the query to be changed.joinInfo - Defines a join definition to be inserted.
true if inserted successfully; false otherwise.
public boolean set(java.lang.String dataSourceName,
java.lang.String qryName,
JoinInfo joinInfo)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query to be changed.joinInfo - Defines a join definition to be inserted.
true if inserted successfully; false otherwise.
public boolean set(java.lang.String qryName,
java.lang.String tableFrom,
java.lang.String columnFrom,
java.lang.String operator,
java.lang.String tableTo,
java.lang.String columnTo)
qryName - Indicates the resource name of the query to be changed.tableFrom - The name of the table from which the join links.columnFrom - The name of the column from which the join links.tableTo - The name of the table to which the join links.columnTo - The name of the column to which the join links.operator - Operator of the join to be inserted.
true if inserted successfully; false otherwise.
public boolean setJoin(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tableFrom,
java.lang.String columnFrom,
java.lang.String operator,
java.lang.String tableTo,
java.lang.String columnTo)
dataSourceName - Indicates the resource name of the data source inthe catalog.qryName - Indicates the resource name of the query to be changed.tableFrom - The name of the table from which the join links.columnFrom - The name of the column from which the join links.tableTo - The name of the table to which the join links.columnTo - The name of the column to which the join links.operator - Operator of the join to be inserted.
true if inserted successfully; false otherwise.
public boolean setDistinctQuery(java.lang.String dataSourceName,
java.lang.String queryName,
boolean isDisTinct)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query to be changed.isDisTinct - Indicates whether or not to set "distinct select" status of the query.
true if the parameter is set successfully; otherwise false.
public boolean isDistinctQuery(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.
true if the query is defined as distinct select; false otherwise.
public boolean set(java.lang.String qryName,
java.lang.String tableFrom,
java.lang.String columnFrom,
java.lang.String operator,
java.lang.String tableTo,
java.lang.String columnTo,
boolean isSQL92,
int outerJoin)
qryName - Indicates the resource name of the query.tableFrom - Indicates the name of the table from which the join links.columnFrom - Indicates the name of the column from which the join links.tableTo - Indicates the name of the table to which the join links.columnTo - Indicates the name of the column to which the join links.operator - Indicates the operator of the join to be inserted.isSQL92 - Indicates whether or not to apply SQL92 standard to the join sentence.
The property is moved to JDBC connection.outerJoin - Indicates the type of the outer join. Constants of Join type:
JoinInfo#LEFTOUTER
JoinInfo#RIGHTOUTER
true if inserted successfully; false otherwise.
public boolean set(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tableFrom,
java.lang.String columnFrom,
java.lang.String operator,
java.lang.String tableTo,
java.lang.String columnTo,
boolean isSQL92,
int outerJoin)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.tableFrom - Indicates the name of the table from which the join links.columnFrom - Indicates the name of the column from which the join links.tableTo - Indicates the name of the table to which the join links.columnTo - Indicates the name of the column to which the join links.operator - Indicates the operator of the join to be inserted.isSQL92 - Indicates whether or not to apply SQL92 standard to the join sentence.
outerJoin - Indicates the type of the outer join. Constants of Join type:
JoinInfo#LEFTOUTER
JoinInfo#RIGHTOUTER
true if inserted successfully; false otherwise.
public boolean set(java.lang.String qryName,
QBEInfo qbeInfo)
qryName - Indicates the resource name of the query to be changed.qbeInfo - Indicates the QBE information.
true if inserted successfully; false otherwise.
public boolean set(java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
java.lang.String expression)
qryName - Indicates the resource name of the query to be changed.tablename - The name of the table where the QBE condition will be added.columnname - The name of the column where the QBE condition will be added.expression - The expression of the QBE condition.
true if inserted successfully; false otherwise.
public boolean setQBE(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String tablename,
java.lang.String columnname,
java.lang.String expression)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query to be changed.tablename - The name of the table where the QBE condition will be added.columnname - The name of the column where the QBE condition will be added.expression - The expression of the QBE condition.
true if inserted successfully; false otherwise.public java.lang.String[] getUnionableQueries(java.lang.String queryname)
queryname - Indicates the resource name of the query to be changed.
public java.lang.String[] getUnionableQueries(java.lang.String dataSourceName,
java.lang.String queryname)
dataSourceName - Indicates the resource name of the data source in the catalog.queryname - Indicates the resource name of the query to be changed.
public UnionInfos getUnionInfos(java.lang.String queryName)
queryName - Indicates the resource name of the query.
public UnionInfos getUnionInfos(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public java.lang.String[] getUnionQueries(java.lang.String queryName)
queryName - Indicates the resource name of the query.
public java.lang.String[] getUnionQueries(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public java.lang.String[] getUnionQueries(java.lang.String queryName,
boolean isUnionAll)
queryName - Indicates the resource name of the query.isUnionAll - Indicates the union status.
public java.lang.String[] getUnionQueries(java.lang.String dataSourceName,
java.lang.String queryName,
boolean isUnionAll)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.isUnionAll - Indicates the union status.
public boolean set(java.lang.String qryName,
SubQueryInfo subqueryInfo)
qryName - Indicates the resource name of the query to be changed.subqueryInfo - Indicates subquery's information.
true if inserted successfully; false otherwise.
public boolean set(java.lang.String dataSourceName,
java.lang.String qryName,
SubQueryInfo subqueryInfo)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query to be changed.subqueryInfo - The class defines the subquery's information.
true if inserted successfully; false otherwise.
public boolean set(java.lang.String qryName,
UnionInfo unionInfo)
qryName - Indicates the resource name of the query to be changed.unionInfo - Union query information.
true if inserted successfully; false otherwise.
public boolean set(java.lang.String dataSourceName,
java.lang.String qryName,
UnionInfo unionInfo)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query to be changed.unionInfo - Union query information.
true if inserted successfully; false otherwise.
public boolean set(java.lang.String qryName,
AndInfo andInfo)
qryName - Indicates the resource name of the query to be changed.andInfo - "And" information.
true if inserted successfully; false otherwise.
public boolean set(java.lang.String dataSourceName,
java.lang.String qryName,
AndInfo andInfo)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query to be changed.andInfo - "And" information.
true if inserted successfully; false otherwise.
public boolean set(java.lang.String qryName,
java.lang.String sExpression1,
java.lang.String sOperator,
java.lang.String sExpression2,
java.lang.String sLogic)
qryName - Indicates the resource name of the query to be changed.sLogic - The logic string of the where condition to be inserted.sExpression1 - The first expression of the where condition to be inserted.sOperator - The operator of the where condition to be inserted.sExpression2 - The second expression of the where condition to be inserted.
true if inserted successfully; false otherwise.
public boolean setCondition(java.lang.String dataSourceName,
java.lang.String qryName,
java.lang.String sExpression1,
java.lang.String sOperator,
java.lang.String sExpression2,
java.lang.String sLogic)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query to be changed.sLogic - The logic string of the where condition to be inserted.sExpression1 - The first expression of the where condition to be inserted.sOperator - The operator of the where condition to be inserted.sExpression2 - The second expression of the where condition to be inserted.
true if inserted successfully; false otherwise.
public boolean set(java.lang.String handle,
ParameterInfo info)
handle - Indicates the handle of the parameter. The handle is the unique
ID of the object in the catalog.info - Indicates the new parameter's information.
true if inserted successfully; false otherwise.public boolean checkParam(ParameterInfo info)
info - The definition of the parameter to be checked.
true if the parameter is valid;false otherwise.public ParameterInfo getParameterInfo(java.lang.String handle)
handle - Indicates the handle of the parameter. The handle is the unique
ID of the object in the catalog.
public SummaryInfo getSummaryInfo(java.lang.String handle)
handle - Indicates the handle of the Summary. The handle is the unique
ID of the object in the catalog.
public FormulaInfo getFormulaInfo(java.lang.String handle)
handle - Indicates the handle of the Formula. The handle is the unique
ID of the object in the catalog.
public boolean set(java.lang.String handle,
SummaryInfo info)
handle - Indicates the handle of the Summary. The handle is the unique
ID of the object in the catalog.info - Indicates the new Summary information.
true if inserted successfully; false otherwise.
public boolean set(java.lang.String handle,
FormulaInfo info)
handle - Indicates the handle of the Formula. The handle is the unique
ID of the object in the catalog.info - Indicates the new formula's information.
true if inserted successfully; false otherwise.public java.lang.String parseFormulae()
null if sccessful, otherwise returns error prompt text.public java.lang.String parseFormulae(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
null if sccessful, otherwise returns error prompt textpublic java.lang.String parseFormula(FormulaInfo info)
info - The encapsulated definition of JReport Formula.
null if successful, otherwise returns error prompt text.
public java.lang.String parseFormula(java.lang.String dataSourceName,
FormulaInfo info)
info - the encapsulated definition of JReport Formula.dataSourceName - Indicates the resource name of the data source in the catalog.
null if successful, otherwise returns error prompt text.public boolean isNameExist(java.lang.String name)
name - Indicates the resource name of the resource entity.
true if the name exists; false otherwise.
public boolean isNameExist(java.lang.String dataSourceName,
java.lang.String name)
dataSourceName - Indicates the resource name of the data source in the catalog.name - Indicates the resource name of the resource entity.
true if the name exists; false otherwise.public boolean delete(java.lang.String handle)
delete in class APIhandle - Indicates the handle of the object to be deleted.
true if deleted successfully; false otherwise.public java.lang.String[] getDBFields(java.lang.String qryName)
qryName - Indicates the resource name of the query.
public java.lang.String[] getDBFields(java.lang.String dataSourceName,
java.lang.String qryName)
dataSourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.
public java.lang.String[] getFormulae()
public java.lang.String[] getFormulae(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String[] getSummaries()
public java.lang.String[] getSummaries(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String[] getSQLs()
public java.lang.String[] getSQLs(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String[] getSQLColumns(java.lang.String sqlname)
sqlname - Indicates the resource name of the Imported SQL query.
public java.lang.String[] getSQLColumns(java.lang.String dataSourceName,
java.lang.String sqlname)
dataSourceName - Indicates the resource name of the data source in the catalog.sqlname - Indicates the resource name of the Imported SQL query.
public java.lang.String[] getSQLColumnsMap(java.lang.String sqlname)
sqlname - Indicates the resource name of the Imported SQL query.
public java.lang.String[] getSQLColumnsMap(java.lang.String dataSourceName,
java.lang.String sqlname)
dataSourceName - Indicates the resource name of the data source in the catalog.sqlname - Indicates the resource name of the Imported SQL query.
public java.lang.String[] getUDSs()
public java.lang.String[] getUDSs(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String[] getHDSs()
public java.lang.String[] getHDSs(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String[] getUDSColumns(java.lang.String udsname)
udsname - Indicates the resource name of the UDS query.
public java.lang.String[] getUDSColumns(java.lang.String dataSourceName,
java.lang.String udsname)
dataSourceName - Indicates the resource name of the data source in the catalog.udsname - Indicates the resource name of the UDS query.
public java.lang.String[] getUDSColumnsMap(java.lang.String udsname)
udsname - Indicates the resource name of the UDS query.
public java.lang.String[] getUDSColumnsMap(java.lang.String dataSourceName,
java.lang.String udsname)
dataSourceName - Indicates the resource name of the data source in the catalog.udsname - Indicates the resource name of the UDS query.
public java.lang.String[] getProcedureNames()
public java.lang.String[] getProcedureNames(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String[] getProcColumns(java.lang.String procedureName)
procedureName - Indicates the resource name of the Stored Procedure query.
public java.lang.String[] getProcColumns(java.lang.String dataSourceName,
java.lang.String procedureName)
dataSourceName - Indicates the resource name of the data source in the catalog.procedureName - Indicates the resource name of the Stored Procedure query.
public java.lang.String[] getProcColumnsMap(java.lang.String proceName)
procedureName - Indicates the resource name of the Stored Procedure query.
public java.lang.String[] getProcColumnsMap(java.lang.String dataSourceName,
java.lang.String proceName)
dataSourceName - Indicates the resource name of the data source in the catalog.procedureName - Indicates the resource name of the Stored Procedure query.
public java.lang.String[] getParameter()
public java.lang.String[] getParameter(java.lang.String dataSourceName)
dataSourceName - Indicates the mapping name of the data source in the catalog.
public java.lang.String[] getQueries()
public java.lang.String[] getQueries(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String[] getTables()
public java.lang.String[] getTables(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String[] getTableColumns(java.lang.String tablename)
tablename - Indicates the real name of the table.
public java.lang.String[] getTableColumns(java.lang.String tablename,
boolean isMapping)
tablename - Indicates the name of the table.isMapping - Indicates whether or not to use the mapping name to identify the table.
If true, the table's name is the mapping name;
if false, it is the real name in the database.
public java.lang.String[] getTableColumns(java.lang.String dataSourceName,
java.lang.String tablename)
dataSourceName - Indicates the resource name of the data source in the catalog.tablename - Indicates the real name of the table.
public java.lang.String[] getTableColumns(java.lang.String dataSourceName,
java.lang.String tablename,
boolean isMapping)
dataSourceName - Indicates the resource name of the data source in the catalog.tablename - Indicates the name of the table.isMapping - Indicates whether or not to use the mapping name to identify the table.
If true, the table's name is the mapping name;
if false, it is the real name in the database.
public java.lang.String[] getTableColumnsMap(java.lang.String tablename)
tablename - Indicates the real name of the table.
public java.lang.String[] getTableColumnsMap(java.lang.String tablename,
boolean isMapping)
tablename - Indicates the name of the table.isMapping - Indicates whether or not to use the mapping name to identify the table.
If true, the table's name is the mapping name;
if false, it is the real name in the data source.
public java.lang.String[] getTableColumnsMap(java.lang.String dataSourceName,
java.lang.String tablename)
dataSourceName - Indicates the resource name of the data source in the catalog.tablename - Indicates the name of the table.
public java.lang.String[] getTableColumnsMap(java.lang.String dataSourceName,
java.lang.String tablename,
boolean isMapping)
dataSourceName - Indicates the resource name of the data source in the catalog.tablename - Indicates the name of the table.isMapping - Indicates whether or not to use the mapping name to identify the table.
If true, the table's name is the mapping name;
if false, it is the real name in the data source.
public java.lang.String[] getSPFields(java.lang.String dataSourceName,
java.lang.String procedureName,
boolean isMapping)
dataSourceName - Indicates the resource name of the data source in the catalog.procedureName - Indicates the name of the Stored Procedure query.isMapping - Indicates whether or not to use the mapping name to identify the stored procedure.
If true, the stored procedure's name is the mapping name;
if false, it is the real name in the database.
public java.lang.String[] getSPFieldsMap(java.lang.String dataSourceName,
java.lang.String procedureName,
boolean isMapping)
dataSourceName - Indicates the resource name of the data source in the catalog.procedureName - Indicates the name of the Stored Procedure query.isMapping - Indicates whether or not to use the mapping name to identify the stored procedure.
If true, the stored procedure's name is the mapping name;
if false, it is the real name in the database.
public java.lang.String[] getTables(boolean bIncludeSystemTable)
bIncludeSystemTable - Indicates whether or not to include the database
system tables in the return name list.
public java.lang.String[] getTables(java.lang.String dataSourceName,
boolean bIncludeSystemTable)
dataSourceName - Indicates the resource name of the data source in the catalog.bIncludeSystemTable - Indicates whether or not to include the database
system tables in the return name list.
public java.lang.String[] getTables(java.lang.String dataSourceName,
java.lang.String connectionName,
boolean bIncludeSystemTable)
dataSourceName - Indicates the resource name of the data source in the catalog.connectionName - Indicates the resource name of the connection in the specified data source.bIncludeSystemTable - Indicates whether or not to include the database
system tables in the return name list.
public QueryTableInfo getColumns(java.lang.String queryName,
boolean allColumns)
queryName - Indicates the resource name of the query.allColumns - Indicates where or not to include all columns that are defined
in the selected database tables.
public QueryTableInfo getColumns(java.lang.String dataSourceName,
java.lang.String queryName,
boolean allColumns)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.allColumns - Indicates where or not to include all columns that are defined
in the selected database tables.
public QueryTableInfo getMapColumns(java.lang.String queryName)
queryName - Indicates the resource name of the query.
public QueryTableInfo getMapColumns(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public java.lang.String[] getCompColumns(java.lang.String queryName)
queryName - Indicates the resource name of the query.
public java.lang.String[] getCompColumns(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public java.lang.String[] getCompColumnHandles(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public java.lang.String[][] getJoins(java.lang.String queryName)
getJoinInfos(String queryName)
Gets joins definition in the query.
queryName - Indicates the resource name of the query.
String[i][0] = Table "From" Name, String[i][1] = Column "From" Name, String[i][2] = Table "To" Name, String[i][3] = Column "To" Name String[i][4] = operator String[i][5] = string value of isSQL92 String[i][6] = string value of outer join type
public java.lang.String[][] getJoins(java.lang.String dataSourceName,
java.lang.String queryName)
getJoinInfos(String dataSourceName, String queryName)
Gets joins definition in the query.
dataSourceName - Indicates the resource name of data source in catalog.queryName - Indicates the resource name of the query.
String[i][0] = Table "From" Name, String[i][1] = Column "From" Name, String[i][2] = Table "To" Name, String[i][3] = Column "To" Name String[i][4] = operator String[i][5] = string value of isSQL92 String[i][6] = string value of outer join type
public JoinInfo[] getJoinInfos(java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public JoinInfo[] getJoinInfos(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public java.lang.String[][] getQBEInfo(java.lang.String queryName)
getQBEInfos(String queryName)
Gets QBE information in the query.
queryName - Indicates the resource name of the query.
String[i][0] = table Name, String[i][1] = column Name, String[i][2] = condition expression of this column.
public java.lang.String[][] getQBEInfo(java.lang.String dataSourceName,
java.lang.String queryName)
getQBEInfos(String dataSourceName, String queryName)
Gets QBE information in the query
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
String[i][0] = table Name, String[i][1] = column Name, String[i][2] = condition expression of this column.
public QBEInfo[] getQBEInfos(java.lang.String queryName)
queryName - Indicates the resource name of the query.
public QBEInfo[] getQBEInfos(java.lang.String dataSourceName,
java.lang.String queryName)
queryName - Indicates the resource name of the query.
public java.lang.String[] getSubQueries(java.lang.String queryName)
queryName - Indicates the resource name of the query.
public java.lang.String[] getSubQueries(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public java.lang.String[][] getAndConditions(java.lang.String queryName)
getAndInfos(String queryName)
queryName - Indicates the resource name of the query.
String[i][0] = "Logic", String[i][1] = "Expression1", String[i][2] = "Operator", String[i][3] = "Expression2".
public java.lang.String[][] getAndConditions(java.lang.String dataSourceName,
java.lang.String queryName)
getAndInfos(String dataSourceName, String queryName)
dataSourceName - Indicates the resource name of data source in catalog.queryName - Indicates the resource name of the query.
String[i][0] = "Logic", String[i][1] = "Expression1", String[i][2] = "Operator", String[i][3] = "Expression2".
public AndInfo[] getAndInfos(java.lang.String queryName)
queryName - Indicates the resource name of the query.
public AndInfo[] getAndInfos(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public java.lang.String[] getColumnMappingnames(java.lang.String queryName)
queryName - Indicates the resource name of the query.
public java.lang.String[] getColumnMappingnames(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public QueryTableInfo getColumnsCanBeGroupedBy(java.lang.String queryName)
queryName - Indicates the resource name of the query.
public QueryTableInfo getColumnsCanBeGroupedBy(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public java.lang.String[] getFormulaeForQuery(java.lang.String queryName)
queryName - Indicates the resource name of the query.
public java.lang.String[] getFormulaeForQuery(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public java.lang.String[] getSummariesForQuery(java.lang.String queryName)
queryName - Indicates the resource name of the query.
public java.lang.String[] getSummariesForQuery(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public java.lang.String[] getFormulaeCanBeGroupedBy(java.lang.String queryName)
queryName - Indicates the resource name of the query.
public java.lang.String[] getFormulasCanBeGroupedBy(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public java.lang.String[] getFormulaeCanBeGroupedBy(java.lang.String queryName,
java.lang.String groupBy)
queryName - Indicates the resource name of the query.groupBy - The groupBy field name.
public java.lang.String[] getFormulaeCanBeGroupedBy(java.lang.String dataSourceName,
java.lang.String queryName,
java.lang.String groupBy)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.groupBy - The groupBy field name.
public java.lang.String[] getChartFunctions(java.lang.String queryName,
java.lang.String groupBy)
queryName - Indicates the resource name of the query.groupBy - The groupBy field name.
public java.lang.String[] getChartFunctions(java.lang.String dataSourceName,
java.lang.String queryName,
java.lang.String groupBy)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.groupBy - The groupBy field name.
public java.lang.String[] getParameterCanBeGroupedBy()
public java.lang.String[] getParameterCanBeGroupedBy(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String[] getSummaryCanBeSortedBy(java.lang.String queryName,
java.lang.String groupBy)
queryName - Indicates the resource name of the query.groupBy - Indicates the mapping name of the groupBy field.
public java.lang.String[] getSummaryCanBeSortedBy(java.lang.String dataSourceName,
java.lang.String queryName,
java.lang.String groupBy)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.groupBy - Indicates the mapping name of the groupBy field.
public java.lang.String[] getMappingnames(java.lang.String DSName)
DSName - The data source object's resource name, such as Query, SQL, UDS, or Procedure.
public java.lang.String[] getMappingnames(java.lang.String dataSourceName,
java.lang.String DSName)
dataSourceName - Indicates the resource name of the data source in the catalog.DSName - The data source object's resource name, such as Query, SQL, UDS, or Procedure.
public java.lang.String mapFunction(int function)
function - the int value of function type.COUNT,
SUM,
AVERAGE,
MAXIMUM,
MINIMUM,
POPULATIONSTDDEV,
STDDEV,
VARIANCE,
DISTINCTCOUNT,
RUNNING_COUNT,
RUNNING_SUM,
RUNNING_MAXIMUM,
RUNNING_MINIMUM,
RUNNING_AVERAGE,
RUNNING_DISTINCTCOUNTpublic boolean isModified()
true if the catalog has been modified; false otherwise.public void setModified(boolean isModified)
isModified - true if the catalog has been modified; false otherwise.public java.lang.String getQuoteChar()
public java.lang.String getQuoteChar(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String getQuoteChar(java.lang.String dataSourceName,
java.lang.String connectionName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String getHandle(java.lang.String resourceName,
int type)
resourceName - Indicates the resource name of the object in the catalog.type - indicates the type of the object by constant object type value.
The CatalogAPI class provides a number of convenient constants
that you can use to specify catalog objects. For example,
CONNECTIONTABLEVIEWQUERYPROCEDUREFILESQLUDSFORMULASUMMARYPARAMETERWHEREPORTIONBUSINESSLOGIC- The businesslogic of JReport also named Business/Report Cube.BUSINESSLOGIC_CATEGORYBUSINESSLOGIC_DIMENSIONBUSINESSLOGIC_MEASUREBUSINESSLOGIC_FILTERBUSINESSLOGIC_DETAILINFOBUSINESSLOGIC_HIERARCHYBUSINESSLOGIC_HIERARCHYCONTAINER#ONDEMAND_QUER- #XML_CONNECTION
- {@link #BUSINESSVIEW_GROUP}
- {@link #BUSINESSVIEW_AGGREGATION}
- {@link #BUSINESSVIEW_DETAIL}
getHandle(String, String, int)
public java.lang.String getHandle(java.lang.String dataSourceName,
java.lang.String resourceName,
int type)
dataSourceName - Indicates the resource name of the data source to get
the object's handle. If it is null or "", it means it is the default data source
in the catalog.resourceName - Indicates the resource name of the object in the specified
data source.type - Indicates the type of the object by constant object type value.
The CatalogAPI class provides a number of convenient constants
that you can use to specify catalog objects. For example,
CONNECTIONTABLEVIEWQUERYPROCEDUREFILESQLUDSFORMULASUMMARYPARAMETERWHEREPORTIONBUSINESSLOGIC- The businesslogic of JReport also named Business/Report Cube.BUSINESSLOGIC_CATEGORYBUSINESSLOGIC_DIMENSIONBUSINESSLOGIC_MEASUREBUSINESSLOGIC_FILTERBUSINESSLOGIC_DETAILINFOBUSINESSLOGIC_HIERARCHYBUSINESSLOGIC_HIERARCHYCONTAINER#ONDEMAND_QUER- #XML_CONNECTION
- {@link #BUSINESSVIEW_GROUP}
- {@link #BUSINESSVIEW_AGGREGATION}
- {@link #BUSINESSVIEW_DETAIL}
null if there is no matching object, otherwise returns a String specifying
the handle of the object.public java.lang.String[] getFunctions(java.lang.String resourceName)
resourceName - Indicates field mapping name.
public java.lang.String[] getFunctions(java.lang.String dataSourceName,
java.lang.String resourceName)
dataSourceName - Indicates the mapping name of the data source. If it is
null or "", it means it is the default data source in the catalog.resourceName - Indicates field resource name.
public java.lang.String[] getFunctions(int iType)
iType - Int value of SQL type.
public void rename(java.lang.String resourceName,
java.lang.String newName,
int type)
resourceName - Resource name(mapping name) of the object.newName - New resource name of the object.type - Indicates the type of the object by constant object type value.
The CatalogAPI class provides a number of convenient constants
that you can use to specify catalog objects. For example,
CONNECTIONTABLEVIEWQUERYPROCEDUREFILESQLUDSFORMULASUMMARYPARAMETERWHEREPORTIONBUSINESSLOGIC- The businesslogic of JReport also named Business/Report Cube.BUSINESSLOGIC_CATEGORYBUSINESSLOGIC_DIMENSIONBUSINESSLOGIC_MEASUREBUSINESSLOGIC_FILTERBUSINESSLOGIC_DETAILINFOBUSINESSLOGIC_HIERARCHYBUSINESSLOGIC_HIERARCHYCONTAINER#ONDEMAND_QUER- #XML_CONNECTION
- {@link #BUSINESSVIEW_GROUP}
- {@link #BUSINESSVIEW_AGGREGATION}
- {@link #BUSINESSVIEW_DETAIL}
public void rename(java.lang.String dataSourceName,
java.lang.String resourceName,
java.lang.String newName,
int type)
dataSourceName - Indicates the resource name of the data source in the catalog.resourceName - Resource name(mapping name) of the object.newName - New resource name of the object.type - Indicates the type of the object by constant object type value.
The CatalogAPI class provides a number of convenient constants
that you can use to specify catalog objects. For example,
CONNECTIONTABLEVIEWQUERYPROCEDUREFILESQLUDSFORMULASUMMARYPARAMETERWHEREPORTIONBUSINESSLOGIC- The businesslogic of JReport also named Business/Report Cube.BUSINESSLOGIC_CATEGORYBUSINESSLOGIC_DIMENSIONBUSINESSLOGIC_MEASUREBUSINESSLOGIC_FILTERBUSINESSLOGIC_DETAILINFOBUSINESSLOGIC_HIERARCHYBUSINESSLOGIC_HIERARCHYCONTAINER#ONDEMAND_QUER- #XML_CONNECTION
- {@link #BUSINESSVIEW_GROUP}
- {@link #BUSINESSVIEW_AGGREGATION}
- {@link #BUSINESSVIEW_DETAIL}
public ObjectInfo getObjectInfo(java.lang.String resourceName,
int type)
resourceName - resource name of the entity.type - Indicates the type of the object by constant object type value.
The CatalogAPI class provides a number of convenient constants
that you can use to specify catalog objects. For example,
CONNECTIONTABLEVIEWQUERYPROCEDUREFILESQLUDSFORMULASUMMARYPARAMETERWHEREPORTIONBUSINESSLOGIC- The businesslogic of JReport also named Business/Report Cube.BUSINESSLOGIC_CATEGORYBUSINESSLOGIC_DIMENSIONBUSINESSLOGIC_MEASUREBUSINESSLOGIC_FILTERBUSINESSLOGIC_DETAILINFOBUSINESSLOGIC_HIERARCHYBUSINESSLOGIC_HIERARCHYCONTAINER#ONDEMAND_QUER- #XML_CONNECTION
- {@link #BUSINESSVIEW_GROUP}
- {@link #BUSINESSVIEW_AGGREGATION}
- {@link #BUSINESSVIEW_DETAIL}
public ObjectInfo getObjectInfo(java.lang.String dataSourceName,
java.lang.String resourceName,
int type)
dataSourceName - Indicates the resource name of the data source in the catalog.resourceName - resource name of the entity.type - Indicates the type of the object by constant object type value.
The CatalogAPI class provides a number of convenient constants
that you can use to specify catalog objects. For example,
CONNECTIONTABLEVIEWQUERYPROCEDUREFILESQLUDSFORMULASUMMARYPARAMETERWHEREPORTIONBUSINESSLOGIC- The businesslogic of JReport also named Business/Report Cube.BUSINESSLOGIC_CATEGORYBUSINESSLOGIC_DIMENSIONBUSINESSLOGIC_MEASUREBUSINESSLOGIC_FILTERBUSINESSLOGIC_DETAILINFOBUSINESSLOGIC_HIERARCHYBUSINESSLOGIC_HIERARCHYCONTAINER#ONDEMAND_QUER- #XML_CONNECTION
- {@link #BUSINESSVIEW_GROUP}
- {@link #BUSINESSVIEW_AGGREGATION}
- {@link #BUSINESSVIEW_DETAIL}
public ObjectInfo getObjectInfo(java.lang.String handle)
handle - The handle of the resource entity.
public int getSQLType(java.lang.String query,
java.lang.String colName)
qryName - Indicates the resource name of the query.columnName - Indicates the mapping name of the computed column.
public int getSQLType(java.lang.String sourceName,
java.lang.String query,
java.lang.String colName)
sourceName - Indicates the resource name of the data source in the catalog.qryName - Indicates the resource name of the query.columnName - Indicates the mapping name of the computed column.
public java.lang.String getSQLString(java.lang.String queryName)
queryName - Indicates the resource name of the query.
public java.lang.String getSQLString(java.lang.String dataSourceName,
java.lang.String queryName)
dataSourceName - Indicates the resource name of the data source in the catalog.queryName - Indicates the resource name of the query.
public java.lang.String[] getDataSources()
public java.lang.String getBLNodeQualifyName(java.lang.String handle)
handle - The handle of the Business Logic object.
public java.lang.String[] getBLCategoryHandles(java.lang.String handle)
handle - The handle of the Business Logic object.
public java.lang.String[] getBusinesViewCategoryHandles(java.lang.String handle)
handle - The handle of the Business View object.
public java.lang.String[] getBLHierarchyHandles(java.lang.String handle)
handle - Handle of the Business Logic.
public java.lang.String[] getBLDetailHandles(java.lang.String handle)
handle - The handle of the Business Logic object.
public java.lang.String[] getBusinessViewDetailHandles(java.lang.String handle)
handle - Business View node handle.
public java.lang.String[] getBLDimensionHandles(java.lang.String handle)
handle - The handle of the Business Logic object.
public java.lang.String[] getBusinessViewGroupHandles(java.lang.String handle)
handle - The handle of the Business View object.
public java.lang.String[] getBLMeasureHandles(java.lang.String handle)
handle - The handle of the Business Logic object.
public java.lang.String[] getBusinessViewAggregationHandles(java.lang.String handle)
handle - The handle of the Business View object.
public java.lang.String[] getBLViewHandles(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String[] getBusinessViewHandles(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String[] getBLViewHandles(java.lang.String dataSourceName,
int queryType)
dataSourceName - Indicates the resource name of the data source in the catalog.queryType - Indicates the int value of the query type. The query type is:
public java.lang.String[] getBusinessViewHandles(java.lang.String dataSourceName,
int queryType)
dataSourceName - Indicates the resource name of the data source in the catalog.queryType - Indicates the int value of the query type. The query type is:
public java.lang.String[] getBLViewNames(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String[] getBusinessViewNames(java.lang.String dataSourceName)
dataSourceName - Indicates the resource name of the data source in the catalog.
public java.lang.String[] getBLViewNames(java.lang.String dataSourceName,
int queryType)
dataSourceName - Indicates the resource name of the data source in the catalog.queryType - Indicates the int value of the query type. The query type is:
public java.lang.String[] getBusinessViewNames(java.lang.String dataSourceName,
int queryType)
dataSourceName - Indicates the resource name of the data source in the catalog.queryType - Indicates the int value of the query type. The query type is:
public java.lang.String[] getBusinessNodeNames(java.lang.String dataSourceName,
java.lang.String businessViewName)
dataSourceName - Indicates the resource name of the data source in the catalog.businessViewName - Indicates the Business Logic's qualified name.
public java.lang.String insertBusinessView(java.lang.String dataSourceName,
java.lang.String queriableName,
java.lang.String businessViewName)
Business cube or Report cube.
A business cube is based on tables and views, while a report cube is based on a query, stored procedure, imported SQL file, or user defined data source.
In this method, if queriableName is a valid name of an existing queriable object, it will create a report cube; if it is null or does not exist,
a business cube will be created automatically.
dataSourceName - Indicates the resource name of the data source in the catalog.queriableName - The queriable object's resource name.
The queriable object in JReport catalog could be a Query, UDS, Stored Procedure or Imported SQL.businessViewName - The new Business Logic name.
public java.lang.String insertBusinessView(java.lang.String dataSourceName,
java.lang.String queriableName,
java.lang.String businessViewName,
boolean isLogicView)
Business cube or Report cube.
A business cube is based on tables and views, while a report cube is based on a query, stored procedure, imported SQL file, or user defined data source.
In this method, if queriableName is a valid name of existing queriable object, it will create a report cube; if it is null or does not exist,
a business cube will be created automatically.
Business views are used as data sources for web reports and library components.
A Business View provides report users with a business-oriented view of
their data and formulas in a query based data source. It contains database
connections and relationships between view elements that are required for
creating web reports and library components.
Business views resemble report cubes except that there is no hierarchical
relationship between the data objects in Business Views.
dataSourceName - Indicates the resource name of the data source in the catalog.queriableName - Queriable object name.businessViewName - New Business View name.isLogicView - Indicates whether to insert a Business Logic or a Business View.
If it is true, a Business Logic will be created, otherwise, a Business View will be created.
public java.lang.String insertBLCategory(java.lang.String parentHandle,
BLCategoryInfo info)
throws DesignerErrorException
Business cube or Report cube.
Categories are the main tools for organizing data. They are components which correspond to particular collections of data in the data source. They are grouped in folders that are named to reflect information collections. A category can contain several subcategories.
Organizing data required by a user into multiple categories or multiple levels of categories is meaningful, and makes it easy to use. End users can use categories to find data elements they need to use without knowing the underlying table names although sometimes the table names are used as categories.
parentHandle - Handle of parent object.info - The definition class of Category information. The info can contain its children's
definition information.
DesignerErrorException
public java.lang.String insertBusinessViewCategory(java.lang.String parentHandle,
BLCategoryInfo info)
throws DesignerErrorException
Categories are the main tools for organizing data. They are components which correspond to particular collections of data in the data source. They are grouped in folders that are named to reflect information collections. A category can contain several subcategories.
Organizing data required by a user into multiple categories or multiple levels of categories is meaningful, and makes it easy to use. End users can use categories to find data elements they need to use without knowing the underlying table names although sometimes the table names are used as categories.
parentHandle - Handle of the parent object.info - The definition class of Category information. The info can contain its children's
definition information.
DesignerErrorExceptioninsertBusinessViewCategory(String parentHandle, BusinessViewCategoryInfo info)
public java.lang.String insertBusinessViewCategory(java.lang.String parentHandle,
BusinessViewCategoryInfo info)
throws DesignerErrorException
Categories are the main tools for organizing data. They are components which correspond to particular collections of data in the data source. They are grouped in folders that are named to reflect information collections. A category can contain several subcategories.
Organizing data required by a user into multiple categories or multiple levels of categories is meaningful, and makes it easy to use. End users can use categories to find data elements they need to use without knowing the underlying table names although sometimes the table names are used as categories.
parentHandle - The handle of the parent container object. The parent should be a
Category, or a Business View root object.info - The definition class of Category information. The info can contain its children's
definition information.
DesignerErrorException
public java.lang.String insertBLDetail(java.lang.String parentHandle,
BLDetailInfo info)
throws DesignerErrorException
parentHandle - The handle of the parent container object. The parent should be a
Category, Dimension, or a Measureinfo - The definition class of the detail information.
DesignerErrorException
public java.lang.String insertBusinessViewDetail(java.lang.String parentHandle,
BVDetailInfo info)
throws DesignerErrorException
parentHandle - The handle of the parent container object. The parent should be a
Category, Group, or a Aggregationinfo - The definition class of the detail information.
DesignerErrorException
public java.lang.String insertBLMeasure(java.lang.String parentHandle,
BLMeasureInfo info)
throws DesignerErrorException
parentHandle - Handle of the parent object.info - The definition class of the measure object.
DesignerErrorException
public java.lang.String insertBusinessViewAggregation(java.lang.String parentHandle,
BVAggregationInfo info)
throws DesignerErrorException
parentHandle - Handle of the parent object.info - The definition class of the Aggregation.
DesignerErrorException
public java.lang.String insertBLDimension(java.lang.String parentHandle,
BLDimensionInfo info)
throws DesignerErrorException
parentHandle - Handle of the parent object.info - The definition class of the Dimension object.
DesignerErrorException
public java.lang.String insertBusinessViewGroup(java.lang.String parentHandle,
BVGroupInfo info)
throws DesignerErrorException
parentHandle - Handle of the parent object.info - The definition class of the Group object.
DesignerErrorException
public java.lang.String insertBLHierarchy(java.lang.String blViewHandle,
BLHierarchyInfo info)
throws DesignerErrorException
blViewHandle - Handle of the business logic view.info - The definition class of the Hierarchy object.
DesignerErrorExceptionpublic boolean updateUDS(java.lang.String userDataSourceName)
userDataSourceName - Indicates User Data Source's resource name.
true if the UDS is updated successfully; false otherwise.
public boolean updateUDS(java.lang.String dataSourceName,
java.lang.String userDataSourceName)
dataSourceName - Specifies the Data Source Name.userDataSourceName - Specifies the User Data Source Name.
public boolean refreshReference()
CrossReferenceConfigure.
true if the CrossReference is created or refreshed successfully;false otherwise.public boolean setDefaultDataSource(java.lang.String datasourceName)
true if the data source is set as default successfully;false otherwise.
public void setDefaultConnection(java.lang.String datasourceName,
java.lang.String connectionName)
default in the specified datasource.
public java.lang.String getDefaultConnectionName(java.lang.String datasourceName)
null if there is no default connection or causeby the invalid data source name.public java.lang.String getDefaultDataSourceName()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||