Java API for Designing Dataset Relationship

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

Overview

1. Create a DRD Object.

2. Create the layout object by passing the dataset name and add this layout object to the DRD.

3. Create the relation object and add Join to it.

4. Save the DRD object in the repository.

5. Delete dataset from DRD.

6. Retrieve existing DRD object from repository by name.

7. Update existing DRD object in repository.

Example

1. Create the DRD Object.

   /*  * method to create new Dataset Relationship object in Repository Manager.  * @param requestorUserInfo: Object of type UserInfo.  * @return DRDObject: Object of type DRDObject. */ public DRDObject createDRDObject(UserInfo requestorUserInfo);

2. Create the DRDDataSetLayout.

   /** * method to add dataset in DatasetRelationship. * @param doName: Name of Dataset/Registered File to be added. */ public void addDRDDataSetLayout(String doName); /** * method to add dataset inside folder to DatasetRelationship. * @param doName: Name of Dataset/Registered File to be added. * @param folderName: Name of the folder that contains dataset/register file. */ public void addDRDDataSetLayout(String doName, String folderName);

3. Add the DRDRelation between two dataset fields.

   /*  * method to set relation between dataset fields in DatasetRelationship.  * @param srcDSName: Name of source dataset to be added.  * @param srcDSName: Name of destination dataset to be added.  * @param srcFieldName: Name of source field.  * @param destFieldName: Name of destination field.  * @return drdRelation: Object of type DRDRelation. */ public DRDRelation addDrdRelation(String srcDSName, String destDSName, String srcFieldName, String destFieldName);

4. Save the DRD Object in the repository.

5. API to delete dataset used in DRD.

6. API to retrieve existing DRD object from repository by name.

7. API to update existing DRD object in repository.

8. Set all the internal objects of the DRD.

9. Set the view type of a DRD.

10.  Add node in the DRD. 

11. Get the DRD join by a list

Sample code