org.odpi.openmetadata.commonservices.generichandlers.DisplayDataContainerHandler<SCHEMA_ATTRIBUTE,SCHEMA_TYPE>

public class DisplayDataContainerHandler<SCHEMA_ATTRIBUTE,SCHEMA_TYPE> extends ReferenceableHandler<B>

DisplayDataContainerHandler manages the schemas for display data containers. It is build on the SchemaAttributeHandler. Its role is to maintain a simple interface. It automatically creates and links in the schema type information in the structure and keeps it linked together.

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
OpenMetadataAPIGenericHandler.AnchorIdentifiers
Field Summary

Fields

Modifier and Type

Field

Description

protected final RepositoryErrorHandler

errorHandler

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler
assetActionDescription, auditLog, beanClass, converter, defaultZones, localServerUserId, publishZones, qualifiedNamePropertyNamesList, repositoryHandler, securityVerifier, supportedZones
Constructor Summary

Constructors

Constructor

Description

DisplayDataContainerHandler(OpenMetadataAPIGenericConverter<SCHEMA_ATTRIBUTE> dataContainerConverter, Class<SCHEMA_ATTRIBUTE> dataContainerClass, OpenMetadataAPIGenericConverter<SCHEMA_TYPE> schemaTypeConverter, Class<SCHEMA_TYPE> schemaTypeClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)

Construct the relational data handler with information needed to work with assets and schemas.
Method Summary

Modifier and Type

Method

Description

void

clearQueryTargetRelationship(String userId, String externalSourceGUID, String externalSourceName, String schemaElementGUID, String schemaElementGUIDParameterName, String schemaElementTypeName, String queryTargetGUID, String queryTargetGUIDParameterName, String methodName)

Update the query properties for a query relationship for a derived schema element.

void

clearSchemaElementRelationship(String userId, String externalSourceGUID, String externalSourceName, String endOneGUID, String endTwoGUID, String relationshipTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)

Remove a relationship between two schema elements.

String

createDataContainer(String userId, String externalSourceGUID, String externalSourceName, String parentGUID, String qualifiedName, String displayName, String description, boolean isDeprecated, int elementPosition, int minCardinality, int maxCardinality, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)

Create a new metadata element to represent a data container.

String

createDataContainerFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, String parentGUID, String qualifiedName, String displayName, String description, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)

Create a new metadata element to represent a data container using an existing metadata element as a template.

List<SCHEMA_ATTRIBUTE>

findDataContainers(String userId, String searchString, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)

Retrieve the list of data container metadata elements that contain the search string.

List<SCHEMA_ATTRIBUTE>

getContainersForParent(String userId, String externalSourceGUID, String externalSourceName, String parentGUID, int startFrom, int pageSize, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)

Retrieve the list of data containers associated with a data container's parent.

SCHEMA_ATTRIBUTE

getDataContainerByGUID(String userId, String guid, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)

Retrieve the data container metadata element with the supplied unique identifier.

List<SCHEMA_ATTRIBUTE>

getDataContainersByName(String userId, String name, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)

Retrieve the list of data container metadata elements with a matching qualified or display name.

void

removeDataContainer(String userId, String externalSourceGUID, String externalSourceName, String dataContainerGUID, String dataContainerGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)

Remove the metadata element representing a data container.

void

setupQueryTargetRelationship(String userId, String externalSourceGUID, String externalSourceName, String schemaElementGUID, String schemaElementGUIDParameterName, String schemaElementTypeName, String queryId, String query, String queryTargetGUID, String queryTargetGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)

Create a new query relationship for a derived schema element.

void

setupSchemaElementRelationship(String userId, String externalSourceGUID, String externalSourceName, String endOneGUID, String endTwoGUID, String relationshipTypeName, Map<String,Object> properties, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)

Create a relationship between two schema elements.

void

updateDataContainer(String userId, String externalSourceGUID, String externalSourceName, String dataContainerGUID, String qualifiedName, String displayName, String description, boolean isDeprecated, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, Date effectiveFrom, Date effectiveTo, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)

Update the metadata element representing a data container.

void

updateQueryTargetRelationship(String userId, String externalSourceGUID, String externalSourceName, String schemaElementGUID, String schemaElementGUIDParameterName, String schemaElementTypeName, String queryId, String query, String queryTargetGUID, String queryTargetGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)

Update the query properties for a query relationship for a derived schema element.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler
addAssignmentScope, addDataFieldValuesClassification, addGovernanceActionClassification, addGovernanceDefinitionScope, addGovernanceExpectationsClassification, addGovernanceMeasurementsClassification, addGovernedBy, addImplementedBy, addMoreInformation, addOwner, addRetentionClassification, addSecurityTags, addStakeholder, addSubjectAreaClassification, addTemplateClassification, clearBusinessSignificant, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getAssignedActors, getAssignmentScope, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getCatalogTemplateList, getCollectionMembers, getCommissionedByStakeholder, getDataFieldValuesClassifiedElement, getDescriptiveElements, getElementsSourceFrom, getEntityByUniqueQualifiedName, getGovernanceActionClassifiedElements, getGovernanceDefinitionScope, getGovernedElements, getMeanings, getMoreInformation, getMoreInformation, getOwnersElements, getReferenceValueAssignees, getResourceList, getRetentionClassifiedElements, getSecurityTagsClassifiedElements, getSemanticAssignments, getSourceElements, getStakeholders, getSubjectAreaMembers, getSubjectAreaMembers, getSupportedByResource, getSupportedByTemplate, getValidValueConsumers, getVendorProperties, linkConsolidatedDuplicate, linkElementsAsPeerDuplicates, removeAssignmentScope, removeCatalogTemplate, removeDataFieldValuesClassification, removeGovernanceActionClassification, removeGovernanceDefinitionScope, removeGovernanceExpectationsClassification, removeGovernanceMeasurementsClassification, removeGovernedBy, removeImplementedBy, removeMoreInformation, removeOwner, removeResourceListMember, removeRetentionClassification, removeSecurityTags, removeSemanticAssignment, removeStakeholder, removeSubjectAreaClassification, removeTemplateClassification, saveCatalogTemplate, saveResourceListMember, saveSemanticAssignment, saveSemanticAssignment, saveSemanticAssignments, setBusinessSignificant, setVendorProperties, unlinkElementsAsPeerDuplicates

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPITemplateHandler
createBeanFromTemplate

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
addAnchorGUIDToBuilder, addAnchorsClassification, archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanInRepository, createBeanInRepository, deleteAnchoredEntity, deleteBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, deleteRelationship, entityMatchSearchCriteria, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findEntities, findEntities, findEntities, findEntities, getAllAttachmentLinks, getAnchorGUIDFromAnchorsClassification, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntitiesFromUser, getAttachedEntity, getAttachedEntity, getAttachedEntityFromUser, getAttachedFilteredEntities, getAttachedFilteredEntities, getAttachedFilteredEntities, getAttachmentLink, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanHistory, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getEntitiesByIntValue, getEntitiesByType, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getSupplementaryProperties, getUniqueAttachmentLink, getUniqueAttachmentLink, isBeanIsolated, isEntityATypeOf, linkElementToElement, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, multiLinkElementToElement, regexSearchCriteria, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, uncheckedLinkElementToElement, undoBeanUpdateInRepository, undoBeanUpdateInRepository, undoBeanUpdateInRepository, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipEffectivityDates, updateRelationshipProperties, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, validateUniqueProperty, verifyExternalSourceIdentity

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler
getConverter, getElementStub, getRepositoryHandler, getRepositoryHelper, getServerName, getServiceName, getSupportedZones, getTypeDefByName, setSecurityVerifier

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- errorHandler
  
  protected final RepositoryErrorHandler errorHandler
Constructor Details
- DisplayDataContainerHandler
  
  public DisplayDataContainerHandler(OpenMetadataAPIGenericConverter<SCHEMA_ATTRIBUTE> dataContainerConverter, Class<SCHEMA_ATTRIBUTE> dataContainerClass, OpenMetadataAPIGenericConverter<SCHEMA_TYPE> schemaTypeConverter, Class<SCHEMA_TYPE> schemaTypeClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)
  
  Construct the relational data handler with information needed to work with assets and schemas.
  
  Parameters:
  
  dataContainerConverter - specific converter for the SCHEMA_ATTRIBUTE bean class
  
  dataContainerClass - name of bean class that is represented by the generic class SCHEMA_ATTRIBUTE
  
  schemaTypeConverter - specific converter for the SCHEMA_TYPE bean class
  
  schemaTypeClass - name of bean class that is represented by the generic class SCHEMA_TYPE
  
  serviceName - name of this service
  
  serverName - name of the local server
  
  invalidParameterHandler - handler for managing parameter errors
  
  repositoryHandler - manages calls to the repository services
  
  repositoryHelper - provides utilities for manipulating the repository services objects
  
  localServerUserId - userId for this server
  
  securityVerifier - open metadata security services verifier
  
  supportedZones - list of zones that the access service is allowed to serve Asset instances from.
  
  defaultZones - list of zones that the access service should set in all new Asset instances.
  
  publishZones - list of zones that the access service sets up in published Asset instances.
  
  auditLog - destination for audit log events.
Method Details
- createDataContainer
  
  public String createDataContainer(String userId, String externalSourceGUID, String externalSourceName, String parentGUID, String qualifiedName, String displayName, String description, boolean isDeprecated, int elementPosition, int minCardinality, int maxCardinality, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a data container.
  
  Parameters:
  
  userId - calling user
  
  externalSourceGUID - unique identifier of software capability representing the DBMS
  
  externalSourceName - unique name of software capability representing the DBMS
  
  parentGUID - unique identifier of the data container's parent where the data container is located
  
  qualifiedName - unique name for the data container
  
  displayName - the stored display name property for the data container
  
  description - the stored description property associated with the data container
  
  isDeprecated - is this table deprecated?
  
  elementPosition - which order is the element when listing from parent's perspective
  
  maxCardinality - maximum number of instances of this element
  
  minCardinality - minimum number of instances of this element
  
  additionalProperties - any arbitrary properties not part of the type system
  
  typeName - name of the type that is a subtype of DisplayDataContainer - or null to create standard type
  
  extendedProperties - properties from any subtype
  
  vendorProperties - additional properties relating to the source of the data container technology
  
  effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
  
  effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
  
  methodName - calling method
  
  Returns:
  
  unique identifier of the new metadata element for the data container
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createDataContainerFromTemplate
  
  public String createDataContainerFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, String parentGUID, String qualifiedName, String displayName, String description, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a data container using an existing metadata element as a template.
  
  Parameters:
  
  userId - calling user
  
  externalSourceGUID - unique identifier of software capability representing the DBMS - if null a local element is created
  
  externalSourceName - unique name of software capability representing the DBMS
  
  templateGUID - unique identifier of the metadata element to copy
  
  parentGUID - unique identifier of the data container's parent where the data container is located.
  
  qualifiedName - unique name for the data container's parent
  
  displayName - the stored display name property for the data container
  
  description - the stored description property associated with the data container
  
  effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
  
  effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
  
  methodName - calling method
  
  Returns:
  
  unique identifier of the new data container's parent
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateDataContainer
  
  public void updateDataContainer(String userId, String externalSourceGUID, String externalSourceName, String dataContainerGUID, String qualifiedName, String displayName, String description, boolean isDeprecated, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, Map<String,String> vendorProperties, Date effectiveFrom, Date effectiveTo, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a data container.
  
  Parameters:
  
  userId - calling user
  
  externalSourceGUID - unique identifier of software capability representing the DBMS
  
  externalSourceName - unique name of software capability representing the DBMS
  
  dataContainerGUID - unique identifier of the data container to update
  
  qualifiedName - unique name for the data container's parent
  
  displayName - the stored display name property for the data container
  
  description - the stored description property associated with the data container
  
  isDeprecated - is this table deprecated?
  
  additionalProperties - any arbitrary properties not part of the type system
  
  typeName - name of the type that is a subtype of DisplayDataContainer - or null to create standard type
  
  extendedProperties - properties from any subtype
  
  vendorProperties - additional properties relating to the source of the data container technology
  
  isMergeUpdate - are unspecified properties unchanged (true) or removed?
  
  effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
  
  effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
  
  methodName - calling method
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeDataContainer
  
  public void removeDataContainer(String userId, String externalSourceGUID, String externalSourceName, String dataContainerGUID, String dataContainerGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a data container.
  
  Parameters:
  
  userId - calling user
  
  externalSourceGUID - unique identifier of software capability representing the DBMS
  
  externalSourceName - unique name of software capability representing the DBMS
  
  dataContainerGUID - unique identifier of the metadata element to remove
  
  dataContainerGUIDParameterName - name of parameter supplying dataContainerGUID
  
  qualifiedName - unique name of the metadata element to remove
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
  
  methodName - calling method
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findDataContainers
  
  public List<SCHEMA_ATTRIBUTE> findDataContainers(String userId, String searchString, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of data container metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  userId - calling user
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
  
  methodName - calling method
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getContainersForParent
  
  public List<SCHEMA_ATTRIBUTE> getContainersForParent(String userId, String externalSourceGUID, String externalSourceName, String parentGUID, int startFrom, int pageSize, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of data containers associated with a data container's parent.
  
  Parameters:
  
  userId - calling user
  
  externalSourceGUID - unique identifier of software capability representing the DBMS - if null a local element is created
  
  externalSourceName - unique name of software capability representing the DBMS
  
  parentGUID - unique identifier of the data container's parent of interest
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)
  
  effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
  
  methodName - calling method
  
  Returns:
  
  list of associated metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getDataContainersByName
  
  public List<SCHEMA_ATTRIBUTE> getDataContainersByName(String userId, String name, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of data container metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  userId - calling user
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
  
  methodName - calling method
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getDataContainerByGUID
  
  public SCHEMA_ATTRIBUTE getDataContainerByGUID(String userId, String guid, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the data container metadata element with the supplied unique identifier.
  
  Parameters:
  
  userId - calling user
  
  guid - unique identifier of the requested metadata element
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
  
  methodName - calling method
  
  Returns:
  
  matching metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupQueryTargetRelationship
  
  public void setupQueryTargetRelationship(String userId, String externalSourceGUID, String externalSourceName, String schemaElementGUID, String schemaElementGUIDParameterName, String schemaElementTypeName, String queryId, String query, String queryTargetGUID, String queryTargetGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new query relationship for a derived schema element.
  
  Parameters:
  
  userId - calling user
  
  externalSourceGUID - unique identifier of software capability representing the DBMS
  
  externalSourceName - unique name of software capability representing the DBMS
  
  schemaElementGUID - unique identifier of the schema element that this query supports
  
  schemaElementGUIDParameterName - parameter name for schemaElementGUID
  
  schemaElementTypeName - name of type for schema element
  
  queryId - identifier for the query - used as a placeholder in the formula (stored in the column's CalculatedValue classification)
  
  query - the query that is made on the targetGUID
  
  queryTargetGUID - the unique identifier of the target (this is a schema element - typically a schema attribute)
  
  queryTargetGUIDParameterName - parameter supplying queryTargetGUID
  
  effectiveFrom - starting time for this relationship (null for all time)
  
  effectiveTo - ending time for this relationship (null for all time)
  
  forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
  
  forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
  
  effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
  
  methodName - calling method
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateQueryTargetRelationship
  
  public void updateQueryTargetRelationship(String userId, String externalSourceGUID, String externalSourceName, String schemaElementGUID, String schemaElementGUIDParameterName, String schemaElementTypeName, String queryId, String query, String queryTargetGUID, String queryTargetGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the query properties for a query relationship for a derived schema element.
  
  Parameters:
  
  userId - calling user
  
  externalSourceGUID - unique identifier of software capability representing the DBMS
  
  externalSourceName - unique name of software capability representing the DBMS
  
  schemaElementGUID - unique identifier of the schema element that this query supports
  
  schemaElementGUIDParameterName - parameter name for schemaElementGUID
  
  schemaElementTypeName - name of type for schema element
  
  queryId - identifier for the query - used as a placeholder in the formula (stored in the column's CalculatedValue classification)
  
  query - the query that is made on the targetGUID
  
  queryTargetGUID - the unique identifier of the target (this is a schema element - typically a schema attribute)
  
  queryTargetGUIDParameterName - parameter supplying queryTargetGUID
  
  effectiveFrom - starting time for this relationship (null for all time)
  
  effectiveTo - ending time for this relationship (null for all time)
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
  
  forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
  
  effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
  
  methodName - calling method
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearQueryTargetRelationship
  
  public void clearQueryTargetRelationship(String userId, String externalSourceGUID, String externalSourceName, String schemaElementGUID, String schemaElementGUIDParameterName, String schemaElementTypeName, String queryTargetGUID, String queryTargetGUIDParameterName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the query properties for a query relationship for a derived schema element.
  
  Parameters:
  
  userId - calling user
  
  externalSourceGUID - unique identifier of software capability representing the DBMS
  
  externalSourceName - unique name of software capability representing the DBMS
  
  schemaElementGUID - unique identifier of the schema element that this query supports
  
  schemaElementGUIDParameterName - parameter name for schemaElementGUID
  
  schemaElementTypeName - name of type for schema element
  
  queryTargetGUID - the unique identifier of the target (this is a schema element - typically a schema attribute)
  
  queryTargetGUIDParameterName - parameter supplying queryTargetGUID
  
  methodName - calling method
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupSchemaElementRelationship
  
  public void setupSchemaElementRelationship(String userId, String externalSourceGUID, String externalSourceName, String endOneGUID, String endTwoGUID, String relationshipTypeName, Map<String,Object> properties, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between two schema elements. The name of the desired relationship, and any properties (including effectivity dates) are passed on the API.
  
  Parameters:
  
  userId - calling user
  
  externalSourceGUID - unique identifier of software server capability representing the caller
  
  externalSourceName - unique name of software server capability representing the caller
  
  endOneGUID - unique identifier of the schema element at end one of the relationship
  
  endTwoGUID - unique identifier of the schema element at end two of the relationship
  
  relationshipTypeName - type of the relationship to create
  
  properties - properties for the new relationship
  
  effectiveFrom - the date when this element is active - null for active now
  
  effectiveTo - the date when this element becomes inactive - null for active until deleted
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  effectiveTime - when should the elements be effected for - null is anytime; new Date() is now
  
  methodName - calling method
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearSchemaElementRelationship
  
  public void clearSchemaElementRelationship(String userId, String externalSourceGUID, String externalSourceName, String endOneGUID, String endTwoGUID, String relationshipTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between two schema elements. The name of the desired relationship is passed on the API.
  
  Parameters:
  
  userId - calling user
  
  externalSourceGUID - unique identifier of software server capability representing the caller
  
  externalSourceName - unique name of software server capability representing the caller
  
  endOneGUID - unique identifier of the schema element at end one of the relationship
  
  endTwoGUID - unique identifier of the schema element at end two of the relationship
  
  relationshipTypeName - type of the relationship to create
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  effectiveTime - when should the elements be effected for - null is anytime; new Date() is now
  
  methodName - calling method
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)

Class DisplayDataContainerHandler<SCHEMA_ATTRIBUTE,SCHEMA_TYPE>

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPITemplateHandler

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler

Methods inherited from class java.lang.Object

Field Details

errorHandler

Constructor Details

DisplayDataContainerHandler

Method Details

createDataContainer

createDataContainerFromTemplate

updateDataContainer

removeDataContainer

findDataContainers

getContainersForParent

getDataContainersByName

getDataContainerByGUID

setupQueryTargetRelationship

updateQueryTargetRelationship

clearQueryTargetRelationship

setupSchemaElementRelationship

clearSchemaElementRelationship