org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector.mapping.attributes

Class AttributeMapping

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector.mapping.attributes.AttributeMapping

Direct Known Subclasses:

EnumMapping

public abstract class AttributeMapping
extends Object

The base class for all mappings between OMRS AttributeTypeDefs and IGC properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AttributeMapping.IGCPropertyType

Constructor Summary

Constructors

Constructor and Description
AttributeMapping(AttributeMapping.IGCPropertyType igcPropertyType, String omrsAttributeTypeDefName)
AttributeMapping(String igcAssetType, String igcPropertyName, AttributeMapping.IGCPropertyType igcPropertyType, String omrsAttributeTypeDefName)

Method Summary

Modifier and Type	Method and Description
static InstanceProperties	addPrimitivePropertyToInstance(OMRSRepositoryHelper omrsRepositoryHelper, String sourceName, InstanceProperties properties, TypeDefAttribute property, Object propertyValue, String methodName) Add the supplied property to an instance properties object.
String	getIgcAssetType() Retrieve the IGC asset type to which this attribute mapping applies.
AttributeMapping.IGCPropertyType	getIgcPropertyType() Retrieve the IGC property type for this attribute mapping.
String	getOmrsAttributeTypeDefName() Retrieve the OMRS AttributeTypeDef name for this attribute mapping applies.
boolean	isForGeneralAttribute() Indicates whether this mapping is for a general attribute (true) or a specific attribute (false).
boolean	isForSpecificAttribute() Indicates whether this mapping is for a specific attribute (true) or a general attribute (false).
boolean	matchesProperty(String igcAssetType, String igcPropertyName) Indicates whether this attribute mapping can be applied to the provided IGC property (for the provided IGC asset type) (true) or not (false).

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeMapping

public AttributeMapping(AttributeMapping.IGCPropertyType igcPropertyType,
                        String omrsAttributeTypeDefName)

AttributeMapping

public AttributeMapping(String igcAssetType,
                        String igcPropertyName,
                        AttributeMapping.IGCPropertyType igcPropertyType,
                        String omrsAttributeTypeDefName)

Method Detail

isForGeneralAttribute

public boolean isForGeneralAttribute()

Indicates whether this mapping is for a general attribute (true) or a specific attribute (false).

Returns:

boolean

isForSpecificAttribute

public boolean isForSpecificAttribute()

Indicates whether this mapping is for a specific attribute (true) or a general attribute (false).

Returns:

boolean

getIgcAssetType

public String getIgcAssetType()

Retrieve the IGC asset type to which this attribute mapping applies. Note that this will only return a non-null value when the attribute mapping is for a specific attribute.

Returns:

String

See Also:

isForSpecificAttribute()

getOmrsAttributeTypeDefName

public String getOmrsAttributeTypeDefName()

Retrieve the OMRS AttributeTypeDef name for this attribute mapping applies.

Returns:

String

getIgcPropertyType

public AttributeMapping.IGCPropertyType getIgcPropertyType()

Retrieve the IGC property type for this attribute mapping.

Returns:

IGCPropertyType

matchesProperty

public boolean matchesProperty(String igcAssetType,
                               String igcPropertyName)

Indicates whether this attribute mapping can be applied to the provided IGC property (for the provided IGC asset type) (true) or not (false).

Parameters:

igcAssetType - name of the IGC asset type

igcPropertyName - name of the IGC property on that asset type

Returns:

boolean

addPrimitivePropertyToInstance

public static InstanceProperties addPrimitivePropertyToInstance(OMRSRepositoryHelper omrsRepositoryHelper,
                                                                String sourceName,
                                                                InstanceProperties properties,
                                                                TypeDefAttribute property,
                                                                Object 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:

omrsRepositoryHelper - the OMRS repository helper

sourceName - name of caller

properties - properties object to add property to may be null.

property - the property

propertyValue - value of property

methodName - calling method name

Returns:

instance properties object.