Interface OMRSRepositoryPropertiesHelper

  • All Known Subinterfaces:
    OMRSRepositoryHelper
    All Known Implementing Classes:
    OMRSArchiveHelper, OMRSRepositoryPropertiesUtilities

    public interface OMRSRepositoryPropertiesHelper
    OMRSRepositoryHelper provides methods to repository connectors and repository event mappers to help them build valid type definitions (TypeDefs), entities and relationships. It is a facade to the repository content manager which holds an in memory cache of all the active TypeDefs in the local server. OMRSRepositoryHelper's purpose is to create an object that the repository connectors and event mappers can create, use and discard without needing to know how to connect to the repository content manager.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addBooleanMapPropertyToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, java.util.Map<java.lang.String,​java.lang.Boolean> mapValues, java.lang.String methodName)
      If the supplied map property is not null, add it to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addBooleanPropertyMapToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, java.util.Map<java.lang.String,​java.lang.Boolean> mapValues, java.lang.String methodName)
      Add the supplied property map to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addBooleanPropertyToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, boolean propertyValue, java.lang.String methodName)
      Add the supplied property to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addDatePropertyToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, java.util.Date propertyValue, java.lang.String methodName)
      If the supplied property is not null, add it to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addEnumPropertyToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, int ordinal, java.lang.String symbolicName, java.lang.String description, java.lang.String methodName)
      Add the supplied property to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addFloatPropertyToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, float propertyValue, java.lang.String methodName)
      Add the supplied property to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addIntMapPropertyToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, java.util.Map<java.lang.String,​java.lang.Integer> mapValues, java.lang.String methodName)
      If the supplied map property is not null, add it to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addIntPropertyMapToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, java.util.Map<java.lang.String,​java.lang.Integer> mapValues, java.lang.String methodName)
      Add the supplied property map to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addIntPropertyToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, int propertyValue, java.lang.String methodName)
      Add the supplied property to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addLongMapPropertyToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, java.util.Map<java.lang.String,​java.lang.Long> mapValues, java.lang.String methodName)
      If the supplied map property is not null, add it to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addLongPropertyMapToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, java.util.Map<java.lang.String,​java.lang.Long> mapValues, java.lang.String methodName)
      Add the supplied property map to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addLongPropertyToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, long propertyValue, java.lang.String methodName)
      Add the supplied property to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addMapPropertyToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, java.util.Map<java.lang.String,​java.lang.Object> mapValues, java.lang.String methodName)
      Add the supplied map property to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addPropertyMapToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.util.Map<java.lang.String,​java.lang.Object> mapValues, java.lang.String methodName)
      Add the supplied property map to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addStringArrayPropertyToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, java.util.List<java.lang.String> arrayValues, java.lang.String methodName)
      If the supplied array property is not null, add it to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addStringMapPropertyToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, java.util.Map<java.lang.String,​java.lang.String> mapValues, java.lang.String methodName)
      If the supplied map property is not null, add it to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addStringPropertyMapToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, java.util.Map<java.lang.String,​java.lang.String> mapValues, java.lang.String methodName)
      Add the supplied property map to an instance properties object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addStringPropertyToInstance​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String propertyName, java.lang.String propertyValue, java.lang.String methodName)
      If the supplied property is not null, add it to an instance properties object.
      java.util.Map<java.lang.String,​java.lang.Boolean> getBooleanMapFromProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Locates and extracts a property from an instance that is of type map and then converts its values into a Java map.
      boolean getBooleanProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Return the requested property or false if property is not found.
      java.util.Date getDateProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Return the requested property or null if property is not found.
      int getEnumPropertyOrdinal​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Retrieve the ordinal value from an enum property.
      java.util.Map<java.lang.String,​java.lang.Object> getInstancePropertiesAsMap​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
      Convert an instance properties object into a map.
      java.util.Map<java.lang.String,​java.lang.Integer> getIntegerMapFromProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Locates and extracts a property from an instance that is of type map and then converts its values into a Java map.
      int getIntProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Return the requested property or 0 if property is not found.
      java.util.Map<java.lang.String,​java.lang.Long> getLongMapFromProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Locates and extracts a property from an instance that is of type map and then converts its values into a Java map.
      java.util.Map<java.lang.String,​java.lang.Object> getMapFromProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Locates and extracts a property from an instance that is of type map and then converts its values into a Java map.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties getMapProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Return the requested property or null if property is not found.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchProperties getSearchPropertiesFromInstanceProperties​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, MatchCriteria matchCriteria)
      Convert the provided instance properties and match criteria into an equivalent SearchProperties object.
      java.util.List<java.lang.String> getStringArrayProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Locates and extracts a string array property and extracts its values.
      java.util.Map<java.lang.String,​java.lang.String> getStringMapFromProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Locates and extracts a property from an instance that is of type map and then converts its values into a Java map.
      java.lang.String getStringProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Return the requested property or null if property is not found.
      java.util.Map<java.lang.String,​java.lang.Boolean> removeBooleanMapFromProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Locates and extracts a property from an instance that is of type map and then converts its values into a Java map.
      boolean removeBooleanProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Return the requested property or false if property is not found.
      java.util.Date removeDateProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Return the requested property or null if property is not found.
      int removeEnumPropertyOrdinal​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Retrieve the ordinal value from an enum property and then delete it from the properties
      java.util.Map<java.lang.String,​java.lang.Integer> removeIntegerMapFromProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Locates and extracts a property from an instance that is of type map and then converts its values into a Java map.
      int removeIntProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Return the requested property or 0 if property is not found.
      java.util.Map<java.lang.String,​java.lang.Long> removeLongMapFromProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Locates and extracts a property from an instance that is of type map and then converts its values into a Java map.
      java.util.Map<java.lang.String,​java.lang.Object> removeMapFromProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Locates and extracts a property from an instance that is of type map and then converts its values into a Java map.
      java.util.List<java.lang.String> removeStringArrayProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Locates and extracts a string array property and extracts its values.
      java.util.Map<java.lang.String,​java.lang.String> removeStringMapFromProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Locates and extracts a property from an instance that is of type map and then converts its values into a Java map.
      java.lang.String removeStringProperty​(java.lang.String sourceName, java.lang.String propertyName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Return the requested property or null if property is not found.
    • Method Detail

      • getStringProperty

        java.lang.String getStringProperty​(java.lang.String sourceName,
                                           java.lang.String propertyName,
                                           org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                           java.lang.String methodName)
        Return the requested property or null if property is not found. If the property is not a string property then a logic exception is thrown
        Parameters:
        sourceName - source of call
        propertyName - name of requested property
        properties - properties from the instance.
        methodName - method of caller
        Returns:
        string property value or null
      • removeStringProperty

        java.lang.String removeStringProperty​(java.lang.String sourceName,
                                              java.lang.String propertyName,
                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                              java.lang.String methodName)
        Return the requested property or null if property is not found. If the property is found, it is removed from the InstanceProperties structure. If the property is not a string property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested property
        properties - properties from the instance.
        methodName - method of caller
        Returns:
        string property value or null
      • getEnumPropertyOrdinal

        int getEnumPropertyOrdinal​(java.lang.String sourceName,
                                   java.lang.String propertyName,
                                   org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                   java.lang.String methodName)
        Retrieve the ordinal value from an enum property.
        Parameters:
        sourceName - source of call
        propertyName - name of requested property
        properties - properties from the instance.
        methodName - method of caller
        Returns:
        int ordinal or -1 if not found
      • removeEnumPropertyOrdinal

        int removeEnumPropertyOrdinal​(java.lang.String sourceName,
                                      java.lang.String propertyName,
                                      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                      java.lang.String methodName)
        Retrieve the ordinal value from an enum property and then delete it from the properties
        Parameters:
        sourceName - source of call
        propertyName - name of requested property
        properties - properties from the instance.
        methodName - method of caller
        Returns:
        int ordinal or -1 if not found
      • getMapProperty

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties getMapProperty​(java.lang.String sourceName,
                                                                                                                                                  java.lang.String propertyName,
                                                                                                                                                  org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                  java.lang.String methodName)
        Return the requested property or null if property is not found. If the property is found, it is removed from the InstanceProperties structure. If the property is not a map property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested property
        properties - properties from the instance.
        methodName - method of caller
        Returns:
        string property value or null
      • getStringMapFromProperty

        java.util.Map<java.lang.String,​java.lang.String> getStringMapFromProperty​(java.lang.String sourceName,
                                                                                        java.lang.String propertyName,
                                                                                        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                        java.lang.String methodName)
        Locates and extracts a property from an instance that is of type map and then converts its values into a Java map. If the property is not a map property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested map property
        properties - values of the property
        methodName - method of caller
        Returns:
        map property value or null
      • removeStringMapFromProperty

        java.util.Map<java.lang.String,​java.lang.String> removeStringMapFromProperty​(java.lang.String sourceName,
                                                                                           java.lang.String propertyName,
                                                                                           org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                           java.lang.String methodName)
        Locates and extracts a property from an instance that is of type map and then converts its values into a Java map. If the property is found, it is removed from the InstanceProperties structure. If the property is not a map property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested map property
        properties - values of the property
        methodName - method of caller
        Returns:
        map property value or null
      • getBooleanMapFromProperty

        java.util.Map<java.lang.String,​java.lang.Boolean> getBooleanMapFromProperty​(java.lang.String sourceName,
                                                                                          java.lang.String propertyName,
                                                                                          org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                          java.lang.String methodName)
        Locates and extracts a property from an instance that is of type map and then converts its values into a Java map. If the property is not a map property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested map property
        properties - values of the property
        methodName - method of caller
        Returns:
        map property value or null
      • removeBooleanMapFromProperty

        java.util.Map<java.lang.String,​java.lang.Boolean> removeBooleanMapFromProperty​(java.lang.String sourceName,
                                                                                             java.lang.String propertyName,
                                                                                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                             java.lang.String methodName)
        Locates and extracts a property from an instance that is of type map and then converts its values into a Java map. If the property is found, it is removed from the InstanceProperties structure. If the property is not a map property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested map property
        properties - values of the property
        methodName - method of caller
        Returns:
        map property value or null
      • getLongMapFromProperty

        java.util.Map<java.lang.String,​java.lang.Long> getLongMapFromProperty​(java.lang.String sourceName,
                                                                                    java.lang.String propertyName,
                                                                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                    java.lang.String methodName)
        Locates and extracts a property from an instance that is of type map and then converts its values into a Java map. If the property is not a map property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested map property
        properties - values of the property
        methodName - method of caller
        Returns:
        map property value or null
      • removeLongMapFromProperty

        java.util.Map<java.lang.String,​java.lang.Long> removeLongMapFromProperty​(java.lang.String sourceName,
                                                                                       java.lang.String propertyName,
                                                                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                       java.lang.String methodName)
        Locates and extracts a property from an instance that is of type map and then converts its values into a Java map. If the property is found, it is removed from the InstanceProperties structure. If the property is not a map property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested map property
        properties - values of the property
        methodName - method of caller
        Returns:
        map property value or null
      • getIntegerMapFromProperty

        java.util.Map<java.lang.String,​java.lang.Integer> getIntegerMapFromProperty​(java.lang.String sourceName,
                                                                                          java.lang.String propertyName,
                                                                                          org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                          java.lang.String methodName)
        Locates and extracts a property from an instance that is of type map and then converts its values into a Java map. If the property is not a map property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested map property
        properties - values of the property
        methodName - method of caller
        Returns:
        map property value or null
      • removeIntegerMapFromProperty

        java.util.Map<java.lang.String,​java.lang.Integer> removeIntegerMapFromProperty​(java.lang.String sourceName,
                                                                                             java.lang.String propertyName,
                                                                                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                             java.lang.String methodName)
        Locates and extracts a property from an instance that is of type map and then converts its values into a Java map. If the property is found, it is removed from the InstanceProperties structure. If the property is not a map property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested map property
        properties - values of the property
        methodName - method of caller
        Returns:
        map property value or null
      • getMapFromProperty

        java.util.Map<java.lang.String,​java.lang.Object> getMapFromProperty​(java.lang.String sourceName,
                                                                                  java.lang.String propertyName,
                                                                                  org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                  java.lang.String methodName)
        Locates and extracts a property from an instance that is of type map and then converts its values into a Java map. If the property is found, it is removed from the InstanceProperties structure. If the property is not a map property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested map property
        properties - values of the property
        methodName - method of caller
        Returns:
        map property value or null
      • removeMapFromProperty

        java.util.Map<java.lang.String,​java.lang.Object> removeMapFromProperty​(java.lang.String sourceName,
                                                                                     java.lang.String propertyName,
                                                                                     org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                     java.lang.String methodName)
        Locates and extracts a property from an instance that is of type map and then converts its values into a Java map. If the property is found, it is removed from the InstanceProperties structure. If the property is not a map property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested map property
        properties - values of the property
        methodName - method of caller
        Returns:
        map property value or null
      • getInstancePropertiesAsMap

        java.util.Map<java.lang.String,​java.lang.Object> getInstancePropertiesAsMap​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
        Convert an instance properties object into a map.
        Parameters:
        instanceProperties - packed properties
        Returns:
        properties stored in Java map
      • getStringArrayProperty

        java.util.List<java.lang.String> getStringArrayProperty​(java.lang.String sourceName,
                                                                java.lang.String propertyName,
                                                                org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                java.lang.String methodName)
        Locates and extracts a string array property and extracts its values. If the property is not an array property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested map property
        properties - all the properties of the instance
        methodName - method of caller
        Returns:
        array property value or null
      • removeStringArrayProperty

        java.util.List<java.lang.String> removeStringArrayProperty​(java.lang.String sourceName,
                                                                   java.lang.String propertyName,
                                                                   org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                   java.lang.String methodName)
        Locates and extracts a string array property and extracts its values. If the property is found, it is removed from the InstanceProperties structure. If the property is not an array property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested map property
        properties - all the properties of the instance
        methodName - method of caller
        Returns:
        array property value or null
      • getIntProperty

        int getIntProperty​(java.lang.String sourceName,
                           java.lang.String propertyName,
                           org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                           java.lang.String methodName)
        Return the requested property or 0 if property is not found. If the property is not an int property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested property
        properties - properties from the instance.
        methodName - method of caller
        Returns:
        string property value or null
      • removeIntProperty

        int removeIntProperty​(java.lang.String sourceName,
                              java.lang.String propertyName,
                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                              java.lang.String methodName)
        Return the requested property or 0 if property is not found. If the property is found, it is removed from the InstanceProperties structure. If the property is not an int property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested property
        properties - properties from the instance.
        methodName - method of caller
        Returns:
        string property value or null
      • getDateProperty

        java.util.Date getDateProperty​(java.lang.String sourceName,
                                       java.lang.String propertyName,
                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                       java.lang.String methodName)
        Return the requested property or null if property is not found. If the property is not a date property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested property
        properties - properties from the instance.
        methodName - method of caller
        Returns:
        string property value or null
      • removeDateProperty

        java.util.Date removeDateProperty​(java.lang.String sourceName,
                                          java.lang.String propertyName,
                                          org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                          java.lang.String methodName)
        Return the requested property or null if property is not found. If the property is found, it is removed from the InstanceProperties structure. If the property is not a date property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested property
        properties - properties from the instance.
        methodName - method of caller
        Returns:
        string property value or null
      • getBooleanProperty

        boolean getBooleanProperty​(java.lang.String sourceName,
                                   java.lang.String propertyName,
                                   org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                   java.lang.String methodName)
        Return the requested property or false if property is not found. If the property is not a boolean property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested property
        properties - properties from the instance.
        methodName - method of caller
        Returns:
        string property value or null
      • removeBooleanProperty

        boolean removeBooleanProperty​(java.lang.String sourceName,
                                      java.lang.String propertyName,
                                      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                      java.lang.String methodName)
        Return the requested property or false if property is not found. If the property is found, it is removed from the InstanceProperties structure. If the property is not a boolean property then a logic exception is thrown.
        Parameters:
        sourceName - source of call
        propertyName - name of requested property
        properties - properties from the instance.
        methodName - method of caller
        Returns:
        string property value or null
      • addStringPropertyToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addStringPropertyToInstance​(java.lang.String sourceName,
                                                                                                                                                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                               java.lang.String propertyName,
                                                                                                                                                               java.lang.String propertyValue,
                                                                                                                                                               java.lang.String methodName)
        If the supplied property is not null, add it to an instance properties object. If the instance property object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to may be null.
        propertyName - name of property
        propertyValue - value of property
        methodName - calling method name
        Returns:
        instance properties object.
      • addIntPropertyToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addIntPropertyToInstance​(java.lang.String sourceName,
                                                                                                                                                            org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                            java.lang.String propertyName,
                                                                                                                                                            int propertyValue,
                                                                                                                                                            java.lang.String methodName)
        Add the supplied property to an instance properties object. If the instance property object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to may be null.
        propertyName - name of property
        propertyValue - value of property
        methodName - calling method name
        Returns:
        instance properties object.
      • addLongPropertyToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addLongPropertyToInstance​(java.lang.String sourceName,
                                                                                                                                                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                             java.lang.String propertyName,
                                                                                                                                                             long propertyValue,
                                                                                                                                                             java.lang.String methodName)
        Add the supplied property to an instance properties object. If the instance property object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to may be null.
        propertyName - name of property
        propertyValue - value of property
        methodName - calling method name
        Returns:
        instance properties object.
      • addFloatPropertyToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addFloatPropertyToInstance​(java.lang.String sourceName,
                                                                                                                                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                              java.lang.String propertyName,
                                                                                                                                                              float propertyValue,
                                                                                                                                                              java.lang.String methodName)
        Add the supplied property to an instance properties object. If the instance property object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to may be null.
        propertyName - name of property
        propertyValue - value of property
        methodName - calling method name
        Returns:
        instance properties object.
      • addDatePropertyToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addDatePropertyToInstance​(java.lang.String sourceName,
                                                                                                                                                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                             java.lang.String propertyName,
                                                                                                                                                             java.util.Date propertyValue,
                                                                                                                                                             java.lang.String methodName)
        If the supplied property is not null, add it to an instance properties object. If the instance property object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to may be null.
        propertyName - name of property
        propertyValue - value of property
        methodName - calling method name
        Returns:
        instance properties object.
      • addBooleanPropertyToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addBooleanPropertyToInstance​(java.lang.String sourceName,
                                                                                                                                                                org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                                java.lang.String propertyName,
                                                                                                                                                                boolean propertyValue,
                                                                                                                                                                java.lang.String methodName)
        Add the supplied property to an instance properties object. If the instance property object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to may be null.
        propertyName - name of property
        propertyValue - value of property
        methodName - calling method name
        Returns:
        instance properties object.
      • addEnumPropertyToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addEnumPropertyToInstance​(java.lang.String sourceName,
                                                                                                                                                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                             java.lang.String propertyName,
                                                                                                                                                             int ordinal,
                                                                                                                                                             java.lang.String symbolicName,
                                                                                                                                                             java.lang.String description,
                                                                                                                                                             java.lang.String methodName)
        Add the supplied property to an instance properties object. If the instance property object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to may be null.
        propertyName - name of property
        ordinal - numeric value of property
        symbolicName - String value of property
        description - String description of property value
        methodName - calling method name
        Returns:
        instance properties object.
      • addStringArrayPropertyToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addStringArrayPropertyToInstance​(java.lang.String sourceName,
                                                                                                                                                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                                    java.lang.String propertyName,
                                                                                                                                                                    java.util.List<java.lang.String> arrayValues,
                                                                                                                                                                    java.lang.String methodName)
        If the supplied array property is not null, add it to an instance properties object. The supplied array is stored as a single property in the instances properties. If the instance properties object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to, may be null.
        propertyName - name of property
        arrayValues - contents of the array
        methodName - calling method name
        Returns:
        instance properties object.
      • addMapPropertyToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addMapPropertyToInstance​(java.lang.String sourceName,
                                                                                                                                                            org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                            java.lang.String propertyName,
                                                                                                                                                            java.util.Map<java.lang.String,​java.lang.Object> mapValues,
                                                                                                                                                            java.lang.String methodName)
        Add the supplied map property to an instance properties object. The supplied map is stored as a single property in the instances properties. If the instance properties object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to, may be null.
        propertyName - name of property
        mapValues - contents of the map
        methodName - calling method name
        Returns:
        instance properties object.
      • addStringMapPropertyToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addStringMapPropertyToInstance​(java.lang.String sourceName,
                                                                                                                                                                  org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                                  java.lang.String propertyName,
                                                                                                                                                                  java.util.Map<java.lang.String,​java.lang.String> mapValues,
                                                                                                                                                                  java.lang.String methodName)
        If the supplied map property is not null, add it to an instance properties object. The supplied map is stored as a single property in the instances properties. If the instance properties object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to, may be null.
        propertyName - name of property
        mapValues - contents of the map
        methodName - calling method name
        Returns:
        instance properties object.
      • addBooleanMapPropertyToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addBooleanMapPropertyToInstance​(java.lang.String sourceName,
                                                                                                                                                                   org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                                   java.lang.String propertyName,
                                                                                                                                                                   java.util.Map<java.lang.String,​java.lang.Boolean> mapValues,
                                                                                                                                                                   java.lang.String methodName)
        If the supplied map property is not null, add it to an instance properties object. The supplied map is stored as a single property in the instances properties. If the instance properties object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to, may be null.
        propertyName - name of property
        mapValues - contents of the map
        methodName - calling method name
        Returns:
        instance properties object.
      • addLongMapPropertyToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addLongMapPropertyToInstance​(java.lang.String sourceName,
                                                                                                                                                                org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                                java.lang.String propertyName,
                                                                                                                                                                java.util.Map<java.lang.String,​java.lang.Long> mapValues,
                                                                                                                                                                java.lang.String methodName)
        If the supplied map property is not null, add it to an instance properties object. The supplied map is stored as a single property in the instances properties. If the instance properties object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to, may be null.
        propertyName - name of property
        mapValues - contents of the map
        methodName - calling method name
        Returns:
        instance properties object.
      • addIntMapPropertyToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addIntMapPropertyToInstance​(java.lang.String sourceName,
                                                                                                                                                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                               java.lang.String propertyName,
                                                                                                                                                               java.util.Map<java.lang.String,​java.lang.Integer> mapValues,
                                                                                                                                                               java.lang.String methodName)
        If the supplied map property is not null, add it to an instance properties object. The supplied map is stored as a single property in the instances properties. If the instance properties object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to, may be null.
        propertyName - name of property
        mapValues - contents of the map
        methodName - calling method name
        Returns:
        instance properties object.
      • addPropertyMapToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addPropertyMapToInstance​(java.lang.String sourceName,
                                                                                                                                                            org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                            java.util.Map<java.lang.String,​java.lang.Object> mapValues,
                                                                                                                                                            java.lang.String methodName)
                                                                                                                                                     throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Add the supplied property map to an instance properties object. Each of the entries in the map is added as a separate property in instance properties unless it is null. If the instance properties object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to, may be null.
        mapValues - contents of the map
        methodName - calling method name
        Returns:
        instance properties object.
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - invalid property value
      • addStringPropertyMapToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addStringPropertyMapToInstance​(java.lang.String sourceName,
                                                                                                                                                                  org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                                  java.lang.String propertyName,
                                                                                                                                                                  java.util.Map<java.lang.String,​java.lang.String> mapValues,
                                                                                                                                                                  java.lang.String methodName)
        Add the supplied property map to an instance properties object. Each of the entries in the map is added as a separate property in instance properties unless it is null. If the instance properties object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to, may be null.
        propertyName - name of property
        mapValues - contents of the map
        methodName - calling method name
        Returns:
        instance properties object.
      • addBooleanPropertyMapToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addBooleanPropertyMapToInstance​(java.lang.String sourceName,
                                                                                                                                                                   org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                                   java.lang.String propertyName,
                                                                                                                                                                   java.util.Map<java.lang.String,​java.lang.Boolean> mapValues,
                                                                                                                                                                   java.lang.String methodName)
        Add the supplied property map to an instance properties object. Each of the entries in the map is added as a separate property in instance properties unless it is null. If the instance properties object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to, may be null.
        propertyName - name of property
        mapValues - contents of the map
        methodName - calling method name
        Returns:
        instance properties object.
      • addLongPropertyMapToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addLongPropertyMapToInstance​(java.lang.String sourceName,
                                                                                                                                                                org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                                java.lang.String propertyName,
                                                                                                                                                                java.util.Map<java.lang.String,​java.lang.Long> mapValues,
                                                                                                                                                                java.lang.String methodName)
        Add the supplied property map to an instance properties object. Each of the entries in the map is added as a separate property in instance properties unless it is null. If the instance properties object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to, may be null.
        propertyName - name of property
        mapValues - contents of the map
        methodName - calling method name
        Returns:
        instance properties object.
      • addIntPropertyMapToInstance

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties addIntPropertyMapToInstance​(java.lang.String sourceName,
                                                                                                                                                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                               java.lang.String propertyName,
                                                                                                                                                               java.util.Map<java.lang.String,​java.lang.Integer> mapValues,
                                                                                                                                                               java.lang.String methodName)
        Add the supplied property map to an instance properties object. Each of the entries in the map is added as a separate property in instance properties unless it is null. If the instance properties object supplied is null, a new instance properties object is created.
        Parameters:
        sourceName - name of caller
        properties - properties object to add property to, may be null.
        propertyName - name of property
        mapValues - contents of the map
        methodName - calling method name
        Returns:
        instance properties object.
      • getSearchPropertiesFromInstanceProperties

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchProperties getSearchPropertiesFromInstanceProperties​(java.lang.String sourceName,
                                                                                                                                                                        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                                                                                                                                        MatchCriteria matchCriteria)
        Convert the provided instance properties and match criteria into an equivalent SearchProperties object.
        Parameters:
        sourceName - name of the caller
        properties - properties object to convert
        matchCriteria - match criteria to apply
        Returns:
        SearchProperties object.