Class MetadataCollection

  • All Implemented Interfaces:
    org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent

    public class MetadataCollection
    extends org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollectionBase
    • Field Summary

      • Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollection

        auditLog, metadataCollectionId, metadataCollectionName, parentConnector, repositoryHelper, repositoryName, repositoryValidator
    • Constructor Summary

      Constructors 
      Constructor Description
      MetadataCollection​(RepositoryConnector parentConnector, java.lang.String repositoryName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryValidator repositoryValidator, java.lang.String metadataCollectionId)
      Constructor ensures the metadata collection is linked to its connector and knows its metadata collection Id.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addTypeDef​(java.lang.String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef newTypeDef)
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefGallery getAllTypes​(java.lang.String userId)
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail getEntityDetail​(java.lang.String userId, java.lang.String guid)
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary getEntitySummary​(java.lang.String userId, java.lang.String guid)
      RepositoryEventMapper getEventMapper()  
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship getRelationship​(java.lang.String userId, java.lang.String guid)  
      java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship> getRelationshipsForEntity​(java.lang.String userId, java.lang.String entityGUID, java.lang.String relationshipTypeGUID, int fromRelationshipElement, java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus, java.util.Date asOfTime, java.lang.String sequencingProperty, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.SequencingOrder sequencingOrder, int pageSize)  
      TypeDefStore getTypeDefStore()  
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail isEntityKnown​(java.lang.String userId, java.lang.String guid)
      void setEventMapper​(RepositoryEventMapper RepositoryEventMapper)  
      boolean verifyTypeDef​(java.lang.String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef)
      • Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollectionBase

        addAttributeTypeDef, addEntity, addEntityParameterValidation, addEntityParameterValidation, addEntityProxy, addEntityProxyParameterValidation, addExternalEntity, addExternalEntityParameterValidation, addExternalRelationship, addExternalRelationshipParameterValidation, addRelationship, addRelationshipParameterValidation, addRelationshipParameterValidation, addTypeDefGallery, attributeTypeDefCategoryParameterValidation, attributeTypeDefParameterValidation, classifyEntity, classifyEntity, classifyEntityParameterValidation, classifyEntityParameterValidation, declassifyEntity, declassifyEntityParameterValidation, declassifyEntityParameterValidation, deleteAttributeTypeDef, deleteEntity, deleteEntityReferenceCopy, deleteRelationship, deleteRelationshipReferenceCopy, deleteTypeDef, filterAttributeTypeDefsByCategory, filterAttributeTypeDefsByGUID, filterAttributeTypeDefsByName, filterTypeDefsByCategory, filterTypeDefsByGUID, filterTypeDefsByName, filterTypeDefsByProperty, filterTypeDefsBySearchCriteria, filterTypesByExternalID, filterTypesByWildCardName, findAttributeTypeDefsByCategory, findEntities, findEntitiesByClassification, findEntitiesByClassificationParameterValidation, findEntitiesByProperty, findEntitiesByPropertyParameterValidation, findEntitiesByPropertyValue, findEntitiesByPropertyValueParameterValidation, findEntitiesParameterValidation, findRelationships, findRelationshipsByProperty, findRelationshipsByPropertyParameterValidation, findRelationshipsByPropertyValue, findRelationshipsByPropertyValueParameterValidation, findRelationshipsParameterValidation, findTypeDefsByCategory, findTypeDefsByProperty, findTypesByExternalID, findTypesByName, getAttributeTypeDefByGUID, getAttributeTypeDefByName, getEntityDetail, getEntityDetailHistory, getEntityNeighborhood, getEntityNeighborhoodParameterValidation, getEntityProxy, getHomeClassifications, getHomeClassifications, getInstanceHistoryParameterValidation, getInstanceParameterValidation, getInstanceParameterValidation, getLinkingEntities, getLinkingEntitiesParameterValidation, getMetadataCollectionId, getRelatedEntities, getRelatedEntitiesParameterValidation, getRelationship, getRelationshipHistory, getRelationshipsForEntityParameterValidation, getTypeDefByGUID, getTypeDefByName, getTypeDefForInstance, isRelationshipKnown, manageAttributeTypeDefParameterValidation, manageInstanceParameterValidation, manageInstanceParameterValidation, manageInstanceParameterValidation, manageReferenceInstanceParameterValidation, manageTypeDefParameterValidation, newAttributeTypeDefParameterValidation, newTypeDefParameterValidation, purgeClassificationReferenceCopy, purgeEntity, purgeEntityReferenceCopy, purgeEntityReferenceCopy, purgeRelationship, purgeRelationshipReferenceCopy, purgeRelationshipReferenceCopy, referenceInstanceParameterValidation, refreshEntityReferenceCopy, refreshRelationshipReferenceCopy, reHomeEntity, reHomeInstanceParameterValidation, reHomeRelationship, reIdentifyAttributeTypeDef, reIdentifyEntity, reIdentifyInstanceParameterValidation, reIdentifyRelationship, reIdentifyTypeDef, removeInstanceParameterValidation, reportEntityNotKnown, reportEntityProxyOnly, reportRelationshipNotKnown, reportTypeDefAlreadyDefined, reportTypeDefConflict, reportTypeDefInUse, reportTypeDefNotSupported, reportUnknownTypeGUID, reportUnknownTypeName, reportUnsupportedAsOfTimeFunction, reportUnsupportedOptionalFunction, restoreEntity, restoreRelationship, reTypeEntity, reTypeInstanceParameterValidation, reTypeRelationship, saveClassificationReferenceCopy, saveEntityReferenceCopy, saveRelationshipReferenceCopy, searchForTypeDefs, typeDefCategoryParameterValidation, typeDefExternalIDParameterValidation, typeDefParameterValidation, typeDefPropertyParameterValidation, typeDefSearchParameterValidation, typeGUIDParameterValidation, typeNameParameterValidation, undoEntityUpdate, undoRelationshipUpdate, updateEntityClassification, updateEntityClassificationParameterValidation, updateEntityProperties, updateEntityStatus, updateInstancePropertiesPropertyValidation, updateInstanceStatusParameterValidation, updateRelationshipProperties, updateRelationshipStatus, updateTypeDef, updateTypeDefParameterValidation, verifyAttributeTypeDef
      • Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollection

        basicRequestValidation, getMetadataCollectionId, reHomeEntity, reHomeRelationship, saveInstanceReferenceCopies, setAuditLog, validateRepositoryConnector
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • MetadataCollection

        public MetadataCollection​(RepositoryConnector parentConnector,
                                  java.lang.String repositoryName,
                                  org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper,
                                  org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryValidator repositoryValidator,
                                  java.lang.String metadataCollectionId)
        Constructor ensures the metadata collection is linked to its connector and knows its metadata collection Id.
        Parameters:
        parentConnector - connector that this metadata collection supports. The connector has the information to call the metadata repository.
        repositoryName - name of this repository.
        repositoryHelper - helper class for building types and instances
        repositoryValidator - validator class for checking open metadata repository objects and parameters.
        metadataCollectionId - unique identifier of the metadata collection Id.
    • Method Detail

      • getAllTypes

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefGallery getAllTypes​(java.lang.String userId)
                                                                                                                                          throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
                                                                                                                                                 org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Overrides:
        getAllTypes in class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollectionBase
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
      • addTypeDef

        public void addTypeDef​(java.lang.String userId,
                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef newTypeDef)
                        throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                               org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
                               org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefNotSupportedException,
                               org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefKnownException,
                               org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefConflictException,
                               org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidTypeDefException
        Overrides:
        addTypeDef in class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollectionBase
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefNotSupportedException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefKnownException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefConflictException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidTypeDefException
      • verifyTypeDef

        public boolean verifyTypeDef​(java.lang.String userId,
                                     org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef)
                              throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                     org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
                                     org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefNotSupportedException,
                                     org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidTypeDefException
        Overrides:
        verifyTypeDef in class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollectionBase
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefNotSupportedException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidTypeDefException
      • isEntityKnown

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail isEntityKnown​(java.lang.String userId,
                                                                                                                                                  java.lang.String guid)
                                                                                                                                           throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                                                                                                                                  org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Overrides:
        isEntityKnown in class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollectionBase
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
      • getEntitySummary

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary getEntitySummary​(java.lang.String userId,
                                                                                                                                                      java.lang.String guid)
                                                                                                                                               throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                                                                                                                                      org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
                                                                                                                                                      org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException
        Overrides:
        getEntitySummary in class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollectionBase
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException
      • getEntityDetail

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail getEntityDetail​(java.lang.String userId,
                                                                                                                                                    java.lang.String guid)
                                                                                                                                             throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                                                                                                                                    org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
                                                                                                                                                    org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException
        Overrides:
        getEntityDetail in class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollectionBase
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException
      • getRelationshipsForEntity

        public java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship> getRelationshipsForEntity​(java.lang.String userId,
                                                                                                                                                                              java.lang.String entityGUID,
                                                                                                                                                                              java.lang.String relationshipTypeGUID,
                                                                                                                                                                              int fromRelationshipElement,
                                                                                                                                                                              java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> limitResultsByStatus,
                                                                                                                                                                              java.util.Date asOfTime,
                                                                                                                                                                              java.lang.String sequencingProperty,
                                                                                                                                                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.SequencingOrder sequencingOrder,
                                                                                                                                                                              int pageSize)
                                                                                                                                                                       throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                                                                                                                                                              org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException,
                                                                                                                                                                              org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
                                                                                                                                                                              org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException,
                                                                                                                                                                              org.odpi.openmetadata.repositoryservices.ffdc.exception.PagingErrorException,
                                                                                                                                                                              org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException,
                                                                                                                                                                              org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException
        Overrides:
        getRelationshipsForEntity in class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollectionBase
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.PagingErrorException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException
      • getRelationship

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship getRelationship​(java.lang.String userId,
                                                                                                                                                    java.lang.String guid)
                                                                                                                                             throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                                                                                                                                    org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
                                                                                                                                                    org.odpi.openmetadata.repositoryservices.ffdc.exception.RelationshipNotKnownException
        Overrides:
        getRelationship in class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollectionBase
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RelationshipNotKnownException