org.odpi.egeria.connectors.ibm.ia.clientlibrary

Class IARestClient

java.lang.Object

org.odpi.egeria.connectors.ibm.ia.clientlibrary.IARestClient

public class IARestClient
extends Object

Library of methods to connect to and interact with an IBM Information Analyzer environment using appropriate session management.

Methods are provided to interact with REST API endpoints and process results as through the use of registered POJOs to automatically (de-)serialise between the XML form and a native Java object.

Constructor Summary

Constructors

Constructor and Description
IARestClient(String host, String port, String user, String password) Default constructor used by the IARestClient.

Method Summary

Modifier and Type	Method and Description
void	disconnect() Disconnect from IGC REST API and invalidate the session.
Map<String,ColumnAnalysisResults>	getColumnAnalysisResultsForTable(String projectName, String tableName) Retrieve the column analysis results for a table as a Map, keyed by the name of the column.
List<String>	getColumnsInProject(Project details) Retrieve a list of all the (qualified) names of columns within the specified project.
Map<String,List<DataQualityProblem>>	getDataQualityAnalysisResultsForTable(String projectName, String tableName) Retrieve the data quality analysis results for a table as a Map, keyed by the name of the column.
Project	getFormatDistribution(String projectName, String columnName) Retrieve the column analysis results for the specified IA project and column.
Project	getFrequencyDistribution(String projectName, String columnName) Retrieve the frequency distribution of values for the specified IA project and column.
Project	getProjectDetails(String projectName) Retrieve the project details for the specified IA project.
List<Project>	getProjectList() Retrieve the list of projects defined in the IA environment.
Map<String,Date>	getPublishedResults(String projectName) Retrieve information on results that have been published for the specified IA project.
List<String>	getTablesInProject(Project details) Retrieve a list of all the (qualified) names of tables within the specified project.
TaskExecutionSchedule	getTaskStatus(String scheduleId) Retrieve the status of a task from its scheduled ID.
List<TaskExecutionSchedule>	getTaskStatus(TaskExecutionReport taskExecutionReport) Retrieve the status of each task within a running request.
void	publishResults(String projectName, String tableName) Publish analysis results from the specified project's specified table.
TaskExecutionReport	runColumnAnalysis(String projectName, String columnName) Run a column analysis within the specified project, against the specified column(s).
TaskExecutionReport	runDataQualityAnalysis(String projectName, String tableName) Run a data quality analysis within the specified project, against the specified table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IARestClient

public IARestClient(String host,
                    String port,
                    String user,
                    String password)

Default constructor used by the IARestClient.

Creates a new session on the server and retains the cookies to re-use the same session for the life of the client (or until the session times out); whichever occurs first.

Parameters:

host - the services (domain) tier host

port - the services (domain) tier port number

user - the username with which to open and retain the session

password - the password for the user

Method Detail

disconnect

public void disconnect()

Disconnect from IGC REST API and invalidate the session.

getProjectList

public List<Project> getProjectList()

Retrieve the list of projects defined in the IA environment.

Returns:

List<Project>

getProjectDetails

public Project getProjectDetails(String projectName)

Retrieve the project details for the specified IA project.

Parameters:

projectName - the name of the IA project for which to retrieve details

Returns:

Project - containing only the details of the project definition

getTablesInProject

public List<String> getTablesInProject(Project details)

Retrieve a list of all the (qualified) names of tables within the specified project.

Parameters:

details - the project details as retrieved from getProjectDetails

Returns:

List<String>

See Also:

getProjectDetails(String)

getColumnsInProject

public List<String> getColumnsInProject(Project details)

Retrieve a list of all the (qualified) names of columns within the specified project.

Parameters:

details - the project details as retrieved from getProjectDetails

Returns:

List<String>

See Also:

getProjectDetails(String)

getColumnAnalysisResultsForTable

public Map<String,ColumnAnalysisResults> getColumnAnalysisResultsForTable(String projectName,
                                                                          String tableName)

Retrieve the column analysis results for a table as a Map, keyed by the name of the column.

Parameters:

projectName - the name of the project from which to retrieve results

tableName - the name of the table for which to retrieve results

Returns:

Map<String, ColumnAnalysisResults> - a map from column name to analysis results

getDataQualityAnalysisResultsForTable

public Map<String,List<DataQualityProblem>> getDataQualityAnalysisResultsForTable(String projectName,
                                                                                  String tableName)

Retrieve the data quality analysis results for a table as a Map, keyed by the name of the column.

Parameters:

projectName - the name of the project from which to retrieve results

tableName - the name of the table for which to retrieve results

Returns:

Map<String, List<DataQualityProblem>> - a map from column name to analysis results

getFormatDistribution

public Project getFormatDistribution(String projectName,
                                     String columnName)

Retrieve the column analysis results for the specified IA project and column.

Parameters:

projectName - the name of the IA project for which to retrieve format distribution results

columnName - the qualified name of the column for which to retrieve analysis results

Returns:

Project - containing only the format distribution results details

getFrequencyDistribution

public Project getFrequencyDistribution(String projectName,
                                        String columnName)

Retrieve the frequency distribution of values for the specified IA project and column.

Parameters:

projectName - the name of the IA project for which to retrieve format distribution results

columnName - the qualified name of the column for which to retrieve analysis results

Returns:

Project - containing only the format distribution results details

getPublishedResults

public Map<String,Date> getPublishedResults(String projectName)

Retrieve information on results that have been published for the specified IA project.

Parameters:

projectName - the name of the IA project for which to retrieve the published results

Returns:

Map<String, Date> - a map from table name to last publication date, empty if nothing published

runColumnAnalysis

public TaskExecutionReport runColumnAnalysis(String projectName,
                                             String columnName)

Run a column analysis within the specified project, against the specified column(s). The name of the column should be fully-qualified (database.schema.table.column), and multiple columns can be specified by using a '*' for example: database.schema.table.* for all columns in a table.

Parameters:

projectName - the name of the project in which to run the column analysis

columnName - the fully-qualified name of the column(s) to run analysis against

Returns:

TaskExecutionReport containing the scheduled task ID or any errors

runDataQualityAnalysis

public TaskExecutionReport runDataQualityAnalysis(String projectName,
                                                  String tableName)

Run a data quality analysis within the specified project, against the specified table. The name of the table should be fully-qualified (database.schema.table).

Parameters:

projectName - the name of the project in which to run the data quality analysis

tableName - the fully-qualified name of the table to run analysis against

Returns:

TaskExecutionReport containing the scheduled task ID or any errors

publishResults

public void publishResults(String projectName,
                           String tableName)

Publish analysis results from the specified project's specified table.

Parameters:

projectName - the name of the project from which to publish analysis results

tableName - the fully-qualified name of the table for which to publish results

getTaskStatus

public List<TaskExecutionSchedule> getTaskStatus(TaskExecutionReport taskExecutionReport)

Retrieve the status of each task within a running request.

Parameters:

taskExecutionReport - the response of a running request containing task information

Returns:

List<TaskExecutionSchedule>

getTaskStatus

public TaskExecutionSchedule getTaskStatus(String scheduleId)

Retrieve the status of a task from its scheduled ID.

Parameters:

scheduleId - the scheduleId of the task for which to retrieve the status

Returns:

TaskExecutionSchedule