Package org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.utilities

Interface OMRSRepositoryPropertiesHelper

  • All Known Subinterfaces:
    OMRSRepositoryHelper
    All Known Implementing Classes:
    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 Detail

      • getStringProperty

        String getStringProperty​(String sourceName,
                         String propertyName,
                         InstanceProperties properties,
                         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

        String removeStringProperty​(String sourceName,
                            String propertyName,
                            InstanceProperties properties,
                            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​(String sourceName,
                           String propertyName,
                           InstanceProperties properties,
                           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​(String sourceName,
                              String propertyName,
                              InstanceProperties properties,
                              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

        InstanceProperties getMapProperty​(String sourceName,
                                  String propertyName,
                                  InstanceProperties properties,
                                  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

        Map<String,​String> getStringMapFromProperty​(String sourceName,
                                                  String propertyName,
                                                  InstanceProperties properties,
                                                  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

        Map<String,​String> removeStringMapFromProperty​(String sourceName,
                                                     String propertyName,
                                                     InstanceProperties properties,
                                                     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

        Map<String,​Boolean> getBooleanMapFromProperty​(String sourceName,
                                                    String propertyName,
                                                    InstanceProperties properties,
                                                    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

        Map<String,​Boolean> removeBooleanMapFromProperty​(String sourceName,
                                                       String propertyName,
                                                       InstanceProperties properties,
                                                       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

        Map<String,​Long> getLongMapFromProperty​(String sourceName,
                                              String propertyName,
                                              InstanceProperties properties,
                                              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

        Map<String,​Long> removeLongMapFromProperty​(String sourceName,
                                                 String propertyName,
                                                 InstanceProperties properties,
                                                 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

        Map<String,​Integer> getIntegerMapFromProperty​(String sourceName,
                                                    String propertyName,
                                                    InstanceProperties properties,
                                                    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

        Map<String,​Integer> removeIntegerMapFromProperty​(String sourceName,
                                                       String propertyName,
                                                       InstanceProperties properties,
                                                       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

        Map<String,​Object> getMapFromProperty​(String sourceName,
                                            String propertyName,
                                            InstanceProperties properties,
                                            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

        Map<String,​Object> removeMapFromProperty​(String sourceName,
                                               String propertyName,
                                               InstanceProperties properties,
                                               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

        Map<String,​Object> getInstancePropertiesAsMap​(InstanceProperties instanceProperties)
        Convert an instance properties object into a map.
        Parameters:
        instanceProperties - packed properties
        Returns:
        properties stored in Java map

      • getStringArrayProperty

        List<String> getStringArrayProperty​(String sourceName,
                                    String propertyName,
                                    InstanceProperties properties,
                                    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

        List<String> removeStringArrayProperty​(String sourceName,
                                       String propertyName,
                                       InstanceProperties properties,
                                       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​(String sourceName,
                   String propertyName,
                   InstanceProperties properties,
                   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​(String sourceName,
                      String propertyName,
                      InstanceProperties properties,
                      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

        Date getDateProperty​(String sourceName,
                     String propertyName,
                     InstanceProperties properties,
                     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

        Date removeDateProperty​(String sourceName,
                        String propertyName,
                        InstanceProperties properties,
                        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​(String sourceName,
                           String propertyName,
                           InstanceProperties properties,
                           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​(String sourceName,
                              String propertyName,
                              InstanceProperties properties,
                              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

        InstanceProperties addStringPropertyToInstance​(String sourceName,
                                               InstanceProperties properties,
                                               String propertyName,
                                               String propertyValue,
                                               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

        InstanceProperties addIntPropertyToInstance​(String sourceName,
                                            InstanceProperties properties,
                                            String propertyName,
                                            int propertyValue,
                                            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

        InstanceProperties addLongPropertyToInstance​(String sourceName,
                                             InstanceProperties properties,
                                             String propertyName,
                                             long propertyValue,
                                             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

        InstanceProperties addFloatPropertyToInstance​(String sourceName,
                                              InstanceProperties properties,
                                              String propertyName,
                                              float propertyValue,
                                              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

        InstanceProperties addDatePropertyToInstance​(String sourceName,
                                             InstanceProperties properties,
                                             String propertyName,
                                             Date propertyValue,
                                             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

        InstanceProperties addBooleanPropertyToInstance​(String sourceName,
                                                InstanceProperties properties,
                                                String propertyName,
                                                boolean propertyValue,
                                                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

        InstanceProperties addEnumPropertyToInstance​(String sourceName,
                                             InstanceProperties properties,
                                             String propertyName,
                                             int ordinal,
                                             String symbolicName,
                                             String description,
                                             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

        InstanceProperties addStringArrayPropertyToInstance​(String sourceName,
                                                    InstanceProperties properties,
                                                    String propertyName,
                                                    List<String> arrayValues,
                                                    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

        InstanceProperties addMapPropertyToInstance​(String sourceName,
                                            InstanceProperties properties,
                                            String propertyName,
                                            Map<String,​Object> mapValues,
                                            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

        InstanceProperties addStringMapPropertyToInstance​(String sourceName,
                                                  InstanceProperties properties,
                                                  String propertyName,
                                                  Map<String,​String> mapValues,
                                                  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

        InstanceProperties addBooleanMapPropertyToInstance​(String sourceName,
                                                   InstanceProperties properties,
                                                   String propertyName,
                                                   Map<String,​Boolean> mapValues,
                                                   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

        InstanceProperties addLongMapPropertyToInstance​(String sourceName,
                                                InstanceProperties properties,
                                                String propertyName,
                                                Map<String,​Long> mapValues,
                                                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

        InstanceProperties addIntMapPropertyToInstance​(String sourceName,
                                               InstanceProperties properties,
                                               String propertyName,
                                               Map<String,​Integer> mapValues,
                                               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

        InstanceProperties addPropertyMapToInstance​(String sourceName,
                                            InstanceProperties properties,
                                            Map<String,​Object> mapValues,
                                            String methodName)
                                     throws 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:
        InvalidParameterException - invalid property value

      • addStringPropertyMapToInstance

        InstanceProperties addStringPropertyMapToInstance​(String sourceName,
                                                  InstanceProperties properties,
                                                  String propertyName,
                                                  Map<String,​String> mapValues,
                                                  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

        InstanceProperties addBooleanPropertyMapToInstance​(String sourceName,
                                                   InstanceProperties properties,
                                                   String propertyName,
                                                   Map<String,​Boolean> mapValues,
                                                   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

        InstanceProperties addLongPropertyMapToInstance​(String sourceName,
                                                InstanceProperties properties,
                                                String propertyName,
                                                Map<String,​Long> mapValues,
                                                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

        InstanceProperties addIntPropertyMapToInstance​(String sourceName,
                                               InstanceProperties properties,
                                               String propertyName,
                                               Map<String,​Integer> mapValues,
                                               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

        SearchProperties getSearchPropertiesFromInstanceProperties​(String sourceName,
                                                           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.