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

Class PropertyMappingSet

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector.mapping.entities.PropertyMappingSet

public class PropertyMappingSet
extends Object

Defines a set of mappings between an IGC object's properties and an OMRS entity's properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PropertyMappingSet.PropertyMapping Subclass to contain individual mappings.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPLEX_MAPPING_SENTINEL

Constructor Summary

Constructors

Constructor and Description
PropertyMappingSet()

Method Summary

Modifier and Type	Method and Description
void	addComplexIgc(String igcPropertyName) Notes the provided IGC property name requires more than a simple one-to-one mapping.
void	addComplexOmrs(String omrsPropertyName) Notes the provided OMRS property name requires more than a simple one-to-one mapping.
void	addSimpleMapping(String igcPropertyName, String omrsPropertyName) Adds a new mapping to the set of mappings.
Set<String>	getAllMappedIgcProperties() Returns the set of all IGC properties that are mapped to OMRS properties.
Set<String>	getAllMappedOmrsProperties() Returns the set of OMRS property names that are mapped to IGC properties.
Set<String>	getComplexMappedIgcProperties() Returns only the subset of mapped IGC properties that are complex mappings to OMRS properties.
Set<String>	getComplexMappedOmrsProperties() Returns only the subset of mapped OMRS properties that are complex mappings to IGC properties.
String	getIgcPropertyName(String omrsPropertyName) Retrieves the IGC property name mapped to the provided OMRS property name.
String	getOmrsPropertyName(String igcPropertyName) Retrieves the OMRS property name mapped to the provided IGC property name.
Set<String>	getSimpleMappedIgcProperties() Returns only the subset of mapped IGC properties that are simple one-to-one mappings to OMRS properties.
Set<String>	getSimpleMappedOmrsProperties() Returns only the subset of mapped OMRS properties that are simple one-to-one mappings to IGC properties.
boolean	isIgcPropertyComplexMapped(String igcPropertyName) Determines whether the provided IGC property name is complex mapped (true) or not (false).
boolean	isIgcPropertySimpleMapped(String igcPropertyName) Determines whether the provided IGC property name is simple (one-to-one) mapped (true) or not (false).
boolean	isOmrsPropertyComplexMapped(String omrsPropertyName) Determines whether the provided OMRS property name is complex mapped (true) or not (false).
boolean	isOmrsPropertySimpleMapped(String omrsPropertyName) Determines whether the provided OMRS property name is simple (one-to-one) mapped (true) or not (false).

Methods inherited from class java.lang.Object

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

Field Detail

COMPLEX_MAPPING_SENTINEL

public static final String COMPLEX_MAPPING_SENTINEL

See Also:

Constant Field Values

Constructor Detail

PropertyMappingSet

public PropertyMappingSet()

Method Detail

getSimpleMappedIgcProperties

public Set<String> getSimpleMappedIgcProperties()

Returns only the subset of mapped IGC properties that are simple one-to-one mappings to OMRS properties.

Returns:

Set<String>

getComplexMappedIgcProperties

public Set<String> getComplexMappedIgcProperties()

Returns only the subset of mapped IGC properties that are complex mappings to OMRS properties.

Returns:

Set<String>

getAllMappedIgcProperties

public Set<String> getAllMappedIgcProperties()

Returns the set of all IGC properties that are mapped to OMRS properties.

Returns:

Set<String>

getSimpleMappedOmrsProperties

public Set<String> getSimpleMappedOmrsProperties()

Returns only the subset of mapped OMRS properties that are simple one-to-one mappings to IGC properties.

Returns:

Set<String>

getComplexMappedOmrsProperties

public Set<String> getComplexMappedOmrsProperties()

Returns only the subset of mapped OMRS properties that are complex mappings to IGC properties.

Returns:

Set<String>

getAllMappedOmrsProperties

public Set<String> getAllMappedOmrsProperties()

Returns the set of OMRS property names that are mapped to IGC properties.

Returns:

Set<String>

addSimpleMapping

public void addSimpleMapping(String igcPropertyName,
                             String omrsPropertyName)

Adds a new mapping to the set of mappings.

Parameters:

igcPropertyName - the IGC property name (in REST form)

omrsPropertyName - the name of the target attribute within the OMRS entity

addComplexIgc

public void addComplexIgc(String igcPropertyName)

Notes the provided IGC property name requires more than a simple one-to-one mapping.

Parameters:

igcPropertyName - the IGC property name (in REST form)

addComplexOmrs

public void addComplexOmrs(String omrsPropertyName)

Notes the provided OMRS property name requires more than a simple one-to-one mapping.

Parameters:

omrsPropertyName - the OMRS property name

getIgcPropertyName

public String getIgcPropertyName(String omrsPropertyName)

Retrieves the IGC property name mapped to the provided OMRS property name.

Parameters:

omrsPropertyName - the OMRS property name for which to get the mapped IGC property name

Returns:

String

getOmrsPropertyName

public String getOmrsPropertyName(String igcPropertyName)

Retrieves the OMRS property name mapped to the provided IGC property name.

Parameters:

igcPropertyName - the IGC property name for which to get the mapped OMRS property name.

Returns:

String

isIgcPropertySimpleMapped

public boolean isIgcPropertySimpleMapped(String igcPropertyName)

Determines whether the provided IGC property name is simple (one-to-one) mapped (true) or not (false).

Parameters:

igcPropertyName - the IGC property name to check for a simple mapping

Returns:

boolean

isIgcPropertyComplexMapped

public boolean isIgcPropertyComplexMapped(String igcPropertyName)

Determines whether the provided IGC property name is complex mapped (true) or not (false).

Parameters:

igcPropertyName - the IGC property name to check for a complex mapping

Returns:

boolean

isOmrsPropertySimpleMapped

public boolean isOmrsPropertySimpleMapped(String omrsPropertyName)

Determines whether the provided OMRS property name is simple (one-to-one) mapped (true) or not (false).

Parameters:

omrsPropertyName - the OMRS property name to check for a simple mapping

Returns:

boolean

isOmrsPropertyComplexMapped

public boolean isOmrsPropertyComplexMapped(String omrsPropertyName)

Determines whether the provided OMRS property name is complex mapped (true) or not (false).

Parameters:

omrsPropertyName - the OMRS property name to check for a complex mapping

Returns:

boolean