org.odpi.openmetadata.accessservices.subjectarea.utilities

Class SubjectAreaUtils

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.utilities.SubjectAreaUtils

public class SubjectAreaUtils
extends Object

Subject Area OMAS utilities.

Constructor Summary

Constructors

Constructor and Description
SubjectAreaUtils()

Method Summary

Modifier and Type	Method and Description
static void	addStringToInstanceProperty(String key, String value, InstanceProperties instanceProperties)
static void	checkStatusNotDeleted(Status status, SubjectAreaErrorCode errorCode)
static Status	convertInstanceStatusToStatus(InstanceStatus instanceStatus)
static SequencingOrder	convertOMASToOMRSSequencingOrder(SequencingOrder sequencingOrder) convert omas sequencing order to omrs sequencing order
static SubjectAreaOMASAPIResponse	convertOMRSRelationshipsToOMASLines(OMRSAPIHelper omrsapiHelper, List<Relationship> omrsRelationships) Convert the OMRS Lines to their equivalent OMAS objects and return them in a Response of type lines.
static InstanceStatus	convertStatusToInstanceStatus(Status status)
static SystemAttributes	createSystemAttributes(InstanceHeader instanceHeader) create SystemAttributes instance from an insance header object
static InstanceType	createTemplateFromTypeDef(TypeDef typeDef)
static GlossarySummary	extractGlossarySummaryFromGlossary(Glossary glossary, Line line) Extract glossarySummary
static IconSummary	extractIconSummaryFromRelatedMedia(EntityDetail relatedMedia) extract iconSummary if this media is an icon
static SubjectAreaOMASAPIResponse	getGlossarySummaryForCategory(String restAPIName, String userId, OMRSAPIHelper omrsapiHelper, Line line) Get a Categories icon summaries from related media relationships by issuing a call to omrs using the related media guid - which is at one end of the relationship.
static SubjectAreaOMASAPIResponse	getGlossarySummaryForTerm(String restAPIName, String userId, OMRSAPIHelper omrsapiHelper, TermAnchorRelationship termAnchorRelationship, Term term) Get a Term's icon summaries from related media relationships by issuing a call to omrs using the related media guid - which is at one end of the relationship.
static SubjectAreaOMASAPIResponse	getIconSummarySet(String userId, OMRSAPIHelper oMRSAPIHelper, String guid) Set icon summaries from related media relationships by issuing a call to omrs using the related media guid - which is at one end of the relationship.
static CategorySummary	getParentCategorySummary(String restAPIName, String userId, OMRSAPIHelper omrsapiHelper, Set<Line> lines) Get a summary of the parent category.
static boolean	isCategory(String typeName)
static boolean	isGlossary(String typeName)
static boolean	isGovernanceActionClassification(String classificationName)
static boolean	isTerm(String typeName)
static boolean	isTopLevelGlossaryObject(String entityName)
static void	populateSystemAttributesForInstanceAuditHeader(SystemAttributes systemAttributes, InstanceAuditHeader instanceAuditHeader)
static void	setDatePropertyInInstanceProperties(InstanceProperties instanceProperties, Date date, String propertyName) set the Date value into the InstanceProperties
static void	setIntegerPropertyInInstanceProperties(InstanceProperties instanceProperties, Integer integerValue, String propertyName) Set the Integer value into the InstanceProperties.
static void	setStringPropertyInInstanceProperties(InstanceProperties instanceProperties, String stringValue, String propertyName) Set the String value into the InstanceProperties.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaUtils

public SubjectAreaUtils()

Method Detail

isTopLevelGlossaryObject

public static boolean isTopLevelGlossaryObject(String entityName)

isGovernanceActionClassification

public static boolean isGovernanceActionClassification(String classificationName)

createTemplateFromTypeDef

public static InstanceType createTemplateFromTypeDef(TypeDef typeDef)

isTerm

public static boolean isTerm(String typeName)

isCategory

public static boolean isCategory(String typeName)

isGlossary

public static boolean isGlossary(String typeName)

addStringToInstanceProperty

public static void addStringToInstanceProperty(String key,
                                               String value,
                                               InstanceProperties instanceProperties)

getIconSummarySet

public static SubjectAreaOMASAPIResponse getIconSummarySet(String userId,
                                                           OMRSAPIHelper oMRSAPIHelper,
                                                           String guid)

Set icon summaries from related media relationships by issuing a call to omrs using the related media guid - which is at one end of the relationship. Note that we should only return the icons that are effective - by checking the effective From and To dates against the current time

Parameters:

userId - userid under which to issue to the get of the related media

oMRSAPIHelper - interface to OMRS

guid - to get associated icons from

Returns:

response with Set of IconSummary objects or an Exception response.

getGlossarySummaryForTerm

public static SubjectAreaOMASAPIResponse getGlossarySummaryForTerm(String restAPIName,
                                                                   String userId,
                                                                   OMRSAPIHelper omrsapiHelper,
                                                                   TermAnchorRelationship termAnchorRelationship,
                                                                   Term term)

Get a Term's icon summaries from related media relationships by issuing a call to omrs using the related media guid - which is at one end of the relationship.

Parameters:

restAPIName - rest API Name

userId - userid under which to issue to the get of the related media

omrsapiHelper - helper to access OMRS

termAnchorRelationship - term glossary relationship

term - supplied term

Returns:

response object - glossary summary or an error

getGlossarySummaryForCategory

public static SubjectAreaOMASAPIResponse getGlossarySummaryForCategory(String restAPIName,
                                                                       String userId,
                                                                       OMRSAPIHelper omrsapiHelper,
                                                                       Line line)

Get a Categories icon summaries from related media relationships by issuing a call to omrs using the related media guid - which is at one end of the relationship.

Parameters:

restAPIName - rest API Name

userId - userid under which to issue to the get of the related media

omrsapiHelper - helper to access OMRS

line - glossary relationship

Returns:

Glossary summary for Category

getParentCategorySummary

public static CategorySummary getParentCategorySummary(String restAPIName,
                                                       String userId,
                                                       OMRSAPIHelper omrsapiHelper,
                                                       Set<Line> lines)
                                                throws UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException,
                                                       MetadataServerUncontactableException,
                                                       FunctionNotSupportedException

Get a summary of the parent category. The parent category is optional. We might validly have more than one parent category. this can occur if effectivity dates are being used The parent category is the first relationship we find of the right type that is effective.

Parameters:

restAPIName - rest API Name

userId - userid that the requests are issued under

omrsapiHelper - helper to access OMRS

lines - set of Lines that are of the right type.

Returns:

a parent category as a CategorySummary

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

UnrecognizedGUIDException - the supplied guid was not recognised

MetadataServerUncontactableException - Unable to contact the server

FunctionNotSupportedException - Function not supported

extractIconSummaryFromRelatedMedia

public static IconSummary extractIconSummaryFromRelatedMedia(EntityDetail relatedMedia)

extract iconSummary if this media is an icon

Parameters:

relatedMedia - related media

Returns:

iconSummaru or null

extractGlossarySummaryFromGlossary

public static GlossarySummary extractGlossarySummaryFromGlossary(Glossary glossary,
                                                                 Line line)

Extract glossarySummary

Parameters:

glossary - the glossary that is to be summarised

line - the line to the glossary, which feeds part of the node summary

Returns:

Glossary Summary or null

checkStatusNotDeleted

public static void checkStatusNotDeleted(Status status,
                                         SubjectAreaErrorCode errorCode)
                                  throws InvalidParameterException

Throws:

InvalidParameterException

convertInstanceStatusToStatus

public static Status convertInstanceStatusToStatus(InstanceStatus instanceStatus)

convertStatusToInstanceStatus

public static InstanceStatus convertStatusToInstanceStatus(Status status)

convertOMRSRelationshipsToOMASLines

public static SubjectAreaOMASAPIResponse convertOMRSRelationshipsToOMASLines(OMRSAPIHelper omrsapiHelper,
                                                                             List<Relationship> omrsRelationships)

Convert the OMRS Lines to their equivalent OMAS objects and return them in a Response of type lines.

Parameters:

omrsapiHelper - OMRS API helper - used to construct the mappers

omrsRelationships - - these are OMRS relationships

Returns:

omasLines - these are the Lines (the OMAS relationships) that are exposed in the OMAS API - note the list in the response can be empty

convertOMASToOMRSSequencingOrder

public static SequencingOrder convertOMASToOMRSSequencingOrder(SequencingOrder sequencingOrder)

convert omas sequencing order to omrs sequencing order

Parameters:

sequencingOrder - supplied omas sequencing order

Returns:

omrs sequencing order

createSystemAttributes

public static SystemAttributes createSystemAttributes(InstanceHeader instanceHeader)

create SystemAttributes instance from an insance header object

Parameters:

instanceHeader - omrs instance header

Returns:

SystemAttributes

populateSystemAttributesForInstanceAuditHeader

public static void populateSystemAttributesForInstanceAuditHeader(SystemAttributes systemAttributes,
                                                                  InstanceAuditHeader instanceAuditHeader)

setStringPropertyInInstanceProperties

public static void setStringPropertyInInstanceProperties(InstanceProperties instanceProperties,
                                                         String stringValue,
                                                         String propertyName)

Set the String value into the InstanceProperties.

Parameters:

instanceProperties - supplied instanceproperties

stringValue - string value

propertyName - property name.

setIntegerPropertyInInstanceProperties

public static void setIntegerPropertyInInstanceProperties(InstanceProperties instanceProperties,
                                                          Integer integerValue,
                                                          String propertyName)

Set the Integer value into the InstanceProperties.

Parameters:

instanceProperties - supplied instanceproperties

integerValue - integer value

propertyName - property name.

setDatePropertyInInstanceProperties

public static void setDatePropertyInInstanceProperties(InstanceProperties instanceProperties,
                                                       Date date,
                                                       String propertyName)

set the Date value into the InstanceProperties

Parameters:

instanceProperties - supplied instanceproperties

date - Datew value

propertyName - property name