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 List<Line>	convertOMRSLinesToOMASLines(Set<Line> omrsLines) Convert the OMRS Line objects to the equivalent OMAS objects and return them in a list.
static InstanceStatus	convertStatusToInstanceStatus(Status status)
static InstanceType	createTemplateFromTypeDef(TypeDef typeDef)
static GlossarySummary	extractGlossarySummaryFromGlossary(Glossary glossary) Extract glossarySummary
static IconSummary	extractIconSummaryFromRelatedMedia(RelatedMedia relatedMedia) extract iconSummary if this media is an icon
static GlossarySummary	getGlossarySummaryForCategory(String userId, SubjectAreaBeansToAccessOMRS subjectAreaBeansToAccessOMRS, 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 GlossarySummary	getGlossarySummaryForTerm(String userId, SubjectAreaBeansToAccessOMRS subjectAreaBeansToAccessOMRS, Line line) 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 Set<IconSummary>	getIconSummarySet(String userId, SubjectAreaBeansToAccessOMRS subjectAreaBeansToAccessOMRS, Set<Line> mediaReferenceRelationshipSet) 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 userId, SubjectAreaBeansToAccessOMRS subjectAreaBeansToAccessOMRS, Set<Line> lines) Get a summary of the parent category.
static boolean	isCategory(String typeName)
static boolean	isEffective(Date from, Date to) check check whether the current time lies between the from and to
static boolean	isEffective(Line line)
static boolean	isGlossary(String typeName)
static boolean	isGovernanceActionClassification(String classificationName)
static boolean	isTerm(String typeName)
static boolean	isTopLevelGlossaryObject(String entityName)

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 Set<IconSummary> getIconSummarySet(String userId,
                                                 SubjectAreaBeansToAccessOMRS subjectAreaBeansToAccessOMRS,
                                                 Set<Line> mediaReferenceRelationshipSet)
                                          throws UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException,
                                                 MetadataServerUncontactableException

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 shoukd 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

subjectAreaBeansToAccessOMRS - bean to access OMRS

mediaReferenceRelationshipSet - set of related media Relationships

Returns:

Set of IconSummary objects.

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 - not able to communicate with a Metadata respository service.

isEffective

public static boolean isEffective(Line line)

Parameters:

line - line to check

Returns:

boolean indicating whether this line is effective

isEffective

public static boolean isEffective(Date from,
                                  Date to)

check check whether the current time lies between the from and to

Parameters:

from - Date from which effective

to - Date to which effective

Returns:

whether effective.

getGlossarySummaryForTerm

public static GlossarySummary getGlossarySummaryForTerm(String userId,
                                                        SubjectAreaBeansToAccessOMRS subjectAreaBeansToAccessOMRS,
                                                        Line line)
                                                 throws UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        UnrecognizedGUIDException,
                                                        MetadataServerUncontactableException,
                                                        FunctionNotSupportedException

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:

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

subjectAreaBeansToAccessOMRS - bean to access OMRS

line - glossary relationship

Returns:

Set of IconSummary objects.

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 - not able to communicate with a Metadata respository service.

FunctionNotSupportedException - Function not supported

getGlossarySummaryForCategory

public static GlossarySummary getGlossarySummaryForCategory(String userId,
                                                            SubjectAreaBeansToAccessOMRS subjectAreaBeansToAccessOMRS,
                                                            Line line)
                                                     throws UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            UnrecognizedGUIDException,
                                                            MetadataServerUncontactableException,
                                                            FunctionNotSupportedException

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:

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

subjectAreaBeansToAccessOMRS - bean to access OMRS

line - glossary relationship

Returns:

Set of IconSummary objects.

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 - not able to communicate with a Metadata respository service.

FunctionNotSupportedException - Function not supported

getParentCategorySummary

public static CategorySummary getParentCategorySummary(String userId,
                                                       SubjectAreaBeansToAccessOMRS subjectAreaBeansToAccessOMRS,
                                                       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 rigght type that is effective.

Parameters:

userId - userid that the requests are issued under

subjectAreaBeansToAccessOMRS - service

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(RelatedMedia relatedMedia)

extract iconSummary if this media is an icon

Parameters:

relatedMedia - related media

Returns:

iconSummaru or null

extractGlossarySummaryFromGlossary

public static GlossarySummary extractGlossarySummaryFromGlossary(Glossary glossary)

Extract glossarySummary

Parameters:

glossary - to extract

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)

convertOMRSLinesToOMASLines

public static List<Line> convertOMRSLinesToOMASLines(Set<Line> omrsLines)

Convert the OMRS Line objects to the equivalent OMAS objects and return them in a list.

Parameters:

omrsLines - - these are Lines generated by hte generator from the omrs relationships

Returns:

omasLines - these are the Lines that exposed in the OMAS API

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