Getting objects in a catalog

Getting tables

• getTables(String dataSourceName)
  Gets tables and views in a connection and returns the mapping name array.
• getTables(boolean bIncludeSystemTable)
  Gets tables and views in a data source and returns the name array.

Getting stored procedures

• getProcedureNames(String dataSourceName)
  Gets all the stored procedures in a catalog and to return the mapping name array.

Getting SQLs

• getSQLs(String dataSourceName)
  Gets all the SQL files in a catalog and to return the mapping name array.

Getting UDSs

• getUDSs(String dataSourceName)
  Gets all the UDSs in a catalog and to return the mapping name array.

Getting queries

• getQueries(String dataSourceName)
  Gets queries in a catalog and returns the mapping name array.
• getNewQueryName()
  Gets a default name for a new query, which must be unique. The name for the first query in a catalog is query1. The following query is query2, then query3 etc.

Getting columns

• getColumns(String dataSourceName, String queryName, boolean allColumns)
  Gets columns in a query and returns the table name and column real names.
• getColumnMappingnames(String dataSourceName, String queryName)
  Gets column mapping names in a query and returns the table name and column mapping names.
• getColumnsCanBeGroupedBy(String dataSourceName, String queryName)
  Gets the columns which can be grouped by in a query.

Parameters

• queryName - The query name.
• allColumns - Selects all columns in the specified tables.

Getting fields

• getDBFields(String dataSourceName, String qryName)
  Gets DBFields that can be used in a query and returns the mapping name array.
• getMappingnames(String dataSourceName, String DSName)
  Gets the field mapping names in a data source and returns the table name and column mapping names.

Parameters

• qryName - The query name.
• DSName - The data source object name, such as Query, SQL, UDS, and Procedure.

Getting formulas, summaries or parameters

• getFormulae(String dataSourceName)
  Gets formulae that can be used in a catalog and returns the mapping name array.
• getFormulaeCanBeGroupedBy(String dataSourceName, String queryName, String groupBy)
  Gets formulae that are valid to a query and returns the formula names.
• getSummaries(String dataSourceName)
  Gets summaries that can be used in a catalog and returns the mapping name array.
• getSummaryCanBeSortedBy(String dataSourceName, String queryName, String groupBy)
  Gets summaries that can be sorted by.
• getParameter(String dataSourceName)
  Gets parameters in a catalog and returns the mapping name array.
• getParameterCanBeGroupedBy(String dataSourceName)
  Gets parameters that can be grouped by.

Parameters

• queryName - The query name.
• dataSourceName - The datasoure name.
• groupBy - The groupBy field.

Getting joins

• getJoins(String dataSourceName, String queryName)
  Gets joins in a query and returns the join info array.

  Note: String[i][0] = Table "From" Name, String[i][1] = Column "From" Name, String[i][2] = Table "To" Name, String[i][3] = Column "To" Name

Parameter

• queryName - The query name.

Getting AND or QBE condition

• getAndConditions(String dataSourceName, String queryName)
  Gets AND conditions in a query and returns a condition info array.

  Note: String[i][0] = "Logic", String[i][1] = "Expression1" String[i][2] = "Operator", String[i][3] = "Expression2"

• getQBEInfo(String dataSourceName, String queryName)
  Gets the QBE condition in a query and returns a QBE info array.

  Note: String[i][0] = column Name, String[i][j](j>=1) = condition expression of this column.

Parameter

• queryName - The query name.

Getting report names

• getNewReportName()
  Gets a default name for a new report, which must be unique. The name for the first report in a catalog is report1, after which the following reports will be named report2, report3 etc.