org.odpi.openmetadata.accessservices.informationview.reports

Class BasicOperation

java.lang.Object

org.odpi.openmetadata.accessservices.informationview.reports.BasicOperation

Direct Known Subclasses:

DataViewBasicOperation, ReportBasicOperation

public abstract class BasicOperation
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected OMRSAuditLog	auditLog
protected EntityReferenceResolver	entityReferenceResolver
protected OMRSRepositoryHelper	helper
protected OMEntityDao	omEntityDao
static String	SEPARATOR

Constructor Summary

Constructors

Constructor and Description
BasicOperation(OMEntityDao omEntityDao, LookupHelper lookupHelper, OMRSRepositoryHelper helper, OMRSAuditLog auditLog)

Method Summary

Modifier and Type	Method and Description
protected EntityDetail	addAssetSchemaType(String userId, String assetGuid, String qualifiedNameForComplexSchemaType, String registrationGuid, String registrationQualifiedName, String schemaTypeName, InstanceProperties complexSchemaTypeProperties)
protected void	addBusinessTerm(String userId, String registrationGuid, String registrationQualifiedName, String referenceableEntityGuid, String businessTermGuid)
protected void	addQueryTarget(String userId, String registrationGuid, String registrationQualifiedName, String derivedColumnEntityGuid, String sourceColumnGuid, String queryValue)
void	addQueryTargets(String userId, String registrationGuid, String registrationQualifiedName, List<Source> sources, EntityDetail derivedColumnEntity)
protected EntityDetail	addSchemaType(String userId, String qualifiedNameForType, String registrationGuid, String registrationQualifiedName, String schemaAttributeGuid, String schemaAttributeType, InstanceProperties properties)
void	addSemanticAssignment(String userId, String registrationGuid, String registrationQualifiedName, BusinessTerm bt, EntityDetail derivedColumnEntity)
void	addSemanticAssignments(String userId, String registrationGuid, String registrationQualifiedName, List<BusinessTerm> businessTerms, EntityDetail derivedColumnEntity) Create relationships of type SEMANTIC_ASSIGNMENT between the business terms and the entity representing the column
protected String	buildQualifiedNameForSchemaType(String qualifiedNameForParent, String schemaType, ReportElement element)
protected void	createOrUpdateSchemaQueryImplementation(List<Source> sources, String columnGuid)
protected Relationship	createOrUpdateSemanticAssignment(String userId, String registrationGuid, String registrationQualifiedName, String columnGuid, BusinessTerm businessTerm, List<Relationship> existingAssignments)
protected void	createOrUpdateSemanticAssignments(String userId, String registrationGuid, String registrationQualifiedName, List<BusinessTerm> businessTerms, String columnGuid)
protected EntityDetail	createSchemaType(String userId, String schemaAttributeTypeName, String qualifiedNameForSchemaType, String registrationGuid, String registrationQualifiedName, InstanceProperties schemaAttributeTypeProperties, String schemaTypeRelationshipName, String schemaAttributeGuid)
SoftwareServerCapabilitySource	retrieveSoftwareServerCapability(String registrationGuid, String registrationQualifiedName)

Methods inherited from class java.lang.Object

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

Field Detail

omEntityDao

protected final OMEntityDao omEntityDao

auditLog

protected final OMRSAuditLog auditLog

helper

protected final OMRSRepositoryHelper helper

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

entityReferenceResolver

protected final EntityReferenceResolver entityReferenceResolver

Constructor Detail

BasicOperation

public BasicOperation(OMEntityDao omEntityDao,
                      LookupHelper lookupHelper,
                      OMRSRepositoryHelper helper,
                      OMRSAuditLog auditLog)

Method Detail

retrieveSoftwareServerCapability

public SoftwareServerCapabilitySource retrieveSoftwareServerCapability(String registrationGuid,
                                                                       String registrationQualifiedName)

Parameters:

registrationGuid - guid of the softwareServerCapability

registrationQualifiedName - qualifiedName of the softwareServerCapability

Returns:

entity of type SoftwareServerCapability retrieved by provided identifiers

createSchemaType

protected EntityDetail createSchemaType(String userId,
                                        String schemaAttributeTypeName,
                                        String qualifiedNameForSchemaType,
                                        String registrationGuid,
                                        String registrationQualifiedName,
                                        InstanceProperties schemaAttributeTypeProperties,
                                        String schemaTypeRelationshipName,
                                        String schemaAttributeGuid)

Parameters:

userId - id of user submitting the request

schemaAttributeTypeName - - type name for the actual schema type entity to be created

qualifiedNameForSchemaType - - qualifiedName for schema type entity

registrationGuid - - guid of softwareServerCapability

registrationQualifiedName - - qualified name of software server capability

schemaAttributeTypeProperties - - instance properties for schema attribute

schemaTypeRelationshipName - - type name for the actual schema type entity to be created

schemaAttributeGuid - - guid of the schema attribute for which the schema type was created

Returns:

entity representing schema type

addBusinessTerm

protected void addBusinessTerm(String userId,
                               String registrationGuid,
                               String registrationQualifiedName,
                               String referenceableEntityGuid,
                               String businessTermGuid)

Parameters:

userId - id of user submitting the request

registrationGuid - - guid of software server capability

registrationQualifiedName - - qualified name of software server capability

referenceableEntityGuid - guid of the entity representing the derived column

businessTermGuid - guid of businessTerm

addQueryTarget

protected void addQueryTarget(String userId,
                              String registrationGuid,
                              String registrationQualifiedName,
                              String derivedColumnEntityGuid,
                              String sourceColumnGuid,
                              String queryValue)

Parameters:

userId - id of user submitting the request

registrationGuid - - guid of software server capability

registrationQualifiedName - - qualified name of software server capability

derivedColumnEntityGuid - the guid of the entity representing the derived column

sourceColumnGuid - identifier of the source column entity

queryValue -

addSchemaType

protected EntityDetail addSchemaType(String userId,
                                     String qualifiedNameForType,
                                     String registrationGuid,
                                     String registrationQualifiedName,
                                     String schemaAttributeGuid,
                                     String schemaAttributeType,
                                     InstanceProperties properties)

Parameters:

userId - - id of user submitting the request

qualifiedNameForType - - qualified name of the schema attribute

registrationGuid - - guid of software server capability

registrationQualifiedName - - qualified name of software server capability

schemaAttributeGuid - schema attribute entity guid

schemaAttributeType - schema attribute type entity

properties - properties for the type entity

Returns:

entity describing the schema type

addAssetSchemaType

protected EntityDetail addAssetSchemaType(String userId,
                                          String assetGuid,
                                          String qualifiedNameForComplexSchemaType,
                                          String registrationGuid,
                                          String registrationQualifiedName,
                                          String schemaTypeName,
                                          InstanceProperties complexSchemaTypeProperties)

Parameters:

userId - id of user submitting the request - userId of the user submitting the request

assetGuid - - guid of the entity describing the asset

qualifiedNameForComplexSchemaType - qualified name for complex schema type

registrationGuid - - guid of softwareServerCapability

registrationQualifiedName - - qualified name of software server capability

schemaTypeName - - name os schema type

complexSchemaTypeProperties - properties of the complex schema type

Returns:

entity describing the asset schema type

addSemanticAssignments

public void addSemanticAssignments(String userId,
                                   String registrationGuid,
                                   String registrationQualifiedName,
                                   List<BusinessTerm> businessTerms,
                                   EntityDetail derivedColumnEntity)

Create relationships of type SEMANTIC_ASSIGNMENT between the business terms and the entity representing the column

Parameters:

userId - - id of user submitting the request

registrationGuid - - guid of software server capability

registrationQualifiedName - - qualified name of software server capability

businessTerms - - list of business terms

derivedColumnEntity - - entity describing the derived column

addSemanticAssignment

public void addSemanticAssignment(String userId,
                                  String registrationGuid,
                                  String registrationQualifiedName,
                                  BusinessTerm bt,
                                  EntityDetail derivedColumnEntity)

Parameters:

userId - - id of user submitting the request

registrationGuid - - guid of software server capability

registrationQualifiedName - - qualified name of software server capability

bt - - business term to link to derived column

derivedColumnEntity - - entity describing the column

addQueryTargets

public void addQueryTargets(String userId,
                            String registrationGuid,
                            String registrationQualifiedName,
                            List<Source> sources,
                            EntityDetail derivedColumnEntity)

Parameters:

userId - id of user submitting the request

registrationGuid - - guid of software server capability

registrationQualifiedName - - qualified name of software server capability

sources - list of sources describing the report column

derivedColumnEntity - entity describing the derived column

createOrUpdateSemanticAssignment

protected Relationship createOrUpdateSemanticAssignment(String userId,
                                                        String registrationGuid,
                                                        String registrationQualifiedName,
                                                        String columnGuid,
                                                        BusinessTerm businessTerm,
                                                        List<Relationship> existingAssignments)

Parameters:

userId - - id of user submitting the request

registrationGuid - - guid of software server capability

registrationQualifiedName - - qualified name of software server capability

columnGuid - guid of the column

businessTerm - business term to link or update to column

existingAssignments - list of existing relationships of type semantic assignment

buildQualifiedNameForSchemaType

protected String buildQualifiedNameForSchemaType(String qualifiedNameForParent,
                                                 String schemaType,
                                                 ReportElement element)

createOrUpdateSchemaQueryImplementation

protected void createOrUpdateSchemaQueryImplementation(List<Source> sources,
                                                       String columnGuid)

Parameters:

sources - list of sources to be linked to column

columnGuid - guid of column

createOrUpdateSemanticAssignments

protected void createOrUpdateSemanticAssignments(String userId,
                                                 String registrationGuid,
                                                 String registrationQualifiedName,
                                                 List<BusinessTerm> businessTerms,
                                                 String columnGuid)

Parameters:

userId - - id of user submitting the request

registrationGuid - - guid of software server capability

registrationQualifiedName - - qualified name of software server capability

businessTerms - list of business terms to link to column

columnGuid - guid of column