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

Class OMRSRepositoryPropertiesUtilities

java.lang.Object

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

All Implemented Interfaces:

OMRSRepositoryPropertiesHelper

public class OMRSRepositoryPropertiesUtilities
extends Object
implements OMRSRepositoryPropertiesHelper

OMRSRepositoryPropertiesUtilities implements the methods to add and remove values from InstanceProperties objects as defined by the OMRSRepositoryPropertiesHelper interface.

Constructor Summary

Constructors

Constructor and Description
OMRSRepositoryPropertiesUtilities()

Method Summary

Modifier and Type	Method and Description
InstanceProperties	addBooleanPropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, boolean propertyValue, String methodName) Add the supplied property to an instance properties object.
InstanceProperties	addDatePropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, Date propertyValue, String methodName) Add the supplied property to an instance properties object.
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.
InstanceProperties	addFloatPropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, float propertyValue, String methodName) Add the supplied property to an instance properties object.
InstanceProperties	addIntPropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, int propertyValue, String methodName) Add the supplied property to an instance properties object.
InstanceProperties	addLongPropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, long propertyValue, String methodName) Add the supplied property to an instance properties object.
InstanceProperties	addMapPropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, Map<String,Object> mapValues, String methodName) Add the supplied map property to an instance properties object.
InstanceProperties	addPropertyMapToInstance(String sourceName, InstanceProperties properties, Map<String,Object> mapValues, String methodName) Add the supplied property map to an instance properties object.
InstanceProperties	addStringArrayPropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, List<String> arrayValues, String methodName) Add the supplied array property to an instance properties object.
InstanceProperties	addStringMapPropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, Map<String,String> mapValues, String methodName) Add the supplied map property to an instance properties object.
InstanceProperties	addStringPropertyMapToInstance(String sourceName, InstanceProperties properties, String propertyName, Map<String,String> mapValues, String methodName) Add the supplied property map to an instance properties object.
InstanceProperties	addStringPropertyToInstance(String sourceName, InstanceProperties properties, String propertyName, String propertyValue, String methodName) Add the supplied property to an instance properties object.
TypeDef	applyPatch(String sourceName, TypeDef originalTypeDef, TypeDefPatch typeDefPatch, String methodName) Returns an updated TypeDef that has had the supplied patch applied.
boolean	getBooleanProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or false if property is not found.
Date	getDateProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or null if property is not found.
List<String>	getInstancePropertiesAsArray(InstanceProperties instanceProperties, String callingMethodName) Convert the values in the instance properties into a String Array.
Map<String,Object>	getInstancePropertiesAsMap(InstanceProperties instanceProperties) Convert an instance properties object into a map.
int	getIntProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or 0 if property is not found.
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.
InstanceProperties	getMapProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or null if property is not found.
List<String>	getStringArrayProperty(String sourceName, String propertyName, InstanceProperties properties, String callingMethodName) Locates and extracts a string array property and extracts its values.
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.
String	getStringProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or null if property is not found.
boolean	removeBooleanProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or false if property is not found.
Date	removeDateProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or null if property is not found.
int	removeIntProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or 0 if property is not found.
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.
protected void	removeProperty(String propertyName, InstanceProperties properties) Remove the named property from the instance properties object.
List<String>	removeStringArrayProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Locates and extracts a string array property and extracts its values.
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.
String	removeStringProperty(String sourceName, String propertyName, InstanceProperties properties, String methodName) Return the requested property or null if property is not found.
void	validateTypeDefPatch(String sourceName, TypeDefPatch typeDefPatch, String methodName) Verify that a TypeDefPatch is not null and is for a recognized type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OMRSRepositoryPropertiesUtilities

public OMRSRepositoryPropertiesUtilities()

Method Detail

removeProperty

protected void removeProperty(String propertyName,
                              InstanceProperties properties)

Remove the named property from the instance properties object.

Parameters:

propertyName - name of property to remove

properties - instance properties object to work on

getStringProperty

public 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

Specified by:

getStringProperty in interface OMRSRepositoryPropertiesHelper

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

public 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.

Specified by:

removeStringProperty in interface OMRSRepositoryPropertiesHelper

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

getMapProperty

public 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 not a map property then a logic exception is thrown

Specified by:

getMapProperty in interface OMRSRepositoryPropertiesHelper

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

getStringArrayProperty

public List<String> getStringArrayProperty(String sourceName,
                                           String propertyName,
                                           InstanceProperties properties,
                                           String callingMethodName)

Locates and extracts a string array property and extracts its values.

Specified by:

getStringArrayProperty in interface OMRSRepositoryPropertiesHelper

Parameters:

sourceName - source of call

propertyName - name of requested map property

properties - all of the properties of the instance

callingMethodName - method of caller

Returns:

array property value or null

removeStringArrayProperty

public 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.

Specified by:

removeStringArrayProperty in interface OMRSRepositoryPropertiesHelper

Parameters:

sourceName - source of call

propertyName - name of requested map property

properties - all of the properties of the instance

methodName - method of caller

Returns:

array property value or null

getInstancePropertiesAsArray

public List<String> getInstancePropertiesAsArray(InstanceProperties instanceProperties,
                                                 String callingMethodName)

Convert the values in the instance properties into a String Array. It assumes all of the elements are primitives.

Parameters:

instanceProperties - instance properties containing the values. They should all be primitive Strings.

callingMethodName - method of caller

Returns:

list of strings

getStringMapFromProperty

public 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.

Specified by:

getStringMapFromProperty in interface OMRSRepositoryPropertiesHelper

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

public 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.

Specified by:

removeStringMapFromProperty in interface OMRSRepositoryPropertiesHelper

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

public 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.

Specified by:

getMapFromProperty in interface OMRSRepositoryPropertiesHelper

Parameters:

sourceName - source of call

propertyName - name of requested map property

properties - all of the properties of the instance

methodName - method of caller

Returns:

map property value or null

removeMapFromProperty

public 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.

Specified by:

removeMapFromProperty in interface OMRSRepositoryPropertiesHelper

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

public Map<String,Object> getInstancePropertiesAsMap(InstanceProperties instanceProperties)

Convert an instance properties object into a map.

Specified by:

getInstancePropertiesAsMap in interface OMRSRepositoryPropertiesHelper

Parameters:

instanceProperties - packed properties

Returns:

properties stored in Java map

getIntProperty

public 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.

Specified by:

getIntProperty in interface OMRSRepositoryPropertiesHelper

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

public 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.

Specified by:

removeIntProperty in interface OMRSRepositoryPropertiesHelper

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

public 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.

Specified by:

getDateProperty in interface OMRSRepositoryPropertiesHelper

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

public 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.

Specified by:

removeDateProperty in interface OMRSRepositoryPropertiesHelper

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

public 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

Specified by:

getBooleanProperty in interface OMRSRepositoryPropertiesHelper

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

public 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.

Specified by:

removeBooleanProperty in interface OMRSRepositoryPropertiesHelper

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

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

Specified by:

addStringPropertyToInstance in interface OMRSRepositoryPropertiesHelper

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

public 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.

Specified by:

addIntPropertyToInstance in interface OMRSRepositoryPropertiesHelper

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

public 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.

Specified by:

addLongPropertyToInstance in interface OMRSRepositoryPropertiesHelper

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

public 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.

Specified by:

addFloatPropertyToInstance in interface OMRSRepositoryPropertiesHelper

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

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

Specified by:

addDatePropertyToInstance in interface OMRSRepositoryPropertiesHelper

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

public 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.

Specified by:

addBooleanPropertyToInstance in interface OMRSRepositoryPropertiesHelper

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

public 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.

Specified by:

addEnumPropertyToInstance in interface OMRSRepositoryPropertiesHelper

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

public InstanceProperties addStringArrayPropertyToInstance(String sourceName,
                                                           InstanceProperties properties,
                                                           String propertyName,
                                                           List<String> arrayValues,
                                                           String methodName)

Add the supplied array property 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.

Specified by:

addStringArrayPropertyToInstance in interface OMRSRepositoryPropertiesHelper

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

public 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.

Specified by:

addMapPropertyToInstance in interface OMRSRepositoryPropertiesHelper

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

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

Specified by:

addStringMapPropertyToInstance in interface OMRSRepositoryPropertiesHelper

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

public InstanceProperties addPropertyMapToInstance(String sourceName,
                                                   InstanceProperties properties,
                                                   Map<String,Object> 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. If the instance properties object supplied is null, a new instance properties object is created.

Specified by:

addPropertyMapToInstance in interface OMRSRepositoryPropertiesHelper

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.

addStringPropertyMapToInstance

public 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. If the instance properties object supplied is null, a new instance properties object is created.

Specified by:

addStringPropertyMapToInstance in interface OMRSRepositoryPropertiesHelper

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.

validateTypeDefPatch

public void validateTypeDefPatch(String sourceName,
                                 TypeDefPatch typeDefPatch,
                                 String methodName)
                          throws InvalidParameterException,
                                 PatchErrorException

Verify that a TypeDefPatch is not null and is for a recognized type.

Parameters:

sourceName - source of the request (used for logging)

typeDefPatch - typeDefPatch to test

methodName - calling method

Throws:

InvalidParameterException - the original typeDef or typeDefPatch is null

PatchErrorException - the typeDefPatch is invalid

applyPatch

public TypeDef applyPatch(String sourceName,
                          TypeDef originalTypeDef,
                          TypeDefPatch typeDefPatch,
                          String methodName)
                   throws InvalidParameterException,
                          PatchErrorException

Returns an updated TypeDef that has had the supplied patch applied. It throws an exception if any part of the patch is incompatible with the original TypeDef. For example, if there is a mismatch between the type or version that either represents.

Parameters:

sourceName - source of the TypeDef (used for logging)

originalTypeDef - typeDef to update

typeDefPatch - patch to apply

methodName - calling method

Returns:

updated TypeDef

Throws:

InvalidParameterException - the original typeDef or typeDefPatch is null

PatchErrorException - the patch is either badly formatted, or does not apply to the supplied TypeDef