Class OMRSArchiveHelper

    • Constructor Summary

      Constructors 
      Constructor Description
      OMRSArchiveHelper​(OpenMetadataArchiveBuilder archiveBuilder, java.lang.String archiveGUID, java.lang.String archiveName, java.lang.String originatorName, java.util.Date creationDate, long versionNumber, java.lang.String versionName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProvenanceType instanceProvenanceType, java.lang.String license)
      Constructor receives information about the archive being built.
      OMRSArchiveHelper​(OpenMetadataArchiveBuilder archiveBuilder, java.lang.String archiveGUID, java.lang.String originatorName, java.util.Date creationDate, long versionNumber, java.lang.String versionName)
      Constructor receives information about the archive being built.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.CollectionDef getArrayCollectionDef​(java.lang.String guid, java.lang.String description, java.lang.String descriptionGUID, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.PrimitiveDefCategory arrayType)
      Create a CollectionDef for an Array.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getArrayEnumTypeDefAttribute​(java.lang.String enumArrayTypeName, java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name, type and description.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getArrayIntTypeDefAttribute​(java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name and description that is an array of strings.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getArrayStringTypeDefAttribute​(java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name and description that is an array of strings.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.RelationshipDef getBasicRelationshipDef​(java.lang.String guid, java.lang.String name, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink superType, java.lang.String description, java.lang.String descriptionGUID, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.ClassificationPropagationRule propagationRule)
      Returns a basic RelationshipDef without any attributes or ends set up.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getBooleanTypeDefAttribute​(java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name and description that is of type boolean.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification getClassification​(java.lang.String typeName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus status)
      Return a specific classification instance.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.ClassificationDef getClassificationDef​(java.lang.String guid, java.lang.String name, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink superType, java.lang.String description, java.lang.String descriptionGUID, java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink> validEntityDefs, boolean propagatable)
      Returns a basic ClassificationDef without any attributes.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.ClassificationDef getClassificationDef​(java.lang.String guid, java.lang.String name, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink superType, java.lang.String description, java.lang.String descriptionGUID, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink validEntityDef, boolean propagatable)
      Returns a basic ClassificationDef without any attributes.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.ClassificationEntityExtension getClassificationEntityExtension​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entity, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification classification)
      Build a classification entity extension that is used to pass a classification in an archive.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getDateTypeDefAttribute​(java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name and description that is of type date.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.EntityDef getDefaultEntityDef​(java.lang.String guid, java.lang.String name, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink superType, java.lang.String description, java.lang.String descriptionGUID)
      Sets up a default EntityDef.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.EnumDef getEmptyEnumDef​(java.lang.String guid, java.lang.String name, java.lang.String description, java.lang.String descriptionGUID)
      Create an EnumDef that has no valid values defined.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail getEntityDetail​(java.lang.String typeName, java.lang.String guid, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus status, java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> classifications)
      Return a specific entity detail instance.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy getEntityProxy​(java.lang.String typeName, java.lang.String guid, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus status, java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> classifications)
      Return a specific entity proxy instance.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy getEntityProxy​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail entity)
      Build an entity proxy from an entity.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.EnumElementDef getEnumElement​(java.lang.String enumTypeName, int ordinal)
      Extract the enum value definition based on the ordinal.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.EnumElementDef getEnumElementDef​(int ordinal, java.lang.String value, java.lang.String description, java.lang.String descriptionGUID)
      Create an EnumElementDef that carries one of the valid values for an Enum.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getEnumTypeDefAttribute​(java.lang.String enumTypeName, java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name, type and description.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getFloatTypeDefAttribute​(java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name and description that is of type long.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getIntTypeDefAttribute​(java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name and description that is of type int.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getLongTypeDefAttribute​(java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name and description that is of type long.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.CollectionDef getMapCollectionDef​(java.lang.String guid, java.lang.String description, java.lang.String descriptionGUID, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.PrimitiveDefCategory propertyKeyType, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.PrimitiveDefCategory propertyValueType)
      Create a CollectionDef for a map.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getMapStringBooleanTypeDefAttribute​(java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name and description that is of a map from string to boolean.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getMapStringIntTypeDefAttribute​(java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name and description that is of a map from string to boolean.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getMapStringLongTypeDefAttribute​(java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name and description that is of a map from string to boolean.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getMapStringObjectTypeDefAttribute​(java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name and description that is of a map from string to string.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getMapStringStringTypeDefAttribute​(java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name and description that is of a map from string to string.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.PrimitiveDef getPrimitiveDef​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.PrimitiveDefCategory primitiveDefCategory)
      Set up an individual primitive definition
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship getRelationship​(java.lang.String typeName, java.lang.String guid, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus status, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy end1, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy end2)
      Return a specific relationship instance.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.RelationshipEndDef getRelationshipEndDef​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink entityType, java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.RelationshipEndCardinality attributeCardinality)
      Returns a RelationshipEndDef object that sets up details of an entity at one end of a relationship.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getStringTypeDefAttribute​(java.lang.String attributeName, java.lang.String attributeDescription, java.lang.String attributeDescriptionGUID)
      Return an attribute with the supplied name and description that is of type String.
      • Methods inherited from class java.lang.Object

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

      • OMRSArchiveHelper

        public OMRSArchiveHelper​(OpenMetadataArchiveBuilder archiveBuilder,
                                 java.lang.String archiveGUID,
                                 java.lang.String originatorName,
                                 java.util.Date creationDate,
                                 long versionNumber,
                                 java.lang.String versionName)
        Constructor receives information about the archive being built. This constructor is suitable if only creating typeDefs.
        Parameters:
        archiveBuilder - archive builder with the archive contents in it.
        archiveGUID - unique identifier for the archive.
        originatorName - name of the person / process creating the archive.
        creationDate - date that the archive was first built.
        versionNumber - version number of the archive.
        versionName - version name for the archive.
      • OMRSArchiveHelper

        public OMRSArchiveHelper​(OpenMetadataArchiveBuilder archiveBuilder,
                                 java.lang.String archiveGUID,
                                 java.lang.String archiveName,
                                 java.lang.String originatorName,
                                 java.util.Date creationDate,
                                 long versionNumber,
                                 java.lang.String versionName,
                                 org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProvenanceType instanceProvenanceType,
                                 java.lang.String license)
        Constructor receives information about the archive being built. This constructor is suitable for creating TypeDefs and instances.
        Parameters:
        archiveBuilder - archive builder with the archive contents in it.
        archiveGUID - unique identifier for the archive.
        archiveName - unique name for the archive.
        originatorName - name of the person / process creating the archive.
        creationDate - date that the archive was first built.
        versionNumber - version number of the archive.
        versionName - version name for the archive.
        instanceProvenanceType - type of archive.
        license - license for the archive contents.
    • Method Detail

      • getPrimitiveDef

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.PrimitiveDef getPrimitiveDef​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.PrimitiveDefCategory primitiveDefCategory)
        Set up an individual primitive definition
        Parameters:
        primitiveDefCategory - category of the primitive def defines the unique information about this primitive type.
        Returns:
        initialized PrimitiveDef object ready for the archive
      • getArrayCollectionDef

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.CollectionDef getArrayCollectionDef​(java.lang.String guid,
                                                                                                                                                          java.lang.String description,
                                                                                                                                                          java.lang.String descriptionGUID,
                                                                                                                                                          org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.PrimitiveDefCategory arrayType)
        Create a CollectionDef for an Array. A new CollectionDef is required for each combination of primitive types used to initialize the collection. Each CollectionDef has its own unique identifier (guid) and its name is a combination of the collection type and the primitives use to initialize it.
        Parameters:
        guid - unique identifier for the CollectionDef
        description - short default description of the enum type
        descriptionGUID - guid of the glossary term describing this collection type
        arrayType - type of the array.
        Returns:
        Filled out CollectionDef
      • getMapCollectionDef

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.CollectionDef getMapCollectionDef​(java.lang.String guid,
                                                                                                                                                        java.lang.String description,
                                                                                                                                                        java.lang.String descriptionGUID,
                                                                                                                                                        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.PrimitiveDefCategory propertyKeyType,
                                                                                                                                                        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.PrimitiveDefCategory propertyValueType)
        Create a CollectionDef for a map. A new CollectionDef is required for each combination of primitive types used to initialize the collection. Each CollectionDef has its own unique identifier (guid) and its name is a combination of the collection type and the primitives use to initialize it.
        Parameters:
        guid - unique identifier for the CollectionDef
        description - short default description of the enum type
        descriptionGUID - guid of the glossary term describing this collection type
        propertyKeyType - type of the key for the map.
        propertyValueType - type of map value.
        Returns:
        Filled out CollectionDef
      • getEmptyEnumDef

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.EnumDef getEmptyEnumDef​(java.lang.String guid,
                                                                                                                                              java.lang.String name,
                                                                                                                                              java.lang.String description,
                                                                                                                                              java.lang.String descriptionGUID)
        Create an EnumDef that has no valid values defined. These are added by the caller.
        Parameters:
        guid - unique identifier for the CollectionDef
        name - unique name for the CollectionDef
        description - short default description of the enum type
        descriptionGUID - guid of the glossary term describing this enum type
        Returns:
        basic EnumDef without valid values
      • getEnumElementDef

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.EnumElementDef getEnumElementDef​(int ordinal,
                                                                                                                                                       java.lang.String value,
                                                                                                                                                       java.lang.String description,
                                                                                                                                                       java.lang.String descriptionGUID)
        Create an EnumElementDef that carries one of the valid values for an Enum.
        Parameters:
        ordinal - code number
        value - name
        description - short description
        descriptionGUID - guid of the glossary term describing this enum element
        Returns:
        Fully filled out EnumElementDef
      • getDefaultEntityDef

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.EntityDef getDefaultEntityDef​(java.lang.String guid,
                                                                                                                                                    java.lang.String name,
                                                                                                                                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink superType,
                                                                                                                                                    java.lang.String description,
                                                                                                                                                    java.lang.String descriptionGUID)
        Sets up a default EntityDef. Calling methods can override the default values. This EntityDef has no attribute defined.
        Parameters:
        guid - unique identifier for the entity
        name - name of the entity
        superType - Super type for this entity (null for top-level)
        description - short description of the entity
        descriptionGUID - guid of the glossary term describing this entity type
        Returns:
        Initialized EntityDef
      • getStringTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getStringTypeDefAttribute​(java.lang.String attributeName,
                                                                                                                                                                 java.lang.String attributeDescription,
                                                                                                                                                                 java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name and description that is of type String. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getIntTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getIntTypeDefAttribute​(java.lang.String attributeName,
                                                                                                                                                              java.lang.String attributeDescription,
                                                                                                                                                              java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name and description that is of type int. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getBooleanTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getBooleanTypeDefAttribute​(java.lang.String attributeName,
                                                                                                                                                                  java.lang.String attributeDescription,
                                                                                                                                                                  java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name and description that is of type boolean. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getDateTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getDateTypeDefAttribute​(java.lang.String attributeName,
                                                                                                                                                               java.lang.String attributeDescription,
                                                                                                                                                               java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name and description that is of type date. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getLongTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getLongTypeDefAttribute​(java.lang.String attributeName,
                                                                                                                                                               java.lang.String attributeDescription,
                                                                                                                                                               java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name and description that is of type long. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getFloatTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getFloatTypeDefAttribute​(java.lang.String attributeName,
                                                                                                                                                                java.lang.String attributeDescription,
                                                                                                                                                                java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name and description that is of type long. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getArrayStringTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getArrayStringTypeDefAttribute​(java.lang.String attributeName,
                                                                                                                                                                      java.lang.String attributeDescription,
                                                                                                                                                                      java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name and description that is an array of strings. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getArrayIntTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getArrayIntTypeDefAttribute​(java.lang.String attributeName,
                                                                                                                                                                   java.lang.String attributeDescription,
                                                                                                                                                                   java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name and description that is an array of strings. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getMapStringStringTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getMapStringStringTypeDefAttribute​(java.lang.String attributeName,
                                                                                                                                                                          java.lang.String attributeDescription,
                                                                                                                                                                          java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name and description that is of a map from string to string. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getMapStringObjectTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getMapStringObjectTypeDefAttribute​(java.lang.String attributeName,
                                                                                                                                                                          java.lang.String attributeDescription,
                                                                                                                                                                          java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name and description that is of a map from string to string. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getMapStringBooleanTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getMapStringBooleanTypeDefAttribute​(java.lang.String attributeName,
                                                                                                                                                                           java.lang.String attributeDescription,
                                                                                                                                                                           java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name and description that is of a map from string to boolean. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getMapStringLongTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getMapStringLongTypeDefAttribute​(java.lang.String attributeName,
                                                                                                                                                                        java.lang.String attributeDescription,
                                                                                                                                                                        java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name and description that is of a map from string to boolean. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getMapStringIntTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getMapStringIntTypeDefAttribute​(java.lang.String attributeName,
                                                                                                                                                                       java.lang.String attributeDescription,
                                                                                                                                                                       java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name and description that is of a map from string to boolean. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getEnumTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getEnumTypeDefAttribute​(java.lang.String enumTypeName,
                                                                                                                                                               java.lang.String attributeName,
                                                                                                                                                               java.lang.String attributeDescription,
                                                                                                                                                               java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name, type and description. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        enumTypeName - name of the enum type for this attribute
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getArrayEnumTypeDefAttribute

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefAttribute getArrayEnumTypeDefAttribute​(java.lang.String enumArrayTypeName,
                                                                                                                                                                    java.lang.String attributeName,
                                                                                                                                                                    java.lang.String attributeDescription,
                                                                                                                                                                    java.lang.String attributeDescriptionGUID)
        Return an attribute with the supplied name, type and description. It is set up to be optional, indexable (useful for searches) but the value does not need to be unique. These are the typical values used for most open metadata attribute. They can be changed by the caller once the TypeDefAttribute is returned.
        Parameters:
        enumArrayTypeName - name of the enum type for this attribute
        attributeName - name of the attribute
        attributeDescription - short description for the attribute
        attributeDescriptionGUID - guid of the glossary term that describes this attribute.
        Returns:
        TypeDefAttribute of type string
      • getBasicRelationshipDef

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.RelationshipDef getBasicRelationshipDef​(java.lang.String guid,
                                                                                                                                                              java.lang.String name,
                                                                                                                                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink superType,
                                                                                                                                                              java.lang.String description,
                                                                                                                                                              java.lang.String descriptionGUID,
                                                                                                                                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.ClassificationPropagationRule propagationRule)
        Returns a basic RelationshipDef without any attributes or ends set up. The caller is responsible for adding the attributes and ends definition.
        Parameters:
        guid - unique identifier for the relationship
        name - name of the relationship
        superType - Super type for this relationship (null for top-level)
        description - short default description of the relationship
        descriptionGUID - guid of the glossary term that describes this relationship
        propagationRule - should classifications propagate over this relationship?
        Returns:
        RelationshipDef with no ends defined.
      • getRelationshipEndDef

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.RelationshipEndDef getRelationshipEndDef​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink entityType,
                                                                                                                                                               java.lang.String attributeName,
                                                                                                                                                               java.lang.String attributeDescription,
                                                                                                                                                               java.lang.String attributeDescriptionGUID,
                                                                                                                                                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.RelationshipEndCardinality attributeCardinality)
        Returns a RelationshipEndDef object that sets up details of an entity at one end of a relationship.
        Parameters:
        entityType - details of the type of entity connected to this end.
        attributeName - name of the attribute that the entity at the other end uses to refer to this entity.
        attributeDescription - description of this attribute
        attributeDescriptionGUID - unique identifier of the glossary term describing this attribute.
        attributeCardinality - cardinality of this end of the relationship.
        Returns:
        the definition of one end of a Relationship.
      • getClassificationDef

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.ClassificationDef getClassificationDef​(java.lang.String guid,
                                                                                                                                                             java.lang.String name,
                                                                                                                                                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink superType,
                                                                                                                                                             java.lang.String description,
                                                                                                                                                             java.lang.String descriptionGUID,
                                                                                                                                                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink validEntityDef,
                                                                                                                                                             boolean propagatable)
        Returns a basic ClassificationDef without any attributes. The caller is responsible for adding the attribute definitions.
        Parameters:
        guid - unique identifier for the classification
        name - name of the classification
        superType - Super type for this classification (null for top-level)
        description - short description of the classification
        descriptionGUID - unique identifier of the glossary term that describes this classification.
        validEntityDef - which entities can this classification be linked to.
        propagatable - can the classification propagate over relationships?
        Returns:
        ClassificationDef with no attributes defined.
      • getClassificationDef

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.ClassificationDef getClassificationDef​(java.lang.String guid,
                                                                                                                                                             java.lang.String name,
                                                                                                                                                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink superType,
                                                                                                                                                             java.lang.String description,
                                                                                                                                                             java.lang.String descriptionGUID,
                                                                                                                                                             java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink> validEntityDefs,
                                                                                                                                                             boolean propagatable)
        Returns a basic ClassificationDef without any attributes. The caller is responsible for adding the attribute definitions.
        Parameters:
        guid - unique identifier for the classification
        name - name of the classification
        superType - Super type for this classification (null for top-level)
        description - short description of the classification
        descriptionGUID - unique identifier of the glossary term that describes this classification.
        validEntityDefs - which entities can this classification be linked to.
        propagatable - can the classification propagate over relationships?
        Returns:
        ClassificationDef with no attributes defined.
      • getEntityDetail

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail getEntityDetail​(java.lang.String typeName,
                                                                                                                                                    java.lang.String guid,
                                                                                                                                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus status,
                                                                                                                                                    java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> classifications)
        Return a specific entity detail instance.
        Parameters:
        typeName - type name of the entity
        guid - unique identifier of the entity
        properties - properties (attributes) for the entity
        status - instance status
        classifications - list of classifications
        Returns:
        assembled entity
      • getRelationship

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship getRelationship​(java.lang.String typeName,
                                                                                                                                                    java.lang.String guid,
                                                                                                                                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus status,
                                                                                                                                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy end1,
                                                                                                                                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy end2)
        Return a specific relationship instance.
        Parameters:
        typeName - type name of the relationship
        guid - unique identifier of the relationship
        properties - properties (attributes) for the relationship
        status - instance status
        end1 - relationship end 1
        end2 - relationship end 2
        Returns:
        relationship instance
      • getClassification

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification getClassification​(java.lang.String typeName,
                                                                                                                                                        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus status)
        Return a specific classification instance.
        Parameters:
        typeName - type name of the classification
        properties - properties (attributes) for the classification
        status - instance status
        Returns:
        classification instance
      • getEntityProxy

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy getEntityProxy​(java.lang.String typeName,
                                                                                                                                                  java.lang.String guid,
                                                                                                                                                  org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                  org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus status,
                                                                                                                                                  java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> classifications)
        Return a specific entity proxy instance.
        Parameters:
        typeName - type name of the entity
        guid - unique identifier of the entity
        properties - unique properties (attributes) for the entity
        status - instance status
        classifications - list of classifications
        Returns:
        classification instance
      • getEntityProxy

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy getEntityProxy​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail entity)
        Build an entity proxy from an entity.
        Parameters:
        entity - entity to use as a template
        Returns:
        new entity proxy.
      • getClassificationEntityExtension

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.ClassificationEntityExtension getClassificationEntityExtension​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entity,
                                                                                                                                                                                      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification classification)
        Build a classification entity extension that is used to pass a classification in an archive.
        Parameters:
        entity - entity proxy to shoe where the classification should be attached
        classification - classification to attach
        Returns:
        new object
      • getEnumElement

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.EnumElementDef getEnumElement​(java.lang.String enumTypeName,
                                                                                                                                                    int ordinal)
        Extract the enum value definition based on the ordinal.
        Parameters:
        enumTypeName - name of the enum type
        ordinal - ordinal number for the enum value
        Returns:
        enum element def or its default value